{"id":21313986,"url":"https://github.com/octopusdeploy/deploy-release-action","last_synced_at":"2026-06-08T03:03:24.784Z","repository":{"id":63224748,"uuid":"565600770","full_name":"OctopusDeploy/deploy-release-action","owner":"OctopusDeploy","description":"| Public | :octocat: GitHub Action to Deploy a Release in Octopus Deploy","archived":false,"fork":false,"pushed_at":"2026-06-07T03:11:25.000Z","size":3949,"stargazers_count":5,"open_issues_count":19,"forks_count":7,"subscribers_count":4,"default_branch":"main","last_synced_at":"2026-06-07T05:07:20.046Z","etag":null,"topics":["deployment","github-actions","octopus-deploy","public"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/deploy-a-release-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":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-11-13T22:35:09.000Z","updated_at":"2026-05-28T04:23:55.000Z","dependencies_parsed_at":"2026-02-25T05:30:27.471Z","dependency_job_id":null,"html_url":"https://github.com/OctopusDeploy/deploy-release-action","commit_stats":{"total_commits":21,"total_committers":7,"mean_commits":3.0,"dds":0.6666666666666667,"last_synced_commit":"f738e6032178fb02033230cac2e31599d2c0cb33"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"purl":"pkg:github/OctopusDeploy/deploy-release-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctopusDeploy%2Fdeploy-release-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctopusDeploy%2Fdeploy-release-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctopusDeploy%2Fdeploy-release-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctopusDeploy%2Fdeploy-release-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OctopusDeploy","download_url":"https://codeload.github.com/OctopusDeploy/deploy-release-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctopusDeploy%2Fdeploy-release-action/sbom","scorecard":{"id":104082,"data":{"date":"2025-08-11","repo":{"name":"github.com/OctopusDeploy/deploy-release-action","commit":"5cadad97a686268240637596ab7f8465a80ce32d"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":6.8,"checks":[{"name":"Maintained","score":10,"reason":"25 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":10,"reason":"all changesets reviewed","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql-analysis.yml:29","Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql-analysis.yml:30","Warn: jobLevel 'statuses' permission set to 'write': .github/workflows/test.yml:44","Warn: jobLevel 'checks' permission set to 'write': .github/workflows/test.yml:45","Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1","Warn: no topLevel permission defined: .github/workflows/dist.yml:1","Warn: no topLevel permission defined: .github/workflows/no-build-required.yml:1","Warn: no topLevel permission defined: .github/workflows/release-please.yml:1","Warn: topLevel 'contents' permission set to 'write': .github/workflows/renovate-pull-request-automation.yml:12","Warn: no topLevel permission defined: .github/workflows/test.yml:1","Warn: no topLevel permission defined: .github/workflows/update-dependencies.yml:1"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Pinned-Dependencies","score":2,"reason":"dependency not pinned by hash detected -- score normalized to 2","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/OctopusDeploy/deploy-release-action/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/OctopusDeploy/deploy-release-action/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:55: update your workflow using https://app.stepsecurity.io/secureworkflow/OctopusDeploy/deploy-release-action/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:69: update your workflow using https://app.stepsecurity.io/secureworkflow/OctopusDeploy/deploy-release-action/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dist.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/OctopusDeploy/deploy-release-action/dist.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dist.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/OctopusDeploy/deploy-release-action/dist.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-please.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/OctopusDeploy/deploy-release-action/release-please.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-please.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/OctopusDeploy/deploy-release-action/release-please.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-please.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/OctopusDeploy/deploy-release-action/release-please.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/OctopusDeploy/deploy-release-action/test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/OctopusDeploy/deploy-release-action/test.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:69: update your workflow using https://app.stepsecurity.io/secureworkflow/OctopusDeploy/deploy-release-action/test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-dependencies.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/OctopusDeploy/deploy-release-action/update-dependencies.yml/main?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/test.yml:60","Info:   0 out of  10 GitHub-owned GitHubAction dependencies pinned","Info:   1 out of   4 third-party GitHubAction dependencies pinned","Info:   1 out of   2 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":9,"reason":"license file detected","details":["Info: project has a license file: LICENSE.md:0","Warn: project license file does not contain an FSF or OSI license."],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: github.com/OctopusDeploy/.github/SECURITY.md:1","Info: Found linked content: github.com/OctopusDeploy/.github/SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/OctopusDeploy/.github/SECURITY.md:1","Info: Found text in security policy: github.com/OctopusDeploy/.github/SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"SAST","score":10,"reason":"SAST tool is run on all commits","details":["Info: SAST configuration detected: CodeQL","Info: all commits (30) are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":5,"reason":"5 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-15T10:45:38.726Z","repository_id":63224748,"created_at":"2025-08-15T10:45:38.726Z","updated_at":"2025-08-15T10:45:38.726Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34046005,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-08T02:00:07.615Z","response_time":111,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["deployment","github-actions","octopus-deploy","public"],"created_at":"2024-11-21T18:09:38.269Z","updated_at":"2026-06-08T03:03:24.778Z","avatar_url":"https://github.com/OctopusDeploy.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# deploy-release-action\n\n\u003cimg alt= \"\" src=\"https://github.com/OctopusDeploy/deploy-release-action/raw/main/assets/github-actions-octopus.png\" /\u003e\n\nThis is a GitHub Action to deploy a release in [Octopus Deploy](https://octopus.com/).\n\n\u003e [!IMPORTANT]\n\u003e As of **v3** of this action, Octopus Server version `2022.3.5512` or newer is required.\n\n## Deployments in Octopus Deploy\n\nA release is a snapshot of the deployment process and the associated assets (packages, scripts, variables) as they existed when the release was created. The release is given a version number, and you can deploy that release as many times as you need to, even if parts of the deployment process have changed since the release was created (those changes will be included in future releases but not in this version).\n\nWhen you deploy the release, you are executing the deployment process with all the associated details, as they existed when the release was created.\n\nMore information about releases and deployments in Octopus Deploy:\n\n- [Releases](https://octopus.com/docs/releases)\n- [Deployments](https://octopus.com/docs/deployments)\n\n## Examples\n\nIncorporate the following actions in your workflow to deploy a release in Octopus Deploy using an API key, a target instance (i.e. `server`), and a project:\n\n```yml\nenv:\n\nsteps:\n  # ...\n  - name: Deploy a release in Octopus Deploy 🐙\n    id: deploy_a_release_in_octopus_deploy\n    uses: OctopusDeploy/deploy-release-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: 'MyProject'\n      release_number: '1.0.0'\n      environments: |\n        Dev\n        Test\n      variables: |\n        Foo: Bar\n        Fizz: Buzz\n```\n\nDeploy a release created from the [Create a Release](https://github.com/marketplace/actions/create-release-in-octopus-deploy) action\n\n```yml\nenv:\n  OCTOPUS_API_KEY: ${{ secrets.API_KEY  }}\n  OCTOPUS_URL: ${{ secrets.OCTOPUS_URL }}\n  OCTOPUS_SPACE: 'Outer Space'\nsteps:\n  # ...\n  - name: Create a release in Octopus Deploy 🐙\n    id: create_a_release_in_octopus_deploy\n    uses: OctopusDeploy/create-release-action@v4\n    with:\n      project: 'MyProject'\n  - name: Deploy a release in Octopus Deploy 🐙\n    id: deploy_a_release_in_octopus_deploy\n    uses: OctopusDeploy/deploy-release-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: 'MyProject'\n      release_number: ${{ steps.create_a_release_in_octopus_deploy.outputs.release_number }}\n      environments: |\n        Dev\n        Test\n      variables: |\n        Foo: Bar\n        Fizz: Buzz  \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 release.                                                                                                                                          |\n| `release_number`     | **Required.** The release number to deploy.                                                                                                                                                                  |\n| `environments`       | **Required.** The list of environment names to deploy to.                                                                                                                                                    |\n| `use_guided_failure` | Whether to use guided failure mode if errors occur during the deployment.                                                                                                                                    |\n| `variables`          | A multi-line list of prompted variable values. Format: name:value.                                                                                                                                           |\n| `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.                                      |\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\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`) 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](.github/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%2Fdeploy-release-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foctopusdeploy%2Fdeploy-release-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctopusdeploy%2Fdeploy-release-action/lists"}