Skip to content

Document --package escape syntax for Maven and delimiter-containing IDs#3145

Open
HuyPhanNguyen wants to merge 8 commits into
mainfrom
huy/2026/fd-135-cli-package-escape
Open

Document --package escape syntax for Maven and delimiter-containing IDs#3145
HuyPhanNguyen wants to merge 8 commits into
mainfrom
huy/2026/fd-135-cli-package-escape

Conversation

@HuyPhanNguyen
Copy link
Copy Markdown
Contributor

Documents the new backslash-escape syntax for the --package flag, added in cli#584 and supported by the server-side parser in OctopusDeploy#41734.

What changed

  • octopus release create, octopus runbook run, and octopus runbook snapshot create --package flag descriptions now mention the \:, \/, \= escape syntax and link the Maven coordinate example.
  • Added an Overriding Maven package versions from the CLI section to maven-feeds.md so users hitting the colon-in-package-ID problem land on a working example.

Version placeholders

Both <server-version> and <cli-version> are left as placeholders. Replace before merging once the actual release versions are known:

  • <server-version> → the Octopus Server release containing FD-135
  • <cli-version> → the Octopus CLI release containing cli#584

Linear: FD-135
Server PR: https://github.com/OctopusDeploy/OctopusDeploy/pull/41734
CLI PR: OctopusDeploy/cli#584
Related issue: OctopusDeploy/cli#547

…elimiter chars. Adds a Maven CLI override section to maven-feeds.md. Version placeholders left for fill-in during PR review.
@team-marketing-branch-protections
Copy link
Copy Markdown

Pull request environment is available at https://stoctodocspr3145.z22.web.core.windows.net.

You can view the ephemeral environment status in Octopus Deploy.

This environment will be automatically deprovisioned when the pull request is closed, or after 7 days of inactivity.

…ets to dashes, wrap bare URLs, expand tab-formatted table).
@team-marketing-branch-protections
Copy link
Copy Markdown

Pull request environment is available at https://stoctodocspr3145.z22.web.core.windows.net.

You can view the ephemeral environment status in Octopus Deploy.

This environment will be automatically deprovisioned when the pull request is closed, or after 7 days of inactivity.

@team-marketing-branch-protections
Copy link
Copy Markdown

Pull request environment is available at https://stoctodocspr3145.z22.web.core.windows.net.

You can view the ephemeral environment status in Octopus Deploy.

This environment will be automatically deprovisioned when the pull request is closed, or after 7 days of inactivity.

@HuyPhanNguyen HuyPhanNguyen marked this pull request as ready for review May 13, 2026 23:52
@HuyPhanNguyen HuyPhanNguyen requested a review from benPearce1 May 13, 2026 23:52
@team-marketing-branch-protections
Copy link
Copy Markdown

Pull request environment is available at https://stoctodocspr3145.z22.web.core.windows.net.

You can view the ephemeral environment status in Octopus Deploy.

This environment will be automatically deprovisioned when the pull request is closed, or after 7 days of inactivity.

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 2026.2.10450 or later.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could this fix have been backported to LTS for on-prem customers?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Backport to 2025.4

Copy link
Copy Markdown
Contributor

@benPearce1 benPearce1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR for updating CLI docs is generated by https://github.com/OctopusDeploy/cli/actions/workflows/generate-docs.yml, so these changes will be overwritten by the next run if they aren't reflected in the CLI commands.
Looks like the last run didn't generate a PR.

@HuyPhanNguyen HuyPhanNguyen requested a review from benPearce1 May 14, 2026 03:36
@team-marketing-branch-protections
Copy link
Copy Markdown

Pull request environment is available at https://stoctodocspr3145.z22.web.core.windows.net.

You can view the ephemeral environment status in Octopus Deploy.

This environment will be automatically deprovisioned when the pull request is closed, or after 7 days of inactivity.

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.

3 participants