Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@sverdlov93
sverdlov93 committed Apr 18, 2024
1 parent 702f298 commit 88620fc
Show file tree
Hide file tree
Showing 9 changed files with 166 additions and 185 deletions.
1 change: 0 additions & 1 deletion jfrog-applications/SUMMARY.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
* [Usage](jfrog-cli/get-started/download-and-install/usage.md)
* [Configurations](jfrog-cli/get-started/configurations/README.md)
* [JFrog Platform Configuration](jfrog-cli/get-started/configurations/jfrog-platform-configuration.md)
* [Setting up a CI Pipeline](jfrog-cli/get-started/configurations/setting-up-a-ci-pipeline.md)
* [Proxy Support](jfrog-cli/get-started/configurations/proxy-support.md)
* [CLI for JFrog Artifactory](jfrog-cli/cli-for-jfrog-artifactory/README.md)
* [Environment Variables](jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md)
Expand Down
62 changes: 31 additions & 31 deletions jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ By default, the command collects the files from the local file system. If you'd
| --from-rt | <p>[Default: false]<br>Set to true to search the files in Artifactory, rather than on the local file system. The --regexp option is not supported when --from-rt is set to true.</p> |
| --server-id | <p>[Optional]<br>Server ID configured using the config command.</p> |
| --spec | <p>[Optional]<br>Path to a File Spec.</p> |
| --spec-vars | <p>[Optional]<br>List of variables in the form of "key1=value1;key2=value2;..." to be replaced in the File Spec. In the File Spec, the variables should be used as follows: ${key1}.</p> |
| --spec-vars | <p>[Optional]<br>List of Semicolon-separated variables in the form of "key1=value1;key2=value2;..." to be replaced in the File Spec. In the File Spec, the variables should be used as follows: ${key1}.</p> |
| --recursive | <p>[Default: true]<br>When false, artifacts inside sub-folders in Artifactory will not be affected.</p> |
| --regexp | <p>[Optional: false]<br>[Default: false] Set to true to use a regular expression instead of wildcards expression to collect files to be added to the build info.This option is not supported when --from-rt is set to true.</p> |
| --dry-run | <p>[Default: false]<br>Set to true to only get a summery of the dependencies that will be added to the build info.</p> |
Expand Down Expand Up @@ -207,21 +207,21 @@ For example, the following command publishes all the build-info collected for bu
### Commands Params
| | |
|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Command name | rt build-publish |
| Abbreviation | rt bp |
| Command arguments | The command accepts two arguments. |
| Build name | Build name to be published. |
| Build number | Build number to be published. |
| Command options | |
| --server-id | <p>[Optional]<br>Server ID configured using the config command. If not specified, the default configured Artifactory server is used.</p> |
| --project | <p>[Optional]<br>JFrog project key.</p> |
| --build-url | <p>[Optional]<br>Can be used for setting the CI server build URL in the build-info.</p> |
| --env-include | <p>[Default: *]<br>List of patterns in the form of "value1;value2;..." Only environment variables that match those patterns will be included in the build info.</p> |
| --env-exclude | <p>[Default: *password*;*secret*;*key*]<br>List of case insensitive patterns in the form of "value1;value2;..." environment variables match those patterns will be excluded.</p> |
| --dry-run | <p>[Default: false]<br>Set to true to disable communication with Artifactory.</p> |
| --insecure-tls | <p>[Default: false]<br>Set to true to skip TLS certificates verification.</p> | |
| | |
|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Command name | rt build-publish |
| Abbreviation | rt bp |
| Command arguments | The command accepts two arguments. |
| Build name | Build name to be published. |
| Build number | Build number to be published. |
| Command options | |
| --server-id | <p>[Optional]<br>Server ID configured using the config command. If not specified, the default configured Artifactory server is used.</p> |
| --project | <p>[Optional]<br>JFrog project key.</p> |
| --build-url | <p>[Optional]<br>Can be used for setting the CI server build URL in the build-info.</p> |
| --env-include | <p>[Default: *]<br>List of Semicolon-separated patterns in the form of "value1;value2;..." Only environment variables that match those patterns will be included in the build info.</p> |
| --env-exclude | <p>[Default: *password*;*secret*;*key*]<br>List of Semicolon-separated case insensitive patterns in the form of "value1;value2;..." environment variables match those patterns will be excluded.</p> |
| --dry-run | <p>[Default: false]<br>Set to true to disable communication with Artifactory.</p> |
| --insecure-tls | <p>[Default: false]<br>Set to true to skip TLS certificates verification.</p> | |
### Example
Expand Down Expand Up @@ -339,7 +339,7 @@ This command is used to [promote build](https://jfrog.com/knowledge-base/how-doe
| --source-repo | <p>[Optional]<br>Build promotion source repository.</p> |
| --include-dependencies | <p>[Default: false]<br>If set to true, the build dependencies are also promoted.</p> |
| --copy | <p>[Default: false]<br>If set true, the build artifacts and dependencies are copied to the target repository, otherwise they are moved.</p> |
| --props | <p>[Optional]<br>List of properties in the form of "key1=value1;key2=value2,...". to attach to the build artifacts.</p> |
| --props | <p>[Optional]<br>List of Semicolon-separated properties in the form of "key1=value1;key2=value2,...". to attach to the build artifacts.</p> |
| --dry-run | <p>[Default: false]<br>If true, promotion is only simulated. The build is not promoted.</p> |
| --insecure-tls | <p>[Default: false]<br>Set to true to skip TLS certificates verification.</p> | |

Expand Down Expand Up @@ -393,20 +393,20 @@ This command is used to discard builds previously published to Artifactory using

The following table lists the command arguments and flags:

| | |
|--------------------|------------------------------------------------------------------------------------------------------------------------------------------|
| Command name | rt build-discard |
| Abbreviation | rt bdi |
| Command arguments | The command accepts one argument. |
| Build name | Build name. |
| Command options | |
| --server-id | <p>[Optional]<br>Server ID configured using the config command. If not specified, the default configured Artifactory server is used.</p> |
| --max-days | <p>[Optional]<br>The maximum number of days to keep builds in Artifactory.</p> |
| --max-builds | <p>[Optional]<br>The maximum number of builds to store in Artifactory.</p> |
| --exclude-builds | <p>[Optional]<br>List of build numbers in the form of "value1,value2,...", that should not be removed from Artifactory.</p> |
| --delete-artifacts | <p>[Default: false]<br>If set to true, automatically removes build artifacts stored in Artifactory.</p> |
| --async | <p>[Default: false]<br>If set to true, build discard will run asynchronously and will not wait for response.</p> |
|
| | |
|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
| Command name | rt build-discard |
| Abbreviation | rt bdi |
| Command arguments | The command accepts one argument. |
| Build name | Build name. |
| Command options | |
| --server-id | <p>[Optional]<br>Server ID configured using the config command. If not specified, the default configured Artifactory server is used.</p> |
| --max-days | <p>[Optional]<br>The maximum number of days to keep builds in Artifactory.</p> |
| --max-builds | <p>[Optional]<br>The maximum number of builds to store in Artifactory.</p> |
| --exclude-builds | <p>[Optional]<br>List of comma-separated build numbers in the form of "build1,build2,...", that should not be removed from Artifactory.</p> |
| --delete-artifacts | <p>[Default: false]<br>If set to true, automatically removes build artifacts stored in Artifactory.</p> |
| --async | <p>[Default: false]<br>If set to true, build discard will run asynchronously and will not wait for response.</p> |
### Examples
#### Example 1

Expand Down
2 changes: 1 addition & 1 deletion jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Some of the Artifactory commands make use of the following environment variable:
| **JFROG\_CLI\_BUILD\_NUMBER** | Build number to be used by commands which expect a build number, unless sent as a command argument or option. |
| **JFROG\_CLI\_BUILD\_PROJECT** | JFrog project key to be used by commands that expect build name and build number. Determines the project of the published build. |
| **JFROG\_CLI\_BUILD\_URL** | Sets the CI server build URL in the build-info. The "jf rt build-publish" command uses the value of this environment variable unless the --build-url command option is sent. |
| **JFROG\_CLI\_ENV\_EXCLUDE** | <p>[Default: *password*;*secret*;*key*;*token*]<br>List of case insensitive patterns in the form of "value1;value2;...". Environment variables match those patterns will be excluded. This environment variable is used by the "jf rt build-publish" command, in case the --env-exclude command option is not sent.</p> |
| **JFROG\_CLI\_ENV\_EXCLUDE** | <p>[Default: *password*;*secret*;*key*;*token*]<br>List of Semicolon-separated case insensitive patterns in the form of "value1;value2;...". Environment variables match those patterns will be excluded. This environment variable is used by the "jf rt build-publish" command, in case the --env-exclude command option is not sent.</p> |
| **JFROG\_CLI\_TRANSITIVE\_DOWNLOAD\_EXPERIMENTAL** | <p>[Default: false]<br>Used by the "jf rt download" command. Set to true to download artifacts also from remote repositories. This feature is experimental and available on Artifactory version 7.17.0 or higher.</p> |
| **JFROG\_CLI\_UPLOAD\_EMPTY\_ARCHIVE** | <p>[Default: false]<br>Used by the "jf rt upload" command. Set to true if you'd like to upload an empty archive when '--archive' is set but all files were excluded by exclusions pattern.</p> |

Expand Down
Loading

0 comments on commit 88620fc

Please sign in to comment.