Skip to content

Commit 6783c55

Browse files
sverdlov93sverdlov93
authored
Fix docs (#110)
1 parent e032f18 commit 6783c55

23 files changed

+405
-401
lines changed

‎jfrog-applications/ci-and-sdks/ci-integrations/artifactory-gradle-plugin.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ The plugin adds the `artifactoryPublish` task for each project, in the 'publishi
2323
* The below convention attributes have been removed:
2424

2525
| Attribute | Migration action |
26-
| :-------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
27-
| parent | No longer supported. |
26+
|:---------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
27+
| parent | No longer supported. |
2828
| resolve | To define the Artifactory resolution repositories for your build, declare the repositories under the repositories section as described [here](https://docs.gradle.org/current/userguide/declaring\_repositories.html#declaring-repositories). |
2929

3030
</details>

‎jfrog-applications/ci-and-sdks/ci-integrations/github-actions.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This GitHub Action downloads, installs and configures JFrog CLI, so that it can
66

77
In addition, the Action includes the following features, when using JFrog CLI to work with JFrog Platform.
88

9-
* The connection details of the JFrog platform used by JFrog CLI can be stored as secrets. Read more about it [here](broken-reference).
9+
* The connection details of the JFrog platform used by JFrog CLI can be stored as secrets.
1010
* There's no need to add the _build name_ and _build number_ options and arguments to commands which accept them. All build related operations will be automatically recorded with the _Workflow Name_ as build name and _Run Number_ as build number.
1111

1212
## Usage
@@ -52,7 +52,7 @@ You can use these environment variables in your workflow as follows:
5252
```
5353
5454
| Important: If both Config Token(JF\_ENV\_\*) and separate environment variables(JF\_URL, ...) are provided, the default config will be the Config Token. To make the above separate environment variables as the default config use `jf c use setup-jfrog-cli-server` |
55-
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
55+
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
5656

5757
#### Storing the connection details using single Config Token
5858

@@ -93,7 +93,7 @@ If you have multiple Config Tokens as secrets, you can use all of them in the wo
9393
```
9494

9595
| Important: When exposing more than one JFrog configuration to the Action, you should always add the `jf c use` command to specify the server to use. |
96-
| ---------------------------------------------------------------------------------------------------------------------------------------------------- |
96+
|------------------------------------------------------------------------------------------------------------------------------------------------------|
9797

9898
### Setting the build name and build number when publishing build-info to Artifactory
9999

‎jfrog-applications/ci-and-sdks/ci-integrations/gitlab-templates-for-jfrog.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ As shown in the above [Including the Script](broken-reference) and [Referencing
8989
Configurations can be done via Project Settings > CI/CD > Variables:
9090

9191
| Variable | Usage |
92-
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
92+
|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
9393
| JF\_DOCKER\_REGISTRY | Docker registry in Artifactory. For more info, see [Getting Started with Artifactory as a Docker Registry](https://www.jfrog.com/confluence/display/JFROG/Getting+Started+with+Artifactory+as+a+Docker+Registry) |
9494
| JFROG\_CLI\_BUILD\_PROJECT | JFrog project key to be used by commands which expect build name and build number. Determines the project of the published build. |
9595
| JFROG\_CLI\_VERSION | Use a specific JFrog CLI version instead of the latest version. The minimal version allowed is: 2.17.0 |

‎jfrog-applications/ci-and-sdks/ci-integrations/maven-artifactory-plugin.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ A typical build plugin configuration would be as follows:
5050
</build>
5151
```
5252

53-
The plugin's invocation phase is validate by default and we recommend you don't change it so the plugin is called as early as possible in the lifecycle of your Maven build.
53+
The plugin's invocation phase is validate by default, and we recommend you don't change it so the plugin is called as early as possible in the lifecycle of your Maven build.
5454

5555
#### Full Configuration
5656

@@ -114,13 +114,13 @@ However, the Maven Artifactory Plugin provides many other configurations:
114114

115115
#### Configuration Details
116116

117-
| Configuration | Description |
118-
| :------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
117+
| Configuration | Description |
118+
|:--------------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
119119
| `<deployProperties>` | Specifies properties you can attach to published artifacts. For example: prop-value. |
120-
| `<artifactory>` | Specifies whether environment variables are published as part of BuildInfo metadata and which include or exclude patterns are applied when variables are collected |
121-
| `<publisher>` | Defines an Artifactory repository where build artifacts should be published using a combination of a `<contextUrl>` and `<repoKey>/<snapshotRepoKey>`. Build artifacts are deployed if the deploy goal is executed and only after all modules are built. |
122-
| `<buildInfo>` | Updates BuildInfo metadata published together with build artifacts. You can configure whether or not BuildInfo metadata is published using the configuration. |
123-
| `<proxy>` | Specifies HTTP/S proxy. |
120+
| `<artifactory>` | Specifies whether environment variables are published as part of BuildInfo metadata and which include or exclude patterns are applied when variables are collected |
121+
| `<publisher>` | Defines an Artifactory repository where build artifacts should be published using a combination of a `<contextUrl>` and `<repoKey>/<snapshotRepoKey>`. Build artifacts are deployed if the deploy goal is executed and only after all modules are built. |
122+
| `<buildInfo>` | Updates BuildInfo metadata published together with build artifacts. You can configure whether or not BuildInfo metadata is published using the configuration. |
123+
| `<proxy>` | Specifies HTTP/S proxy. |
124124

125125
#### Reading Environment Variables and System Properties
126126

‎jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/authentication.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@ When used with Artifactory, JFrog CLI offers several means of authentication: JF
77
To authenticate yourself using your JFrog login credentials, either configure your credentials once using the **jf c add** command or provide the following option to each command.
88

99
| Command option | Description |
10-
| -------------- | --------------------------------------------------------------------- |
10+
|----------------|-----------------------------------------------------------------------|
1111
| --url | JFrog Artifactory API endpoint URL. It usually ends with /artifactory |
1212
| --user | JFrog username |
1313
| --password | JFrog password or API key |
1414

15-
For enhanced security, when JFrog CLI is configured to use a username and password / API key, it automatically generates an access token to authenticate with Artifactory. The generated access token is valid for one hour only. JFrog CLI automatically refreshed the token before it expires. The **jfrog c add** command allows disabling this functionality. This feature is currently not supported by commands which use external tools or package managers or work with JFrog Distribution.
15+
For enhanced security, when JFrog CLI is configured to use a username and password / API key, it automatically generates an access token to authenticate with Artifactory. The generated access token is valid for one hour only. JFrog CLI automatically refreshed the token before it expires. The **jf c add** command allows disabling this functionality. This feature is currently not supported by commands which use external tools or package managers or work with JFrog Distribution.
1616

1717
## Authenticating with an Access Token
1818

1919
To authenticate yourself using an Artifactory Access Token, either configure your Access Token once using the **jf c add** command or provide the following option to each command.
2020

2121
| Command option | Description |
22-
| -------------- | --------------------------------------------------------------------- |
22+
|----------------|-----------------------------------------------------------------------|
2323
| --url | JFrog Artifactory API endpoint URL. It usually ends with /artifactory |
2424
| --access-token | JFrog access token |
2525

@@ -39,7 +39,7 @@ From version 4.4, Artifactory supports SSH authentication using RSA public and p
3939
* Configure your Artifactory URL to have the following format: `ssh://[host]:[port]` There are two ways to do this:
4040

4141
* For each command, use the `--url` command option.
42-
* Specify the Artifactory URL in the correct format using the **jfrog c add** command.
42+
* Specify the Artifactory URL in the correct format using the **jf c add** command.
4343

4444
***
4545

@@ -52,7 +52,7 @@ From version 4.4, Artifactory supports SSH authentication using RSA public and p
5252
***
5353
* Configure the path to your SSH key file. There are two ways to do this:
5454
* For each command, use the `--ssh-key-path` command option.
55-
* Specify the path using the **jfrog c add** command.
55+
* Specify the path using the **jf c add** command.
5656

5757
## Authenticating using Client Certificates (mTLS)
5858

0 commit comments

Comments
 (0)