actions/setup-iq-cli/README.md

Sonatype CLI Setup Action

A GitHub Action for setting up Sonatype CLI as a tool that is available for GitHub runners and subsequent actions. The action downloads and configures the requested version of the Sonatype CLI.

Usage Example

Here's an example of how the setup action can be used in your code. Note that this is a prerequisite for the Run Sonatype CLI action provided in this action set.

name: Sonatype Workflow
on: push
jobs:
  sonatype-cli:
    runs-on: ubuntu-latest
    steps:
      - name: Setup Sonatype CLI
        uses: sonatype/actions/setup-iq-cli@v1
        with:
          iq-cli-version: 1.179.0-01

Alternatively, instead of providing iq-cli-version, you can provide the iq-cli-download-url parameter and optionally access credentials via the iq-cli-download-auth parameter. In this case, the Sonatype CLI JAR file will be downloaded from the specified location URL.

Parameters

iq-cli-version
Sonatype CLI version to be used. It could be a full version (e.g. 1.179.0-01), a short version (e.g. 179) or latest. Either this or iq-cli-download-url is required.

iq-cli-download-url
URL from where the IQ CLI jar file will be downloaded. Either this or iq-cli-version is required.

iq-cli-download-auth
Credentials for accessing the IQ CLI download URL. Format: username:password. Basic authentication is used.

Output

iq-cli-version
Semver valid version of the IQ CLI configured. It can be used as an input parameter for run-iq-cli.