Setup GH CLI

A sample setup-gh tool Action that configures the GitHub CLI as a GitHub tool using Bash scripts.

This repository uses bash scripts to show how tools are "installed" on a GitHub runner. It demonstrates how to create a custom tool that downloads and verifies the GitHub CLI binary using a bash script, sha256sum (or shasum), curl, and grep.

Usage

The following parameters are supported:

• version - The version of the GH CLI to set up. Can specify latest or an exact version. Default: latest.

It returns the following outputs:

• path - The path to directory containing the GH CLI binary.
• version - The version of the CLI that was configured

The Action also publishes an environment variable, GH_VERSION that contains the tool version.

Basic Configuration

Typical setup

- uses: kenmuse/setup-gh@v1

or

- uses: kenmuse/setup-gh@v1
  with:
    version: 2.72.0

Tool path

The CLI is installed in the path ${RUNNER_TOOL_CACHE}/gh-cli/${VERSION}/${PLATFORM}. When the binary is successfully verified and unpacked to that folder, the marker file ${RUNNER_TOOL_CACHE}/gh-cli/${VERSION}/${PLATFORM} will be created to indicate success.