jquepi/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
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| project | The name or ID of the project associated with this runbook. | yes | — |
| runbook | The name or ID of the runbook. If the name is supplied, the project input value must also be specified. | yes | — |
| environments | A comma-delimited list of environments in Octopus Deploy in which to run (i.e. "Dev,Test,Prod"). | yes | — |
| variables | A list of prompted variables in the format, Label:Value. For JSON values, embedded quotation marks should be escaped with a backslash. Supports multiple prompted variables; one per line. | — | — |
| 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. If the guest account is enabled, a key of API-GUEST may be used. It is strongly recommended to retrieve this value from a GitHub secret. | — | — |
| 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. | — | — |
| server | The base URL hosting Octopus Deploy (i.e. "https://octopus.example.com/"). The Server URL is required, but you may also use the OCTOPUS_HOST environment variable. | — | — |
| space | The name or ID of a space within which this command will be executed. If omitted, the default space will be used. | — | — |
Outputs
no outputs