Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
package

GitHub Action

regctl-installer

v3.0.9

regctl-installer

package

regctl-installer

GitHub Action for installing the regctl CLI tool

Installation

Copy and paste the following snippet into your .yml file.

              

- name: regctl-installer

uses: IAreKyleW00t/regctl-installer@v3.0.9

Learn more about this action in IAreKyleW00t/regctl-installer

Choose a version

📦 regctl-installer

CI Tests Check dist/ CodeQL
GitHub Marketplace GitHub tag (latest SemVer) License Dependabot

This Action downloads regctl and adds it to your PATH, with optional signature verification if you use Cosign.

For a quick start guide on the usage of regctl, refer to its documentation.

For available regctl releases, refer to its releases.

This action supports Linux, macOS and Windows runners (results may vary with self-hosted runners).

Quick Start

- name: Install regctl
  uses: iarekylew00t/regctl-installer@v3

Usage

Note

cosign must be in your PATH for signature verification or it will be skipped - See Automatic verification with Cosign.

Inputs

Name Type Description Default
regctl-release String regctl release version to be installed latest
verify Boolean Perform signature verification on regctl true
cache Boolean Whether to utilize cache with regctl true
token String GitHub token for REST API access ${{ github.token }}

Outputs

Name Type Description
version String The version of regctl the was installed
cache-hit Boolean If regctl was installed via cache

Examples

Pinned version

- name: Install regctl
  uses: iarekylew00t/regctl-installer@v3
  with:
    regctl-release: v0.7.1

Authenticate using Action

- name: Install regctl
  uses: iarekylew00t/regctl-installer@v3

- name: Login to DockerHub
  uses: docker/login-action@v3
  with:
    username: ${{ secrets.DOCKERHUB_USERNAME }}
    password: ${{ secrets.DOCKERHUB_TOKEN }}

- name: Login to GHCR
  uses: docker/login-action@v3
  with:
    registry: ghcr.io
    username: ${{ github.actor }}
    password: ${{ github.token }}

Authenticate using regctl

- name: Install regctl
  uses: iarekylew00t/regctl-installer@v3

- name: Login to DockerHub
  run: |
    echo "${{ secrets.DOCKERHUB_TOKEN }}" | \
    regctl registry login docker.io \
      --user "${{ vars.DOCKERHUB_USERNAME }}" \
      --pass-stdin

- name: Login to GHCR
  run: |
    echo "${{ github.token }}" | \
    regctl registry login ghcr.io \
      --user "${{ github.actor }}" \
      --pass-stdin

Automatic verification with Cosign

- name: Install Cosign
  uses: sigstore/cosign-installer@v3.6.0

- name: Install regctl
  uses: iarekylew00t/regctl-installer@v3

Development

Caution

Since this is a TypeScript action you must transpile it into native JavaScript. This is done for you automatically as part of the npm run all command and will be validated via the check-dist.yml Workflow in any PR.

  1. ⚙️ Install the version of Node.js as defined in the .node-version.
    You can use asdf to help manage your project runtimes.

    asdf plugin add nodejs https://github.com/asdf-vm/asdf-nodejs.git
    asdf install
  2. 🛠️ Install dependencies

    npm install
  3. 🏗️ Format, lint, test, and package your code changes.

    npm run all

Releases

For maintainers, the following release process should be used when cutting new versions.

  1. ⏬ Ensure all changes are in the main branch and all necessary Workflows are passing.

    git checkout main
    git pull
  2. ✅ Ensure the package.json and package-lock.json files are updated to with the new version being cut.

    npm update
  3. 🔖 Create a new Tag, push it up, then create a new Release for the version.

    git tag v1.2.3
    git push -u origin v1.2.3

    Alternatively you can create the Tag on the GitHub Release page itself.

    When the tag is pushed it will kick off the Shared Tags Workflows to update the v$MAJOR and v$MAJOR.MINOR tags.

Contributing

Feel free to contribute and make things better by opening an Issue or Pull Request.
Thank you for your contribution! ❤️

License

See LICENSE.