regctl-installer GitHub Action

This GitHub Action enables you to interacting with remote images and registries using regctl. This action will verify the integrity of the regctl release during installation if you setup Cosign ahead of time (see examples below).

For a quick start guide on the usage of regctl, please refer to https://github.com/regclient/regclient/blob/main/docs/regctl.md. For available regctl releases, see https://github.com/regclient/regclient/releases.

---

• Tags
• Usage
• Inputs
• Examples
  • Pinned version
  • Default version
  • Authenicate on other registries
  • Automatic validation with Cosign

Tags

The following tags are available for the iarekylew00t/regctl-installer action.

• main
• <version> (eg: v1.0.1, including: v1.0, v1, etc.)

Usage

This action currently supports GitHub-provided Linux, macOS and Windows runners (self-hosted runners may not work).

Add the following entry to your Github workflow YAML file:

uses: iarekylew00t/regctl-installer@v1
with:
  regctl-release: v0.4.7 # optional

Inputs

input	Description	Default
regctl-release	regctl release version to be installed	latest
install-dir	directory to install regctl binary	$HOME/.regctl
username	username to use for GitHub authentication	${{ github.actor }}
token	token to use for GitHub authentication	${{ github.token }}

Examples

Pinned version

jobs:
  regctl:
    runs-on: ubuntu-latest
    steps:
      - name: Install regctl
        uses: iarekylew00t/regctl-installer@v1
        with:
          regctl-release: v0.4.7
      - name: Check install
        run: regctl version

Default version

jobs:
  regctl:
    runs-on: ubuntu-latest
    steps:
      - name: Install regctl
        uses: iarekylew00t/regctl-installer@v1
      - name: Check install
        run: regctl version

Authenticate on other registries

jobs:
  regctl:
    runs-on: ubuntu-latest
    steps:
      - uses: iarekylew00t/regctl-installer@v1
      - name: Login to Docker Hub
        run: |
          echo "${{ secrets.DOCKERHUB_TOKEN }}" | \
          regctl registry login docker.io \
            --user "${{ vars.DOCKERHUB_USERNAME }}" \
            --pass-stdin

Automatic validation with Cosign

jobs:
  regctl:
    runs-on: ubuntu-latest
    steps:
      - name: Install Cosign
        uses: sigstore/cosign-installer@v3.0.1
      - name: Install regctl
        uses: iarekylew00t/regctl-installer@v1
      - name: Check install
        run: regctl version

Contributing

Feel free to contribute and make things better by opening an Issue or Pull Request.

License

See LICENSE.