octopusdeploy/Create Release in Octopus Deploy
GitHub Action to create a release in Octopus Deploy
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jun 29, 2026
- License
- None
Pinned Snippet
uses: octopusdeploy/create-release-action@41621dd2b319b1dbf1f537913f2d18992eff6fd5 # v4.1.4tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| project | The name of the project associated with this release. | yes | — |
| release_number | The number for the new release. If omitted, Octopus Deploy will generate a release number. | — | — |
| channel | The name of the channel to use for the new release. If omitted, the best channel will be selected based on channel version rules. | — | — |
| package_version | The default version number of all packages to use for this release. | — | — |
| packages | A multi-line list of version numbers to use for a package in the release. Format: StepName:Version or PackageID:Version or StepName:PackageName:Version. StepName, PackageID, and PackageName can be replaced with an asterisk ("*"). An asterisk will be assumed for StepName, PackageID, or PackageName if they are omitted. | — | — |
| git_resources | A multi-line list of Git references to use for Git resources on specific steps (e.g. the source repository of an "Update Argo CD Application Manifests" step). Format: StepName:GitRef or StepName:GitResourceName:GitRef (for example "Update Argo CD Application Manifests:refs/heads/my-feature"). Resolved at release-creation time. | — | — |
| git_ref | Git branch reference to the specific resources of a version controlled Octopus Project. This is required for version controlled projects. | — | — |
| git_commit | Git commit pointing to the specific resources of a version controlled Octopus Project. If empty, it will use the HEAD from the corresponding gitRef parameter. | — | — |
| ignore_existing | Ignore existing releases if present in Octopus Deploy with the matching version number. | — | false |
| release_notes | The release notes text associated with the new release (Markdown is supported). | — | — |
| release_notes_file | A file containing the release notes associated with the new release (Markdown is supported). Use either `release_notes` or this input, supplying both is not supported. | — | — |
| 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. | — | — |
| custom_fields | A multi-line string of custom fields for the release. Format: customFieldName:customFieldValue \n customFieldName2:customFieldValue2. | — | — |
Outputs
| name | description |
|---|---|
| release_number | The release number assigned to the Release in Octopus Deploy |