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 cloud (Artifactory). By default, it contains the URL of the GitHub repository owner. This value, if transmitted, will be used as an argument in core.getIDToken(), which generates the JWT. It enforces a condition, allowing only workflows within the designated repository/organization to access the cloud role. Read more about it here.

   - name: Install JFrog CLI
     uses: jfrog/setup-jfrog-cli@v3
     env:
       JF_URL: ${{ secrets.JF_URL }}
     with:
       oidc-provider-name: <Provider Name value given in step 1>
       oidc-audience: <URL to the intended audience>

The Action automatically sets the following environment variables: JFROG_CLI_BUILD_NAME and JFROG_CLI_BUILD_NUMBER with the workflow name and run number respectively. You therefore don't need to specify the build name and build number on any of the build related JFrog CLI commands.

In the following example, all downloaded files are registered as dependencies of the build and all uploaded files are registered as the build artifacts.

- run: |
    jf rt dl artifacts/
    jf rt u aether artifacts/
    jf rt bp

By default, the JFrog CLI version set in action.yml is used. To set a specific version, add the version input as follows:

- uses: jfrog/setup-jfrog-cli@v3
  with:
    version: X.Y.Z

It is also possible to set the latest JFrog CLI version by adding the version input as follows:

- uses: jfrog/setup-jfrog-cli@v3
  with:
    version: latest

If your agent has no Internet access, you can configure the workflow to download JFrog CLI from a remote repository in your JFrog Artifactory, which is configured to proxy the official download URL.

Here's how you do this:

1. Create a remote repository in Artifactory. Name the repository jfrog-cli-remote and set its URL to https://releases.jfrog.io/artifactory/jfrog-cli/
2. Set download-repository input to jfrog-cli-remote:

   - uses: jfrog/setup-jfrog-cli@v3
     env:
      # JFrog platform url (for example: https://acme.jfrog.io) 
       JF_URL: ${{ secrets.JF_URL }}
   
       # Basic authentication credentials
       JF_USER: ${{ secrets.JF_USER }}
       JF_PASSWORD: ${{ secrets.JF_PASSWORD }}
   
       # JFrog platform access token (if JF_USER and JF_PASSWORD are not provided)
       # JF_ACCESS_TOKEN: ${{ secrets.JF_ACCESS_TOKEN }}
   
       # Same can be achieved with a Config Token using JF_ENV_1 environment variable
       # JF_ENV_1: ${{ secrets.JF_SECRET_ENV_1 }}
     with:
       download-repository: jfrog-cli-remote

• See instructions for configuring the JFrog connection details under Storing JFrog connection details as secrets.

Need a FREE JFrog environment in the cloud to use with this GitHub Action? Just run one of the following commands in your terminal. The commands will do the following:

1. Install JFrog CLI on your machine.
2. Create a FREE JFrog environment in the cloud for you.

MacOS and Linux using cUrl

curl -fL "https://getcli.jfrog.io?setup" | sh

Windows using PowerShell

powershell "Start-Process -Wait -Verb RunAs powershell '-NoProfile iwr https://releases.jfrog.io/artifactory/jfrog-cli/v2-jf/[RELEASE]/jfrog-cli-windows-amd64/jf.exe -OutFile $env:SYSTEMROOT\system32\jf.exe'" ; jf setup

To help you get started, you can use these sample projects on GitHub.

If you'd like to help us develop and enhance this Action, this section is for you.

To build and run the Action tests, run

npm i && npm t

We welcome code contributions through pull requests.

Please help us enhance and improve this Action.

• If the existing tests do not already cover your changes, please add tests.
• Please run npm run format for formatting the code before submitting the pull request.

This Action is licensed under the Apache License 2.0.

• JFrog CLI Documentation
• GitHub Actions Documentation