octopusdeploy/Run Runbook in Octopus Deploy
GitHub Action to run a runbook 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 runbook. | yes | — |
| runbook | The name of the runbook. | yes | — |
| environments | A multi-line list of environments to deploy to. | yes | — |
| tenants | A multi-line list of tenant names to deploy to. | — | — |
| tenant_tags | A multi-line list of tenant tags (canonical names) to use to locate tenants to deploy to. | — | — |
| 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 | — | — |
| 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. | — | — |
| git_ref | The Git Reference on which to run the Runbook. If not populate the action assumes you are running a DB Runbook. In most cases when running a Git Runbook this will be your default branch refs/heads/main | — | — |
Outputs
| name | description |
|---|---|
| server_tasks | JSON string for an array of objects having a `serverTaskId` and an `environmentName`, and optionally a `tenantName` |