diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-release-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-release-create.mdx index 41a444ecde..42f6bf46d9 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-release-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-release-create.mdx @@ -26,7 +26,11 @@ Flags: -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. - Format as {package}:{version}, {step}:{version} or {package-ref-name}:{packageOrStep}:{version} + 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". + Requires Octopus CLI 2.21.2 or later and Octopus Server 2025.4.10680 or later. You may specify this multiple times --git-resource stringArray Git reference for a specific Git resource. Format as {step}:{git-ref}, {step}:{git-resource-name}:{git-ref} @@ -51,6 +55,7 @@ Global Flags: 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 diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-run.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-run.mdx index 7f924db4bd..b74d6769b3 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-run.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-run.mdx @@ -33,7 +33,11 @@ Flags: --git-ref string Git Reference e.g. refs/heads/main. Only relevant for config-as-code projects where runbooks are stored in Git. --package-version string Default version to use for all packages. Only relevant for config-as-code projects where runbooks are stored in Git. --package stringArray Version specification for a specific package. - Format as {package}:{version}, {step}:{version} or {package-ref-name}:{packageOrStep}:{version} + 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". + Requires Octopus CLI 2.21.2 or later and Octopus Server 2025.4.10680 or later. You may specify this multiple times. Only relevant for config-as-code projects where runbooks are stored in Git. --git-resource stringArray Git reference for a specific Git resource. diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot-create.mdx index 27a3d51453..59a5669a16 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot-create.mdx @@ -24,7 +24,11 @@ Flags: Only relevant for config-as-code projects where runbooks are stored in Git. -n, --name string Override the snapshot name --package stringArray Version specification a specific packages. - Format as {package}:{version}, {step}:{version} or {package-ref-name}:{packageOrStep}:{version} + 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". + Requires Octopus CLI 2.21.2 or later and Octopus Server 2025.4.10680 or later. You may specify this multiple times --package-version string Default version to use for all packages. Only relevant for config-as-code projects where runbooks are stored in Git. -p, --project string Name or ID of the project where the runbook is