Skip to content

Bring Platform CLI docs to v0.38.0 parity - #1745

Draft
llewellyn-sl wants to merge 1 commit into
llewellyn-cli-docs-automationfrom
llewellyn-cli-docs-v0.38.0-parity
Draft

Bring Platform CLI docs to v0.38.0 parity#1745
llewellyn-sl wants to merge 1 commit into
llewellyn-cli-docs-automationfrom
llewellyn-cli-docs-v0.38.0-parity

Conversation

@llewellyn-sl

Copy link
Copy Markdown
Contributor

What changed

  • regenerate the Platform CLI reference from the verified tower-cli v0.38.0 release JAR
  • capture 181 visible commands across 20 top-level commands, including resolved nested commands and provider/mixin options
  • add the missing generate-completion reference page, sidebar entry, command index entry, and usage overlay
  • add idempotent v0.38.0 notices and the small processed-release marker
  • document the v0.38.0 private Studio allow-list behavior for studios add, add-as-new, and start

Source and verification

  • Release: https://github.com/seqeralabs/tower-cli/releases/tag/v0.38.0
  • Release type: published stable release
  • tw-jar.jar SHA-256: 68309ff47dc7be69323765db1805099a235ad9448a58eac15dae28f486218e56
  • Metadata source: resolved picocli runtime command model from the released fat JAR
  • Raw metadata: not committed; workflow runs retain it as a short-lived artifact

The release-to-release comparison with v0.37.0 found three option additions:

  • tw studios add --allow-user
  • tw studios add-as-new --allow-user
  • tw studios start --allow-user

Why

The existing CLI reference was generated from an older shallow metadata model. It omitted deep compute-provider and workspace settings options and did not include every top-level command. This establishes the first docs-owned stable-release baseline.

Stack and merge order

This PR is stacked on #1744, which adds the extractor, generator, workflows, tests, review skill, and preview support used to produce these changes. Review and merge #1744 first; this PR should then contain only the generated/editorial parity delta against master.

Validation

  • live release download and checksum verification
  • Java 21 extractor compilation against the released JAR
  • comparison with v0.37.0
  • six Python tests
  • no orphaned overlays
  • Platform CLI + Platform Cloud + changelog Docusaurus production build
  • repository pre-commit hooks

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.

1 participant