From 7f350ea2159b245a72bdf0637de473236dfe6dda Mon Sep 17 00:00:00 2001 From: Rima Polsky Date: Mon, 12 May 2025 12:07:29 +0300 Subject: [PATCH] Introduce annotate command into release-lifecycle-management --- .../release-lifecycle-management.md | 79 +++++++++++++++++++ 1 file changed, 79 insertions(+) diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md index 5730abd8..b81e2c38 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md @@ -203,6 +203,85 @@ Promote a Release Bundle, using promotion type flag. jf rbp --signing-key=myKeyPair --promotion-type="move" myApp 1.0.0 PROD ``` +# Annotate a Release Bundle v2 + +This command allows to add a single tag to a Release Bundle v2 version and/or define one or more properties or delete +one or more properties. + +### Commands Params + +| | | +|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | release-bundle-annotate | +| Abbreviation | rba | +| **Command arguments:** | | +| release bundle name | Name of the Release Bundle to annotate. | +| release bundle version | Version of the Release Bundle to annotate. | | +| **Command options:** | | +| `--tag` |

[Optional]
The tag is a single free-text value limited to 128 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]), with dashes (-), underscores (_), dots (.),and alphanumerics between. | +| .

| | +| `--properties` |

[Optional]
Key-value pairs separated by a semicolon (;). Keys are limited to 255 characters. Values are limited to 2400 characters.

| +| `--del-prop` |

[Optional]
Removes a key and all its associated values.

| +| `--recursive` |

[Default: true]
Set to false(0) to don't run recursively.

| + + +### Examples + +#### Example 1 + +Add or modify a tag or property. + +``` +jf rba mybundle 1.0.0 --tag=release --properties "environment=production;buildNumber=1234" +``` + +#### Example 2 + +Whenever you use the --tag command option, the value you define replaces the current value. + +``` +jf rba mybundle 1.0.0 --tag=rejected +``` +In the example above, the tag that was defined previously (release) is replaced with the new tag rejected. + +#### Example 3 + +Whenever you use the --properties command option with an existing key, the values that you define replace the current values. + +``` +jf rba mybundle 1.0.0 --properties "environment=DEV,PROD,QA" +``` +In the example above, the value for environment that was defined previously (production) is replaced by the values DEV, PROD, and QA. + +#### Remove Tags and Properties + +#### Example 1 + +To remove the tag, set it to empty. + +``` +jf rba mybundle 1.0.0 --tag="" +``` + +#### Example 2 + +To remove the values from an existing key without removing the key, leave the value empty. + +``` +jf rba mybundle 1.0.0 --properties "build=''" +``` +In the example above, all values defined for the build key are removed but the key is retained. + +#### Example 3 + +To remove a key and its associated values, use the --del-prop command option. + +``` +jf rba mybundle 1.0.0 --del-prop "environment" +``` +In the example above, the environment key and all its associated values are removed. + + ## Distribute a Release Bundle v2 This command distributes a Release Bundle to an Edge node.