diff --git a/README.md b/README.md index 88027a2..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). @@ -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" } ] 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)")