xentaurs/Create Release in Octopus Deploy
GitHub Action to create a release in Octopus Deploy
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| api_key | The API key used to access Octopus Deploy. You must provide an API key or username and password. If the guest account is enabled, a key of API-GUEST may be used. It is strongly recommended that this value retrieved from a GitHub secret. | — | — |
| cancel_on_timeout | Cancel the deployment if the deployment_timeout is exceeded (the default timeout is 10 minutes). | — | false |
| channel | The name or ID of the channel to use for the new release. If omitted, the best channel will be selected. | — | — |
| config_file | The path to a configuration file of default values with one "key=value" per line. | — | — |
| debug | Enable debug logging. | — | false |
| default_package_version | Use the default version number of all packages for this release. | — | false |
| deploy_at | The time at which deployment should start (scheduled deployment), specified as any valid DateTimeOffset format, and assuming the time zone is the current local time zone. | — | — |
| deploy_to | The name or ID of the environment to automatically deploy to (i.e. "Production" or "Environments-1"); specify this argument multiple times to deploy to multiple environments. | — | — |
| deployment_check_sleep_cycle | The duration between deployment status checks (format: HH:MM:SS). | — | 00:00:10 |
| deployment_timeout | The duration to wait for the deployment to finish (format: HH:MM:SS). Note: This will not stop the deployment; the input value, wait_for_deployment is required. | — | 00:00:10 |
| exclude_machines | A comma-separated list of machine names to exclude in the deployed environment. If empty, all machines in the environment will be considered. | — | — |
| force | If a project is configured to skip packages with already-installed versions, override this setting to force re-deployment. | — | false |
| force_package_download | Force download of installed packages. | — | false |
| guided_failure | Use Guided Failure mode. | — | false |
| ignore_channel_rules | Create the release ignoring any version rules specified by the channel. | — | false |
| ignore_existing | Ignore existing releases if present in Octopus Deploy with the matching version number. | — | false |
| ignore_ssl_errors | Ignore certificate errors when communicating with Octopus Deploy. Warning: enabling this option creates a security vulnerability. | — | false |
| log_level | The log level; valid options are "verbose", "debug", "information", "warning", "error", and "fatal". | — | debug |
| no_deploy_after | Time at which scheduled deployment should expire, specified as any valid DateTimeOffset format, and assuming the time zone is the current local time zone. | — | — |
| no_raw_log | Print the raw log of failed tasks. | — | false |
| package | The version number to use for a package in the release (format: StepName:Version or PackageID:Version or StepName:PackageName:Version). | — | — |
| package_prerelease | Pre-release for latest version of all packages to use for this release. | — | — |
| package_version | The version number of all packages to use for this release. | — | — |
| packages_folder | The folder designated for containing packages. | — | — |
| password | The password to used to authenticate with Octopus Deploy. It is strongly recommended to retrieve this value from a GitHub secret. | — | — |
| progress | Show progress of the deployment. | — | false |
| project | The name or ID of the project associated with this release. | — | — |
| proxy | The URL of a proxy to use (i.e. https://proxy.example.com). | — | — |
| proxy_password | The password used to connect to a proxy. It is strongly recommended to retrieve this value from a GitHub secret. If proxy_username and proxy_password are omitted and proxy URL is specified, the default credentials are used. | — | — |
| proxy_username | The username used to connect to a proxy. It is strongly recommended to retrieve this value from a GitHub secret. | — | — |
| raw_log_file | Redirect the raw log of failed tasks to a file. | — | — |
| release_notes | The release notes associated with the new release (Markdown is supported). | — | — |
| release_notes_file | Path to a file that contains release notes for the new release. Supports Markdown files. | — | — |
| release_number | The number for the new release. | — | — |
| server | The base URL hosting Octopus Deploy (i.e. "https://octopus.example.com/"). It is recommended to retrieve this value from an environment variable. | — | — |
| skip | Skip a step by name. | — | — |
| space | The name or ID of a space within which this command will be executed. If omitted, the default space will be used. | — | — |
| specific_machines | A comma-separated list of machine names to target in the deployed environment. If not specified all machines in the environment will be considered. | — | — |
| tenant | Create a deployment for the tenant with this name or ID; specify this argument multiple times to add multiple tenants or use a wildcard ("*") to deploy to all tenants who are ready for this release (according to lifecycle). | — | — |
| tenant_tag | Create a deployment for tenants matching this tag; specify this argument multiple times to build a query/filter with multiple tags. | — | — |
| timeout | A timeout value in seconds for network operations. | — | 600 |
| username | The username used to authenticate with Octopus Deploy. You must provide an apiKey or username and password. It is strongly recommended to retrieve this value from a GitHub secret. | — | — |
| variable | Values for any prompted variables in the format, Label:Value. For JSON values, embedded quotation marks should be escaped with a backslash. | — | — |
| wait_for_deployment | Wait for deployment to finish. | — | false |
| what_if | Perform a dry run; do not create or deploy a release. | — | false |
Outputs
no outputs