Skip to content

Update CLI-for-JFrog-Lifecycle.md #1

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
michaelbe-jfrog wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Update CLI-for-JFrog-Lifecycle.md #1

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
50 changes: 25 additions & 25 deletions documentation/CLI-for-JFrog-Lifecycle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# JFrog CLI : CLI for JFrog Release Lifecycle Management
# JFrog CLI: CLI for JFrog Release Lifecycle Management

## Overview

Expand All @@ -13,12 +13,12 @@ Read more about JFrog CLI [here](https://jfrog.com/help/r/jfrog-cli).

### Commands

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

### Creating a release bundle from builds or from existing release bundles
### Creating a Release Bundle from builds or from existing Release Bundles

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:
This command creates a Release Bundle from a published build-info or from 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 using the following JSON format:
```json
{
"builds": [
Expand All @@ -30,11 +30,11 @@ This command allows creating a release bundle from a published build-info or an
]
}
```
`number` is optional, latest build will be used if empty.
`number` is optional (if left empty, the latest build will be used)

`project` is optional, default project will be used if empty.
`project` is optional (if left empty, the default project will be used)

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:
2. To create a Release Bundle from existing Release Bundles, provide the `--release-bundles` option, which accepts a path to a file using the following JSON format:
```json
{
"releaseBundles": [
Expand All @@ -46,16 +46,16 @@ This command allows creating a release bundle from a published build-info or an
]
}
```
`project` is optional, default project will be used if empty.
`project` is optional (if left empty, the default project will be used)

| | |
|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Command-name | release-bundle-create |
| Abbreviation | rbc |
| Command options | |
| --builds | \[Optional\]<br><br>Path to a JSON file containing information about source builds from which to create a release bundle. |
| --builds | \[Optional\]<br><br>Path to a JSON file containing information about the 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. |
| --release-bundles | \[Optional\]<br><br>Path to a JSON file containing information about the 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. |
Expand All @@ -67,35 +67,35 @@ This command allows creating a release bundle from a published build-info or an

##### 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.
Create a Release Bundle with the name "myApp" and version "1.0.0", with signing key pair "myKeyPair".
The Release Bundle will include the 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
```
##### 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.
Create a Release Bundle with the name "myApp" and version "1.0.0", with signing key pair "myKeyPair".
The Release Bundle will include the artifacts of the Release Bundles that were provided in the Release Bundles spec.
```
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.
Create a Release Bundle synchronously with the name "myApp" and version "1.0.0", in project "project0", with signing key pair "myKeyPair".
The Release Bundle will include the artifacts of the Release Bundles that were provided in the Release Bundles spec.
```
jf rbc --spec=/path/to/release-bundles-spec.json --signing-key=myKeyPair --sync=true --project=project0 myApp 1.0.0
```
### Promoting a release bundle
### Promoting a Release Bundle

This commands allows promoting a release bundle to a target environment.
This commands promotes a Release Bundle to a target environment.

| | |
|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Command-name | release-bundle-promote |
| Abbreviation | rbp |
| Command options | |
| --overwrite | \[Default: false\]<br><br>Set to true to replace artifacts with the same name but a different checksum if such already exist at the promotion targets. By default, the promotion is stopped in a case of such conflict |
| --overwrite | \[Default: false\]<br><br>Set to true to replace artifacts with the same name but a different checksum, if such already exist at the promotion targets. By default, the promotion is stopped when a conflict occurs. |
| --project | \[Optional\]<br><br>Project key associated with the Release Bundle version. |
| --server-id | \[Optional\]<br><br>Platform server ID configured using the config command. |
| --signing-key | \[Mandatory\]<br><br>The GPG/RSA key-pair name given in Artifactory. |
Expand All @@ -108,16 +108,16 @@ This commands allows promoting a release bundle to a target environment.
#### Examples
##### Example 1

Promote a release bundle named "myApp" version "1.0.0" to environment "PROD".
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
```
##### 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.
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 in case of conflicts.
```
jf rbp --signing-key=myKeyPair --project=project0 --overwrite=true --sync=true myApp 1.0.0 PROD
```
```