From c09ef0e68a496bd81b989668701a9c3b334babbb Mon Sep 17 00:00:00 2001 From: Taleodor Claude Date: Sun, 31 May 2026 17:36:34 +0000 Subject: [PATCH 1/3] docs(addreleases): correct softwareMetadata.packageType example (OCI -> CONTAINER) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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) --- README.md | 2 +- cmd/addReleases.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 88027a2..1d7e71f 100644 --- a/README.md +++ b/README.md @@ -1184,7 +1184,7 @@ Sample `batch.json` (two releases, each carrying a CycloneDX SBOM): { "displayIdentifier": "registry.acme.com/widget:1.4.0", "type": "CONTAINER", - "softwareMetadata": { "packageType": "OCI", "digests": ["sha256:abc123"] }, + "softwareMetadata": { "packageType": "CONTAINER", "digests": ["sha256:abc123"] }, "artifacts": [ { "displayIdentifier": "deliverable-sbom", "type": "BOM", "bomFormat": "CYCLONEDX", "storedIn": "REARM", "inventoryTypes": ["SOFTWARE"], "filePath": "./sboms/widget-image.cdx.json" } ] diff --git a/cmd/addReleases.go b/cmd/addReleases.go index 8ee0ce5..9714805 100644 --- a/cmd/addReleases.go +++ b/cmd/addReleases.go @@ -68,7 +68,7 @@ Example batch.json (one element shown): { "displayIdentifier": "registry.acme.com/widget:1.4.0", "type": "CONTAINER", - "softwareMetadata": { "packageType": "OCI", "digests": ["sha256:abc123"] }, + "softwareMetadata": { "packageType": "CONTAINER", "digests": ["sha256:abc123"] }, "artifacts": [ { "displayIdentifier": "deliverable-sbom", "type": "BOM", "bomFormat": "CYCLONEDX", "filePath": "./sboms/widget-image.cdx.json" } ] From f1c0073f100db2726fd6e92cb7052e3f90095b7b Mon Sep 17 00:00:00 2001 From: Taleodor Claude Date: Sun, 31 May 2026 17:48:29 +0000 Subject: [PATCH 2/3] docs: clarify --branch is a Feature Set for Products MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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) --- README.md | 2 +- cmd/addRelease.go | 2 +- cmd/getLatestRelease.go | 2 +- cmd/root.go | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1d7e71f..cd561da 100644 --- a/README.md +++ b/README.md @@ -438,7 +438,7 @@ Flags stand for: - **vcsuri** - flag to denote uri of vcs repository for the component (used if component API key is not used and explicit component UUID is not provided). - **--repo-path** - Repository path for monorepo components (optional, used in combination with vcsuri for component resolution). - **--product** - flag to denote UUID of Product which packages Component or Product for which we inquiry about its version via --component flag, UUID must be obtained from [ReARM](https://relizahub.com) (optional). -- **--branch** - flag to denote required branch of chosen Component or Product (required). +- **--branch** - name of the chosen Component's branch — or, for a Product, its Feature Set (a Product's Feature Set is the product-level equivalent of a Component branch) (required). - **--lifecycle** - Lifecycle of the last known release to return, default is 'ASSEMBLED' (optional, can be - [CANCELLED, REJECTED, PENDING, DRAFT, ASSEMBLED, GENERAL_AVAILABILITY, END_OF_SUPPORT]). Will include all higher level lifecycles, i.e. if set to CANCELLED, will return releases in any lifecycle. - **--operator** - Match operator for a list of approvals, 'AND' or 'OR', default is 'AND' (optional). - **--approvalentry** - Approval entry names or IDs (optional, multiple allowed). diff --git a/cmd/addRelease.go b/cmd/addRelease.go index b852363..37f68d0 100644 --- a/cmd/addRelease.go +++ b/cmd/addRelease.go @@ -522,7 +522,7 @@ var addreleaseCmd = &cobra.Command{ } func init() { - addreleaseCmd.PersistentFlags().StringVarP(&branch, "branch", "b", "", "Name of VCS Branch used") + addreleaseCmd.PersistentFlags().StringVarP(&branch, "branch", "b", "", "Name of the Component branch — or, for a Product, its Feature Set (the product-level equivalent of a branch)") addreleaseCmd.PersistentFlags().StringVarP(&version, "version", "v", "", "Release version") addreleaseCmd.MarkPersistentFlagRequired("version") addreleaseCmd.MarkPersistentFlagRequired("branch") diff --git a/cmd/getLatestRelease.go b/cmd/getLatestRelease.go index fb081aa..7438eb4 100644 --- a/cmd/getLatestRelease.go +++ b/cmd/getLatestRelease.go @@ -156,7 +156,7 @@ func getLatestReleaseFunc(debug string, rearmUri string, component string, produ func init() { getLatestReleaseCmd.PersistentFlags().StringVar(&component, "component", "", "Component or Product UUID from ReARM for which to obtain latest release") getLatestReleaseCmd.PersistentFlags().StringVar(&product, "product", "", "Product UUID from ReARM to condition component release to this product (optional)") - getLatestReleaseCmd.PersistentFlags().StringVarP(&branch, "branch", "b", "", "Name of branch or Feature Set from ReARM for which latest release is requested (required)") + getLatestReleaseCmd.PersistentFlags().StringVarP(&branch, "branch", "b", "", "Name of the Component branch — or, for a Product, its Feature Set (the product-level equivalent of a branch) — for which the latest release is requested (required)") getLatestReleaseCmd.MarkPersistentFlagRequired("branch") getLatestReleaseCmd.PersistentFlags().StringVar(&vcsUri, "vcsuri", "", "URI of VCS repository (optional)") getLatestReleaseCmd.PersistentFlags().StringVar(&repoPath, "repo-path", "", "Repository path for monorepo components (optional)") diff --git a/cmd/root.go b/cmd/root.go index 00750c0..ae37d2e 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -1045,7 +1045,7 @@ func init() { createComponentCmd.PersistentFlags().StringVar(&perspective, "perspective", "", "(Optional) UUID of perspective to atomically assign the new component to. Requires a FREEFORM API key with WRITE permission on the perspective (or a broader scope that covers it).") // flags for get version command - getVersionCmd.PersistentFlags().StringVarP(&branch, "branch", "b", "", "Name of VCS Branch used") + getVersionCmd.PersistentFlags().StringVarP(&branch, "branch", "b", "", "Name of the Component branch — or, for a Product, its Feature Set (the product-level equivalent of a branch)") getVersionCmd.MarkPersistentFlagRequired("branch") getVersionCmd.PersistentFlags().StringVar(&component, "component", "", "Component UUID for this release if org-wide key is used") getVersionCmd.PersistentFlags().StringVar(&action, "action", "", "Bump action name: bump | bumppatch | bumpminor | bumpmajor | bumpdate") From c534d18873ef29ec301f71715e2cf9668b5ac589 Mon Sep 17 00:00:00 2001 From: Taleodor Claude Date: Sun, 31 May 2026 18:35:02 +0000 Subject: [PATCH 3/3] docs: revert Feature Set wording on addrelease/getversion --branch (VCS 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) --- cmd/addRelease.go | 2 +- cmd/root.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cmd/addRelease.go b/cmd/addRelease.go index 37f68d0..b852363 100644 --- a/cmd/addRelease.go +++ b/cmd/addRelease.go @@ -522,7 +522,7 @@ var addreleaseCmd = &cobra.Command{ } func init() { - addreleaseCmd.PersistentFlags().StringVarP(&branch, "branch", "b", "", "Name of the Component branch — or, for a Product, its Feature Set (the product-level equivalent of a branch)") + addreleaseCmd.PersistentFlags().StringVarP(&branch, "branch", "b", "", "Name of VCS Branch used") addreleaseCmd.PersistentFlags().StringVarP(&version, "version", "v", "", "Release version") addreleaseCmd.MarkPersistentFlagRequired("version") addreleaseCmd.MarkPersistentFlagRequired("branch") diff --git a/cmd/root.go b/cmd/root.go index ae37d2e..00750c0 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -1045,7 +1045,7 @@ func init() { createComponentCmd.PersistentFlags().StringVar(&perspective, "perspective", "", "(Optional) UUID of perspective to atomically assign the new component to. Requires a FREEFORM API key with WRITE permission on the perspective (or a broader scope that covers it).") // flags for get version command - getVersionCmd.PersistentFlags().StringVarP(&branch, "branch", "b", "", "Name of the Component branch — or, for a Product, its Feature Set (the product-level equivalent of a branch)") + getVersionCmd.PersistentFlags().StringVarP(&branch, "branch", "b", "", "Name of VCS Branch used") getVersionCmd.MarkPersistentFlagRequired("branch") getVersionCmd.PersistentFlags().StringVar(&component, "component", "", "Component UUID for this release if org-wide key is used") getVersionCmd.PersistentFlags().StringVar(&action, "action", "", "Bump action name: bump | bumppatch | bumpminor | bumpmajor | bumpdate")