octopusdeploy/Deploy a Release in Octopus Deploy
GitHub Action to deploy a release in Octopus Deploy
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| project | The name of the project associated with this release. | yes | — |
| release_number | The number for the release to deploy. | yes | — |
| environments | A multi-line list of environments to deploy to. | yes | — |
| use_guided_failure | Whether to use guided failure mode if errors occur during the deployment. | — | false |
| variables | A multi-line list of prompted variable values. Format: name:value | — | — |
| deploy_at | Schedule the deployment to run at a specific time. Provide an ISO 8601 date-time string (e.g. 2026-04-01T09:00:00+10:00). Leave blank to deploy immediately. | — | — |
| deploy_at_expiry | Cancel the deployment if it has not started by this time. Provide an ISO 8601 date-time string. Leave blank for no expiry. | — | — |
| server | The instance URL hosting Octopus Deploy (i.e. "https://octopus.example.com/"). The instance URL is required, but you may also use the OCTOPUS_URL environment variable. | — | — |
| api_key | The API key used to access Octopus Deploy. An API key is required, but you may also use the OCTOPUS_API_KEY environment variable. It is strongly recommended that this value retrieved from a GitHub secret. | — | — |
| space | The name of a space within which this command will be executed. The space name is required, but you may also use the OCTOPUS_SPACE environment variable. | — | — |
Outputs
| name | description |
|---|---|
| server_tasks | JSON string for an array of objects having a `serverTaskId` and an `environmentName` |