| project | The name or ID of the project associated with this release. | yes | — |
| 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 that this value retrieved 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. | — | — |
| release_number | The number for the new release. If omitted, Octopus Deploy will generate a release number. | — | — |
| space | The name or ID of a space within which this command will be executed. | — | — |
| package_version | The 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. | — | — |
| channel | The name or ID of the channel to use for the new release. If omitted, the best channel will be selected. | — | — |
| 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 |
| proxy | The URL of a proxy to use (i.e. https://proxy.example.com). You may also use the OCTOPUS_PROXY environment variable. | — | — |
| proxy_username | The username used to connect to a proxy. You may also use the OCTOPUS_PROXY_USERNAME environment variable. It is strongly recommended to retrieve this value from a GitHub secret. | — | — |
| proxy_password | The password used to connect to a proxy. You may also use the OCTOPUS_PROXY_PASSWORD environment variable. 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. | — | — |
| release_notes | The release notes associated with the new release (Markdown is supported). | — | — |
| release_notes_file | Path to a file that contains release notes for the new release. Supports Markdown files. | — | — |