Skip to content

fix: updated escape syntax docs on release create#602

Open
benPearce1 wants to merge 2 commits into
mainfrom
bp/update-package-docs
Open

fix: updated escape syntax docs on release create#602
benPearce1 wants to merge 2 commits into
mainfrom
bp/update-package-docs

Conversation

@benPearce1
Copy link
Copy Markdown
Contributor

After:

❯ octopus release create --help
Create a release in Octopus Deploy

USAGE
 octopus release create [flags]

FLAGS
 -p, --project string              Name or ID of the project to create the release in
 -c, --channel string              Name or ID of the channel to use
 -r, --git-ref string              Git Reference e.g. refs/heads/main. Only relevant for config-as-code projects
     --git-commit string           Git Commit Hash; Specify this in addition to Git Reference if you want to reference a commit other than the latest for that branch/tag.
     --package-version string      Default version to use for all Packages
     --release-notes string        Release notes to attach
     --release-notes-file string   Release notes to attach (from file)
 -v, --version string              Override the Release Version
 -x, --ignore-existing             If a release with the same version exists, do nothing instead of failing.
     --ignore-channel-rules        Allow creation of a release where channel rules would otherwise prevent it.
     --package stringArray         Version specification for a specific package. You may specify this multiple times.
                                   Format as {package}:{version}, {step}:{version} or {package-ref-name}:{packageOrStep}:{version}
                                   If the package ID or step name contains a colon, slash, or equals sign (such as Maven coordinates like com.example:my-artifact), escape that character with a backslash:
                                        --package "com.example\:my-artifact:1.0"
                                   This escape syntax requires Octopus CLI 2.21.2 or later and Octopus Server 2026.2.10450 or later.
     --git-resource stringArray    Git reference for a specific Git resource.
                                   Format as {step}:{git-ref}, {step}:{git-resource-name}:{git-ref}
                                   You may specify this multiple times
     --custom-field stringArray    Custom field value to set on the release.
                                   Format as {name}:{value}. You may specify multiple times

INHERITED FLAGS
 -h, --help                   Show help for a command
     --no-prompt              Disable prompting in interactive mode
 -f, --output-format string   Specify the output format for a command ("json", "table", or "basic") (default "table")
 -s, --space string           Specify the space for operations

EXAMPLE
 octopus release create --project MyProject --channel Beta --version 1.2.3
 octopus release create -p MyProject -c Beta -v 1.2.3
 octopus release create -p MyProject -c default --package "utils:1.2.3" --package "utils:InstallOnly:5.6.7"
 octopus release create -p MyProject --package "com.example\:my-artifact:1.0"
 octopus release create -p MyProject -c Beta --no-prompt

@benPearce1 benPearce1 requested a review from HuyPhanNguyen May 14, 2026 01:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants