Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/dev' into apps-config
Browse files Browse the repository at this point in the history
  • Loading branch information
@yahavi
yahavi committed Oct 1, 2023
2 parents edc78c1 + d95ea1f commit c28deec
Show file tree
Hide file tree
Showing 5 changed files with 69 additions and 72 deletions.
62 changes: 31 additions & 31 deletions documentation/CLI-for-JFrog-Lifecycle.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The following sections describe the commands available in JFrog CLI when perform

### Creating a Release Bundle v2 from builds or from existing Release Bundles

This command creates a Release Bundle v2 from a published build-info or from an existing Release Bundle.
This command creates a Release Bundle v2 from published build-infos or from existing Release Bundles.
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
{
Expand Down Expand Up @@ -48,20 +48,20 @@ This command creates a Release Bundle v2 from a published build-info or from an
```
`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 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 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. |
| Command arguments | |
| release bundle name | Name of the newly created Release Bundle. |
| release bundle version | Version of the newly created Release Bundle. |
| | |
|------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
| Command-name | release-bundle-create |
| Abbreviation | rbc |
| Command options | |
| --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 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. |
| Command arguments | |
| release bundle name | Name of the newly created Release Bundle. |
| release bundle version | Version of the newly created Release Bundle. |

#### Examples

Expand All @@ -77,33 +77,33 @@ jf rbc --builds=/path/to/builds-spec.json --signing-key=myKeyPair myApp 1.0.0
Create a Release Bundle v2 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
jf rbc --release-bundles=/path/to/release-bundles-spec.json --signing-key=myKeyPair myApp 1.0.0
```
##### Example 3
Create a Release Bundle v2 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
jf rbc --release-bundles=/path/to/release-bundles-spec.json --signing-key=myKeyPair --sync=true --project=project0 myApp 1.0.0
```
### Promoting a Release Bundle v2
This command promotes a Release Bundle v2 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 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. |
| --sync | \[Default: false\]<br><br>Set to true to run synchronously. |
| Command arguments | |
| release bundle name | Name of the Release Bundle to promote. |
| release bundle version | Version of the Release Bundle to promote. |
| environment | Name of the target environment for the promotion. |
| | |
|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 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 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. |
| --sync | \[Default: false\]<br><br>Set to true to run synchronously. |
| Command arguments | |
| release bundle name | Name of the Release Bundle to promote. |
| release bundle version | Version of the Release Bundle to promote. |
| environment | Name of the target environment for the promotion. |
#### Examples
##### Example 1
Expand Down
17 changes: 8 additions & 9 deletions go.mod
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ require (
github.com/BurntSushi/toml v1.3.2 // indirect
github.com/CycloneDX/cyclonedx-go v0.7.2 // indirect
github.com/Microsoft/go-winio v0.6.1 // indirect
github.com/ProtonMail/go-crypto v0.0.0-20230828082145-3c4c8a2d2371 // indirect
github.com/Microsoft/hcsshim v0.11.0 // indirect
github.com/ProtonMail/go-crypto v0.0.0-20230923063757-afb1ddc0824c // indirect
github.com/VividCortex/ewma v1.2.0 // indirect
github.com/acarl005/stripansi v0.0.0-20180116102854-5a71ef0e047d // indirect
github.com/acomagu/bufpipe v1.0.4 // indirect
Expand All @@ -39,13 +40,13 @@ require (
github.com/cenkalti/backoff/v4 v4.2.1 // indirect
github.com/chzyer/readline v1.5.1 // indirect
github.com/cloudflare/circl v1.3.3 // indirect
github.com/containerd/containerd v1.7.3 // indirect
github.com/containerd/containerd v1.7.6 // indirect
github.com/cpuguy83/dockercfg v0.3.1 // indirect
github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
github.com/cyphar/filepath-securejoin v0.2.4 // indirect
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/docker/distribution v2.8.2+incompatible // indirect
github.com/docker/docker v24.0.5+incompatible // indirect
github.com/docker/docker v24.0.6+incompatible // indirect
github.com/docker/go-connections v0.4.0 // indirect
github.com/docker/go-units v0.5.0 // indirect
github.com/dsnet/compress v0.0.2-0.20210315054119-f66993602bf5 // indirect
Expand Down Expand Up @@ -85,7 +86,7 @@ require (
github.com/opencontainers/go-digest v1.0.0 // indirect
github.com/opencontainers/image-spec v1.1.0-rc4 // indirect
github.com/opencontainers/runc v1.1.5 // indirect
github.com/owenrumney/go-sarif/v2 v2.2.0 // indirect
github.com/owenrumney/go-sarif/v2 v2.2.2 // indirect
github.com/pelletier/go-toml/v2 v2.0.8 // indirect
github.com/pierrec/lz4/v4 v4.1.2 // indirect
github.com/pjbgf/sha1cd v0.3.0 // indirect
Expand Down Expand Up @@ -125,12 +126,10 @@ require (
gopkg.in/yaml.v3 v3.0.1 // indirect
)

// replace github.com/jfrog/build-info-go => github.com/jfrog/build-info-go v1.8.9-0.20230828134416-f0db33dd9344
replace github.com/jfrog/build-info-go => github.com/jfrog/build-info-go v1.8.9-0.20230928084830-478bd49f5d3e

replace github.com/jfrog/jfrog-cli-core/v2 => github.com/jfrog/jfrog-cli-core/v2 v2.31.1-0.20230928113028-e2aca0fa17f8
replace github.com/jfrog/jfrog-cli-core/v2 => github.com/jfrog/jfrog-cli-core/v2 v2.31.1-0.20230928145640-1d74324157cb

// replace github.com/jfrog/gofrog => github.com/jfrog/gofrog v1.2.6-0.20230418122323-2bf299dd6d27

// replace github.com/jfrog/jfrog-client-go => github.com/jfrog/jfrog-client-go v1.28.1-0.20230913164821-c396cb9a4e06

// replace github.com/jfrog/build-info-go => github.com/jfrog/build-info-go v1.8.9-0.20230831151231-e5e7bd035ddc
replace github.com/jfrog/jfrog-client-go => github.com/jfrog/jfrog-client-go v1.28.1-0.20230928142526-622034e3f57b
Loading

0 comments on commit c28deec

Please sign in to comment.