You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# JFrog CLI: CLI for JFrog Release Lifecycle Management
1
+
# JFrog CLI: CLI for JFrog Release Lifecycle Management
2
2
3
3
## Overview
4
4
@@ -13,12 +13,12 @@ Read more about JFrog CLI [here](https://jfrog.com/help/r/jfrog-cli).
13
13
14
14
### Commands
15
15
16
-
The following sections describe the commands available in JFrog CLI for use with the Release Lifecycle Management functionality.
16
+
The following sections describe the commands available in JFrog CLI when performing Release Lifecycle Management operations on Release Bundles v2.
17
17
18
-
### Creating a release bundle from builds or from existing release bundles
18
+
### Creating a Release Bundle v2 from builds or from existing Release Bundles
19
19
20
-
This command allows creating a release bundle from a published build-info or an existing release bundle.
21
-
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:
20
+
This command creates a Release Bundle v2 from a published build-info or from an existing Release Bundle.
21
+
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:
22
22
```json
23
23
{
24
24
"builds": [
@@ -30,11 +30,11 @@ This command allows creating a release bundle from a published build-info or an
30
30
]
31
31
}
32
32
```
33
-
`number` is optional, latest build will be used if empty.
33
+
`number` is optional (if left empty, the latest build will be used)
34
34
35
-
`project` is optional, default project will be used if empty.
35
+
`project` is optional (if left empty, the default project will be used)
36
36
37
-
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:
37
+
2. To create a Release Bundle v2 from existing Release Bundles, provide the `--release-bundles` option, which accepts a path to a file using the following JSON format:
38
38
```json
39
39
{
40
40
"releaseBundles": [
@@ -46,16 +46,16 @@ This command allows creating a release bundle from a published build-info or an
46
46
]
47
47
}
48
48
```
49
-
`project` is optional, default project will be used if empty.
49
+
`project` is optional (if left empty, the default project will be used)
| --builds | \[Optional\]<br><br>Path to a JSON file containing information about source builds from which to create a release bundle. |
56
+
| --builds | \[Optional\]<br><br>Path to a JSON file containing information about the source builds from which to create a Release Bundle. |
57
57
| --project | \[Optional\]<br><br>JFrog Project key associated with the Release Bundle version. |
58
-
| --release-bundles | \[Optional\]<br><br>Path to a JSON file containing information about source release bundles from which to create a release bundle. |
58
+
| --release-bundles | \[Optional\]<br><br>Path to a JSON file containing information about the source Release Bundles from which to create a Release Bundle. |
59
59
| --server-id | \[Optional\]<br><br>Platform server ID configured using the `jf c add` command. |
60
60
| --signing-key | \[Mandatory\]<br><br>The GPG/RSA key-pair name given in Artifactory. |
61
61
| --sync | \[Default: false\]<br><br>Set to true to run synchronously. |
@@ -67,35 +67,35 @@ This command allows creating a release bundle from a published build-info or an
67
67
68
68
##### Example 1
69
69
70
-
Create a release bundle with name "myApp" and version "1.0.0", with signing key pair "myKeyPair".
71
-
The release bundle will include artifacts of the builds that were provided in the builds spec.
70
+
Create a Release Bundle v2 with the name "myApp" and version "1.0.0", with signing key pair "myKeyPair".
71
+
The Release Bundle will include the artifacts of the builds that were provided in the builds spec.
| --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 |
98
+
| --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.|
99
99
| --project | \[Optional\]<br><br>Project key associated with the Release Bundle version. |
100
100
| --server-id | \[Optional\]<br><br>Platform server ID configured using the config command. |
101
101
| --signing-key | \[Mandatory\]<br><br>The GPG/RSA key-pair name given in Artifactory. |
@@ -108,16 +108,16 @@ This commands allows promoting a release bundle to a target environment.
108
108
#### Examples
109
109
##### Example 1
110
110
111
-
Promote a release bundle named "myApp" version "1.0.0" to environment "PROD".
111
+
Promote a Release Bundle v2 named "myApp" version "1.0.0" to environment "PROD".
112
112
Use signing key pair "myKeyPair".
113
113
```
114
114
jf rbp --signing-key=myKeyPair myApp 1.0.0 PROD
115
115
```
116
116
##### Example 2
117
117
118
-
Promote a release bundle synchronously to environment "PROD".
119
-
The release bundle is named "myApp", version "1.0.0", of project "project0".
120
-
Use signing key pair "myKeyPair" and overwrite at conflict.
118
+
Promote a Release Bundle v2 synchronously to environment "PROD".
119
+
The Release Bundle is named "myApp", version "1.0.0", of project "project0".
120
+
Use signing key pair "myKeyPair" and overwrite in case of conflicts.
0 commit comments