Skip to content

Added documentation for release bundle draft commands #214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jongler wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Added documentation for release bundle draft commands #214

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
142 changes: 142 additions & 0 deletions ...pplications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,7 @@ The **create** command allows creating a Release Bundle v2 using [file specs](ht
| `--source-type-release-bundles`| <p>[Optional]<br>One or more Release Bundles to include in the new Release Bundle in the form of "name=[rb-name], version=[rb-version];..." .</p> |
| `--source-type-builds` | <p>[Optional]<br>One or more builds to include in the new Release Bundle in the form of "name=[build-name], id=[build-id], include-deps=[true/false];...".</p> |
| `--sync` | <p>[Default: true]<br>Set to false to run asynchronously.</p> |
| `--draft` | <p>[Default: false]<br>Set to true to create a draft Release Bundle. Draft bundles can be updated before being finalized. Requires Artifactory 7.136.0 or higher.</p> |


### Examples
Expand Down Expand Up @@ -229,6 +230,147 @@ jf rbc rb3 1.0.0 --source-type-builds "name=Commons-Build, id=1.0.0, include-dep
--source-type-release-bundles "name=rb1, version=1.0.0; name=rb2, version=1.0.0"
```

#### Example 7

Create a draft Release Bundle from a build. Draft bundles can be updated before being finalized.

```
jf rbc myApp 1.0.0 --build-name=Common-builds --build-number=1.0.0 --draft=true
```

## Update a Release Bundle v2 (Draft)

This command allows updating an existing draft Release Bundle by adding sources (builds, artifacts, or other Release Bundles). Only draft bundles can be updated.

***

**Note**

> Update Release Bundle requires [Artifactory 7.136.0](https://jfrog.com/help/r/jfrog-release-information/artifactory-7.136.0) or higher.

***

### Command Params

| | |
|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Command-name | release-bundle-update |
| Abbreviation | rbu |
| **Command arguments:** | |
| release bundle name | Name of the Release Bundle to update. |
| release bundle version | Version of the Release Bundle to update. |
| **Command options:** | |
| `--add` | <p>[Mandatory]<br>Specifies that sources should be added to the draft bundle. This flag is required.</p> |
| `--project` | <p>[Optional]<br>Project key associated with the Release Bundle version.</p> |
| `--server-id` | <p>[Optional]<br>Platform Server ID configured using the 'jf config' command.</p> |
| `--spec` | <p>[Optional]<br>Path to a File Spec defining the sources to add. Uses the same format as the create command.</p> |
| `--spec-vars` | <p>[Optional]<br>List of semicolon-separated(;) variables in the form of "key1=value1;key2=value2;..." (wrapped by quotes) to be replaced in the File Spec.</p> |
| `--source-type-release-bundles` | <p>[Optional]<br>One or more Release Bundles to add in the form of "name=[rb-name], version=[rb-version];...".</p> |
| `--source-type-builds` | <p>[Optional]<br>One or more builds to add in the form of "name=[build-name], id=[build-id], include-deps=[true/false];...".</p> |
| `--sync` | <p>[Default: true]<br>Set to false to run asynchronously.</p> |

### Examples

#### Example 1

Update a draft Release Bundle by adding artifacts from a build using command flags.

```
jf rbu myApp 1.0.0 --add --source-type-builds "name=Commons-Build, id=1.0.0, include-deps=true"
```

#### Example 2

Update a draft Release Bundle by adding sources defined in a spec file.

```
jf rbu myApp 1.0.0 --add --spec=/path/to/spec.json
```

#### Example 3

Update a draft Release Bundle associated with a specific project.

```
jf rbu myApp 1.0.0 --add --project=myProject --source-type-builds "name=Commons-Build, id=2.0.0"
```

## Finalize a Release Bundle v2 (Draft)

This command finalizes a draft Release Bundle, making it immutable and ready for promotion. Once finalized, a Release Bundle cannot be updated.

***

**Note**

> Finalize Release Bundle requires [Artifactory 7.136.0](https://jfrog.com/help/r/jfrog-release-information/artifactory-7.136.0) or higher.

***

### Command Params

| | |
|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Command-name | release-bundle-finalize |
| Abbreviation | rbf |
| **Command arguments:** | |
| release bundle name | Name of the Release Bundle to finalize. |
| release bundle version | Version of the Release Bundle to finalize. |
| **Command options:** | |
| `--project` | <p>[Optional]<br>Project key associated with the Release Bundle version.</p> |
| `--server-id` | <p>[Optional]<br>Platform Server ID configured using the 'jf config' command.</p> |
| `--signing-key` | <p>[Optional]<br>The GPG/RSA key-pair name defined in Artifactory. If no key is specified, Artifactory uses a default key.</p> |

### Examples

#### Example 1

Finalize a draft Release Bundle.

```
jf rbf myApp 1.0.0
```

#### Example 2

Finalize a draft Release Bundle with a specific signing key.

```
jf rbf myApp 1.0.0 --signing-key=myKeyPair
```

#### Example 3

Finalize a draft Release Bundle associated with a specific project.

```
jf rbf myApp 1.0.0 --project=myProject --signing-key=myKeyPair
```

## Draft Release Bundle Workflow

A typical workflow for working with draft Release Bundles:

1. **Create a draft bundle**: Use `jf rbc` with `--draft=true` to create an initial draft bundle.
2. **Update the draft bundle**: Use `jf rbu` with `--add` to add more sources to the draft bundle as needed.
3. **Finalize the bundle**: Use `jf rbf` to finalize the draft bundle, making it immutable.
4. **Promote the bundle**: Use `jf rbp` to promote the finalized bundle to target environments.

### Example Workflow

```bash
# Step 1: Create a draft bundle from build 1
jf rbc myApp 1.0.0 --build-name=build1 --build-number=100 --draft=true

# Step 2: Add more artifacts from build 2
jf rbu myApp 1.0.0 --add --source-type-builds "name=build2, id=200"

# Step 3: Finalize the bundle
jf rbf myApp 1.0.0 --signing-key=myKeyPair

# Step 4: Promote to production
jf rbp myApp 1.0.0 PROD --signing-key=myKeyPair
```

## Promote a Release Bundle v2

Expand Down