docs: fix addreleases packageType example + clarify --branch is a Feature Set for Products#28
Merged
Merged
Conversation
…-> CONTAINER) The batch example used "packageType": "OCI", which is not a valid PackageType enum value (MAVEN/NPM/NUGET/GEM/PYPI/CONTAINER) — addReleasesProgrammatic rejects it with "No value found for name 'OCI'". Container image deliverables use CONTAINER. Caught while wiring a real add-multi-release batch in CI. ReARM-Agentic-Session: cli-docs-oci-fix-1780248945 ReARM-Agent: 62df357e-a3a4-4df5-82d4-049e629d1c6b Co-Authored-By: Claude Opus 4 (1M context) <noreply@anthropic.com>
For a Component the --branch flag (addrelease, getversion, getlatestrelease) is the VCS branch name; for a Product it is the Feature Set name — a Product's Feature Set is the product-level equivalent of a Component branch (e.g. the default one is "Base Feature Set", not "main"). Standardizes the flag help and README wording so callers query Product releases with the right name. ReARM-Agentic-Session: cli-docs-oci-fix-1780248945 ReARM-Agent: 62df357e-a3a4-4df5-82d4-049e629d1c6b Co-Authored-By: Claude Opus 4 (1M context) <noreply@anthropic.com>
taleodor-claude
changed the title
…CS branch only) For addrelease and getversion, --branch is always the VCS branch name (it populates the Component branch); it never denotes a Product Feature Set. Revert those two flag-help strings to "Name of VCS Branch used". The Feature Set clarification is correct only for getlatestrelease (and its README section), which is left as-is. ReARM-Agentic-Session: cli-docs-oci-fix-1780248945 ReARM-Agent: 62df357e-a3a4-4df5-82d4-049e629d1c6b Co-Authored-By: Claude Opus 4 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two CLI documentation corrections surfaced while wiring a real
rearm-actions/add-multi-releasebatch in CI (card-shuffle-multi-release) against a live ReARM org.1.
packageTypeexample:OCI→CONTAINERThe
addreleasesbatch example (--helplong text and README §20) used"packageType": "OCI".OCIis not a validPackageTypeenum value (MAVEN/NPM/NUGET/GEM/PYPI/CONTAINER);addReleasesProgrammaticrejects it withNo value found for name 'OCI'. Container-image deliverables useCONTAINER.2.
getlatestrelease --branchis a Feature Set for ProductsFor a Component,
getlatestrelease --branchis the VCS branch name. For a Product it is the Feature Set name — e.g. the default one is"Base Feature Set", notmain;getlatestrelease --branch mainon a Product silently returns nothing. Clarified the flag help + the getlatestrelease README section. (A Product Feature Set is the product-level equivalent of a Component branch.)Note: this clarification applies only to
getlatestrelease. Foraddreleaseandgetversion,--branchis always the VCS branch (it populates the Component branch) and never a Feature Set — those flag helps are left as "Name of VCS Branch used".Test plan
go buildpassespackageType: CONTAINERbatch verified end-to-end via add-multi-release (3 component releases → single product auto-integrate)Base Feature Set;getlatestrelease --branch "Base Feature Set"returns the product release