jfrog · sverdlov93 · Aug 12, 2024 · Aug 12, 2024 · Aug 12, 2024 · Aug 12, 2024
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@
 
 -   [Overview](#overview)
 -   [Usage](#usage)
--   [Authorization](#authorization)
+-   [Authentication Methods](#Authentication-Methods)
 -   [Setting the build name and build number when publishing build-info to Artifactory](#setting-the-build-name-and-build-number-when-publishing-build-info-to-artifactory)
 -   [Setting JFrog CLI version](#setting-jfrog-cli-version)
 -   [Setting the JFrog project key](#setting-the-jfrog-project-key)
@@ -29,7 +29,7 @@ This GitHub Action downloads, installs and configures [JFrog CLI](https://docs.j
 
 Additionally, the Action incorporates the following features when utilizing JFrog CLI to interact with the JFrog Platform:
 
--   Two distinct methods are available for authenticating with the JFrog Platform. Explore more details [here](#authorization)
+-   Two distinct methods are available for authenticating with the JFrog Platform. Explore more details [here](#Authentication-Methods)
 -   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.
 
@@ -38,24 +38,17 @@ Additionally, the Action incorporates the following features when utilizing JFro
 ```yml
 - uses: jfrog/setup-jfrog-cli@v4
 - run: jf --version
+# + Authentication method
 ```
 
-## Authorization
+## Authentication Methods
 
-JFrog CLI operates in conjunction with the JFrog Platform. In order to facilitate this connection, certain connection details of the JFrog Platform must be provided.
-There exist two methods to provide these details, and you only need to choose **one** method:
+JFrog CLI integrates with the JFrog Platform. In order to facilitate this connection, certain connection details of the JFrog Platform must be provided.
+There exist three methods to provide these details, and you only need to choose **one** method:
 
 <details>
-    <summary>Connecting to JFrog using secrets</summary>
+    <summary>Storing the connection details using separate environment variables</summary>
 
-### General
-You can choose one of the following two methods to set the connection details to the JFrog Platform as secrets:
-
--   [Storing the connection details using separate environment variables](#storing-the-connection-details-using-separate-environment-variables)
--   [Storing the connection details using single Config Token](#storing-the-connection-details-using-single-config-token)
-
-### Storing the connection details using separate environment variables
-
 The connection details of the JFrog platform used by JFrog CLI can be stored as secrets.
 You can use one of the following two methods to define and store the JFrog Platform connection details as secrets.
 
@@ -76,59 +69,15 @@ You can use these environment variables in your workflow as follows:
     # Basic authentication credentials
     JF_USER: ${{ secrets.JF_USER }}
     JF_PASSWORD: ${{ secrets.JF_PASSWORD }}
-    or
+    # or
     # JFrog Platform access token
     JF_ACCESS_TOKEN: ${{ secrets.JF_ACCESS_TOKEN }}
 - run: |
     jf rt ping
 ```
 
 | 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` |
-| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-
-### Storing the connection details using single Config Token
-
-1. Make sure JFrog CLI is installed on your local machine by running `jf -v`.
-2. Configure the details of the JFrog platform by running `jf c add`.
-3. Export the details of the JFrog platform you configured, using the server ID you chose. Do this by running `jf c export <SERVER ID>`.
-4. Copy the generated Config Token to the clipboard and save it as a secret on GitHub.
-
-To use the saved JFrog platform configuration in the workflow, all you need to do it to expose the secret to the workflow.
-The secret should be exposed as an environment variable with the _JF*ENV*_ prefix.
-Here's how you do this:
-
-```yml
-- uses: jfrog/setup-jfrog-cli@v4
-  env:
-      JF_ENV_1: ${{ secrets.JF_SECRET_ENV_1 }}
-- run: |
-      # Ping the server
-      jf rt ping
-```
-
-As you can see in the example above, we created a secret named _JF_SECRET_ENV_1_ and exposed it to the workflow
-as the _JF_ENV_1_ environment variable. That's it - the ping command will now ping the configured Artifactory server.
-
-If you have multiple Config Tokens as secrets, you can use all of them in the workflow as follows:
-
-```yml
-- uses: jfrog/setup-jfrog-cli@v4
-  env:
-      JF_ENV_1: ${{ secrets.JF_SECRET_ENV_1 }}
-      JF_ENV_2: ${{ secrets.JF_SECRET_ENV_2 }}
-- run: |
-      # Set the utilized JFrog configuration by providing the server ID (configured by the 'jf c add' command).
-      jf c use local-1
-      # Ping local-1 Artifactory server
-      jf rt ping
-      # Now use the second sever configuration exposed to the Action.
-      jf c use local-2
-      # Ping local-2 Artifactory server
-      jf rt ping
-```
-
-| 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. |
-| ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 
 </details>
 
@@ -138,7 +87,9 @@ If you have multiple Config Tokens as secrets, you can use all of them in the wo
 ### General
 
 The sensitive connection details, such as the access token used by JFrog CLI on the JFrog platform, can be automatically generated by the action instead of storing it as a secret in GitHub.
-This is made possible by leveraging the OpenID-Connect (OIDC) protocol. This protocol can authenticate the workflow issuer and supply a valid access token, requiring only the JF_URL environment variable. Learn more about this integration in [this](https://jfrog.com/blog/secure-access-development-jfrog-github-oidc) blog post.
+This is made possible by leveraging the OpenID-Connect (OIDC) protocol.
+This protocol can authenticate the workflow issuer and supply a valid access token, requiring only the JF_URL environment variable.
+Learn more about this integration in [this](https://jfrog.com/blog/secure-access-development-jfrog-github-oidc) blog post.
 To utilize the OIDC protocol, follow these steps:
 
 ### JFrog Platform configuration
@@ -152,11 +103,11 @@ To utilize the OIDC protocol, follow these steps:
        ![Configure OIDC integration](images/configure_oidc_integration.png)
 
 | NOTE:                                                                                                                                                                                                                                          |
-| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | The value specified as the 'Provider Name' should be used as the oidc-provider-name input in [Workflow configuration step 2](#workflowstep2) below.                                                                                            |
 | The 'Audience' field does not represent the 'aud' claim for insertion into the identity-mapping in [Platform configuration step 2](#platformstep2) below. Only the claims included in the Claims Json created during step 2 will be validated. |
 
-<div id="platformstep2"/>
+<div id="platformstep2"></div>
 
 2.  **Configure an identity mapping**: This phase sets an integration between a particular GitHub repository to the JFrog platform.
 
@@ -173,6 +124,8 @@ To utilize the OIDC protocol, follow these steps:
     }
     ```
 
+
+
 ### Workflow configuration
 
 1.  **Set required permissions**: In the course of the protocol's execution, it's imperative to acquire a JSON Web Token (JWT) from GitHub's OIDC provider. To request this token, it's essential to configure the specified permission in the workflow file:
@@ -182,7 +135,7 @@ To utilize the OIDC protocol, follow these steps:
         id-token: write
     ```
 
-    <div id="workflowstep2"/>
+    <div id="workflowstep2"></div>
 
 2.  **Pass the 'oidc-provider-name' input to the Action (Required)**: The 'oidc-provider-name' parameter designates the OIDC configuration whose one of its identity mapping should align with the generated JWT claims. This input needs to align with the 'Provider Name' value established within the OIDC configuration in the JFrog Platform.
 3.  **Pass the 'oidc-audience' input to the Action (Optional)**: The 'oidc-audience' input defines the intended recipients of an ID token (JWT), ensuring access is restricted to authorized recipients for the JFrog Platform. By default, it contains the URL of the GitHub repository owner. It enforces a condition, allowing only workflows within the designated repository/organization to request an access token. Read more about it [here](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-audience-value).
@@ -201,6 +154,53 @@ Example step utilizing OpenID Connect:
 
 </details>
 
+<details>
+    <summary>Storing the connection details using single Config Token</summary>
+
+1. Make sure JFrog CLI is installed on your local machine by running `jf -v`.
+2. Configure the details of the JFrog platform by running `jf c add`.
+3. Export the details of the JFrog platform you configured, using the server ID you chose. Do this by running `jf c export <SERVER ID>`.
+4. Copy the generated Config Token to the clipboard and save it as a secret on GitHub.
+
+To use the saved JFrog platform configuration in the workflow, all you need to do it to expose the secret to the workflow.
+The secret should be exposed as an environment variable with the _JF*ENV*_ prefix.
+Here's how you do this:
+
+```yml
+- uses: jfrog/setup-jfrog-cli@v4
+  env:
+      JF_ENV_1: ${{ secrets.JF_SECRET_ENV_1 }}
+- run: |
+      # Ping the server
+      jf rt ping
+```
+
+As you can see in the example above, we created a secret named _JF_SECRET_ENV_1_ and exposed it to the workflow
+as the _JF_ENV_1_ environment variable. That's it - the ping command will now ping the configured Artifactory server.
+
+If you have multiple Config Tokens as secrets, you can use all of them in the workflow as follows:
+
+```yml
+- uses: jfrog/setup-jfrog-cli@v4
+  env:
+      JF_ENV_1: ${{ secrets.JF_SECRET_ENV_1 }}
+      JF_ENV_2: ${{ secrets.JF_SECRET_ENV_2 }}
+- run: |
+      # Set the utilized JFrog configuration by providing the server ID (configured by the 'jf c add' command).
+      jf c use local-1
+      # Ping local-1 Artifactory server
+      jf rt ping
+      # Now use the second sever configuration exposed to the Action.
+      jf c use local-2
+      # Ping local-2 Artifactory server
+      jf rt ping
+```
+
+| 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. |
+|------------------------------------------------------------------------------------------------------------------------------------------------------|
+
+</details>
+
 ## Setting the build name and build number when publishing build-info to Artifactory
 
 The Action automatically sets the following environment variables:
@@ -212,9 +212,9 @@ are registered as the build artifacts.
 
 ```yml
 - run: |
-      jf rt dl artifacts/
-      jf rt u aether artifacts/
-      jf rt bp
+      jf rt download "my-repo/artifacts/*" local-dir/
+      jf rt upload "local-dir/*" new-repo/my-artifacts/
+      jf build-publish
 ```
 
 You may override the default build name and number by setting the above variables in your workflow.
@@ -238,7 +238,7 @@ It is also possible to set the latest JFrog CLI version by adding the _version_
 ```
 
 | Important: Only JFrog CLI versions 1.46.4 or above are supported. |
-| ----------------------------------------------------------------- |
+|-------------------------------------------------------------------|
 
 ## Setting the JFrog project key
 
@@ -282,8 +282,6 @@ Here's how you do this:
           download-repository: jfrog-cli-remote
     ```
 
--   See instructions for configuring the JFrog connection details under [Storing JFrog connection details as secrets](#storing-jfrog-connection-details-as-secrets).
-
 ## JFrog Job Summary
 
 Jobs using this GitHub action will output a summary of some of the key commands that were performed using JFrog CLI.