{"id":21313972,"url":"https://github.com/octopusdeploy/run-runbook-action","last_synced_at":"2026-06-08T03:04:12.687Z","repository":{"id":36980285,"uuid":"352990410","full_name":"OctopusDeploy/run-runbook-action","owner":"OctopusDeploy","description":"| Public |  :octocat: GitHub Action to Run a Runbook in Octopus Deploy","archived":false,"fork":false,"pushed_at":"2024-05-23T02:40:12.000Z","size":2439,"stargazers_count":17,"open_issues_count":10,"forks_count":8,"subscribers_count":17,"default_branch":"main","last_synced_at":"2024-05-23T03:36:18.339Z","etag":null,"topics":["cli","deployment","github-actions","octopus-deploy","public"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/run-runbook-in-octopus-deploy","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OctopusDeploy.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-30T12:19:09.000Z","updated_at":"2024-05-30T05:01:04.136Z","dependencies_parsed_at":"2024-02-01T03:42:37.589Z","dependency_job_id":"334d16f8-90fb-4c84-b8d5-eab81cc1e9e8","html_url":"https://github.com/OctopusDeploy/run-runbook-action","commit_stats":{"total_commits":155,"total_committers":15,"mean_commits":"10.333333333333334","dds":0.5161290322580645,"last_synced_commit":"c35c25d435fae32d3b77484ca49352e815adf8d3"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctopusDeploy%2Frun-runbook-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctopusDeploy%2Frun-runbook-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctopusDeploy%2Frun-runbook-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctopusDeploy%2Frun-runbook-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OctopusDeploy","download_url":"https://codeload.github.com/OctopusDeploy/run-runbook-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225778856,"owners_count":17522710,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","deployment","github-actions","octopus-deploy","public"],"created_at":"2024-11-21T18:09:34.960Z","updated_at":"2026-06-08T03:04:12.682Z","avatar_url":"https://github.com/OctopusDeploy.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# run-runbook-action\n\n\u003cimg alt= \"\" src=\"https://github.com/OctopusDeploy/run-runbook-action/raw/main/assets/github-actions-octopus.png\" /\u003e\n\nThis is a GitHub Action that will run a [runbook](https://octopus.com/docs/runbooks) in Octopus Deploy.\n\n\u003e [!IMPORTANT]\n\u003e As of **v3** of this action, Octopus Server version `2022.3.5512` or newer is required.\n\n## Migration Guide(s)\n\nPlease refer to the [migration guide](migration-guide.md) if moving between major versions of this action.\n\n## Examples\n\nIncorporate the following actions in your workflow to push a package to Octopus Deploy using an API key, a target instance (i.e. `server`), and a project:\n\n```yml\nsteps:\n  - name: Run a runbook in Octopus Deploy 🐙\n    id: run_a_runbook_in_octopus_deploy\n    uses: OctopusDeploy/run-runbook-action@v4\n    env:\n      OCTOPUS_API_KEY: ${{ secrets.API_KEY  }}\n      OCTOPUS_URL: ${{ secrets.SERVER }}\n      OCTOPUS_SPACE: 'Outer Space'\n    with:\n      project: 'Test Project'\n      runbook: 'Test Runbook'\n      environments: |\n        'Dev'\n        'Test'\n```\n\n## ✍️ Environment Variables\n\n| Name              | Description                                                                                                                                          |\n| :---------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `OCTOPUS_URL`     | The base URL hosting Octopus Deploy (i.e. `https://octopus.example.com`). It is strongly recommended that this value retrieved from a GitHub secret. |\n| `OCTOPUS_API_KEY` | The API key used to access Octopus Deploy. It is strongly recommended that this value retrieved from a GitHub secret.                                |\n| `OCTOPUS_SPACE`   | The Name of a space within which this command will be executed.                                                                                      |\n\n## 📥 Inputs\n\n| Name           | Description                                                                                                                                                                                                                |\n| :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `project`      | **Required.** The name of the project associated with this runbook.                                                                                                                                                        |\n| `runbook`      | **Required.** The name of the runbook.                                                                                                                                                                                     |\n| `environments` | **Required.** A list of environments in Octopus Deploy in which to run (i.e. Dev, Test, Prod). Each environment should be added on a new line.                                                                             |\n| `variables`    | A multi-line list of prompted variable values. Format: name:value.                                                                                                                                                         |\n| `server`       | The instance URL hosting Octopus Deploy (i.e. \"\u003chttps://octopus.example.com/\u003e\"). The instance URL is required, but you may also use the OCTOPUS_URL environment variable.                                                  |\n| `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.               |\n| `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.                                                                   |\n| `git_ref`      | Git branch reference to the specific resources of a version controlled Octopus Project. This is required for version controlled projects. E.g. ${{ github.ref }} to use the branch or tag ref that triggered the workflow. |\n\n## 📤 Outputs\n\n| Name           | Description                                                                                                                                                                                                                                                                                           |\n| :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `server_tasks` | JSON array of objects containing the Octopus Deploy server tasks Ids (`serverTaskId`) and environment name (`environmentName`), and tenant name (`tenantName`) if the run was for a tenant, for the executions tasks that were queued. Use the `await-task-action`to wait for any/all of these tasks. |\n\n## 🤝 Contributions\n\nContributions are welcome! :heart: Please read our [Contributing Guide](CONTRIBUTING.md) for information about how to get involved in this project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctopusdeploy%2Frun-runbook-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foctopusdeploy%2Frun-runbook-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctopusdeploy%2Frun-runbook-action/lists"}