Skip to content

Commit

Permalink
Release Lifecycle Management documentation corrections (#2130)
Browse files Browse the repository at this point in the history
  • Loading branch information
@eyalbe4
eyalbe4 authored Aug 13, 2023
1 parent 07c7cc7 commit a59d303
Showing 1 changed file with 27 additions and 37 deletions.
64 changes: 27 additions & 37 deletions documentation/CLI-for-JFrog-Lifecycle.md
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
JFrog CLI : CLI for JFrog Release Lifecycle Management
======================================
# JFrog CLI : CLI for JFrog Release Lifecycle Management


Overview
--------
## Overview

This page describes how to use JFrog CLI with [JFrog Release Lifecycle Management](https://jfrog.com/help/r/jfrog-artifactory-documentation/jfrog-release-lifecycle-management-solution).

Expand All @@ -14,20 +11,14 @@ Read more about JFrog CLI [here](https://jfrog.com/help/r/jfrog-cli).
> JFrog Release Lifecycle Management is only available since [Artifactory 7.63.2](https://jfrog.com/help/r/jfrog-release-information/artifactory-7.63.2-cloud).
---

### Syntax

When used with JFrog Release Lifecycle Management, JFrog CLI uses the following syntax:

$ jf command-name global-options command-options arguments

### Commands

The following sections describe the commands available in JFrog CLI for use with JFrog Release Lifecycle Management.
The following sections describe the commands available in JFrog CLI for use with the Release Lifecycle Management functionality.

### Creating a release bundle from builds or from existing release bundles

This commands allows creating a release bundle from one of two sources:
1. Published build infos. To use, provide the `--builds` option, which accepts a path to a JSON file of the following syntax:
This command allows creating a release bundle from a published build-info or an existing release bundle.
1. To create a release bundle from published build-infos, provide the `--builds` option, which accepts a path to a file, with the following JSON format:
```json
{
"builds": [
Expand All @@ -43,7 +34,7 @@ This commands allows creating a release bundle from one of two sources:

`project` is optional, default project will be used if empty.

2. Existing release bundles. To use, provide the `--release-bundles` option, which accepts a path to a JSON file of the following syntax:
2. To create a release bundle from existing release bundles, provide the `--release-bundles` option, which accepts a path to a file, with the following JSON format:
```json
{
"releaseBundles": [
Expand All @@ -62,39 +53,39 @@ This commands allows creating a release bundle from one of two sources:
| Command-name | release-bundle-create |
| Abbreviation | rbc |
| Command options | |
| --builds | \[Optional\]<br><br>Path to a JSON file containing information of the source builds from which to create a release bundle. |
| --project | \[Optional\]<br><br>Project key associated with the Release Bundle version. |
| --release-bundles | \[Optional\]<br><br>Path to a JSON file containing information of the source release bundles from which to create a release bundle. |
| --server-id | \[Optional\]<br><br>Platform server ID configured using the config command. |
| --builds | \[Optional\]<br><br>Path to a JSON file containing information about source builds from which to create a release bundle. |
| --project | \[Optional\]<br><br>JFrog Project key associated with the Release Bundle version. |
| --release-bundles | \[Optional\]<br><br>Path to a JSON file containing information about source release bundles from which to create a release bundle. |
| --server-id | \[Optional\]<br><br>Platform server ID configured using the `jf c add` command. |
| --signing-key | \[Mandatory\]<br><br>The GPG/RSA key-pair name given in Artifactory. |
| --sync | \[Default: false\]<br><br>Set to true to run synchronously. |
| Command arguments | |
| release bundle name | Name of the newly created Release Bundle. |
| release bundle version | Version of the newly created Release Bundle. |

##### Examples
#### Examples

##### Example 1

Create a release bundle with name "myApp" and version "1.0.0", with signing key pair "myKeyPair".
The release bundle will include artifacts of the builds that were provided in the builds spec.

jf rbc --builds=/path/to/builds-spec.json --signing-key=myKeyPair myApp 1.0.0

```
jf rbc --builds=/path/to/builds-spec.json --signing-key=myKeyPair myApp 1.0.0
```
##### Example 2
Create a release bundle with name "myApp" and version "1.0.0", with signing key pair "myKeyPair".
The release bundle will include artifacts of the release bundles that were provided in the release bundles spec.

jf ds rbc --spec=/path/to/release-bundles-spec.json --signing-key=myKeyPair myApp 1.0.0

```
jf rbc --spec=/path/to/release-bundles-spec.json --signing-key=myKeyPair myApp 1.0.0
```
##### Example 3
Create a release bundle synchronously with name "myApp" and version "1.0.0", in project "project0", with signing key pair "myKeyPair".
The release bundle will include artifacts of the release bundles that were provided in the release bundles spec.

jf ds rbc --spec=/path/to/release-bundles-spec.json --signing-key=myKeyPair --sync=true --project=project0 myApp 1.0.0

```
jf rbc --spec=/path/to/release-bundles-spec.json --signing-key=myKeyPair --sync=true --project=project0 myApp 1.0.0
```
### Promoting a release bundle
This commands allows promoting a release bundle to a target environment.
Expand All @@ -114,20 +105,19 @@ This commands allows promoting a release bundle to a target environment.
| release bundle version | Version of the Release Bundle to promote. |
| environment | Name of the target environment for the promotion. |

##### Examples

#### Examples
##### Example 1
Promote a release bundle named "myApp" version "1.0.0" to environment "PROD".
Use signing key pair "myKeyPair".

jf rbp --signing-key=myKeyPair myApp 1.0.0 PROD

```
jf rbp --signing-key=myKeyPair myApp 1.0.0 PROD
```
##### Example 2
Promote a release bundle synchronously to environment "PROD".
The release bundle is named "myApp", version "1.0.0", of project "project0".
Use signing key pair "myKeyPair" and overwrite at conflict.

jf rbp --signing-key=myKeyPair --project=project0 --overwrite=true --sync=true myApp 1.0.0 PROD
```
jf rbp --signing-key=myKeyPair --project=project0 --overwrite=true --sync=true myApp 1.0.0 PROD
```

0 comments on commit a59d303

Please sign in to comment.