No description

Find a file

Renovate f6fc2e2949 Some checks failed test actions / Test regctl install-3 (pull_request) Failing after 31s Details test actions / Test regctl install-4 (pull_request) Failing after 53s Details test actions / Test regctl install-5 (pull_request) Successful in 16s Details test actions / Test regctl install (pull_request) Has been cancelled Details test actions / Test regctl install-1 (pull_request) Has been cancelled Details test actions / Test regctl install-2 (pull_request) Has been cancelled Details test actions / Test regctl install-6 (pull_request) Has been cancelled Details test actions / Test regctl install-7 (pull_request) Has been cancelled Details test actions / Test regctl install-8 (pull_request) Has been cancelled Details Add renovate.json		2025-09-09 23:17:55 +01:00
.github	Version bump	2025-06-23 12:54:31 -04:00
regctl-installer	feat: Allow installing other binaries	2025-07-06 22:35:52 +01:00
regctl-login	Fix: Handle special characters in the inputs	2024-10-16 10:50:12 -04:00
.version-bump.lock	Version bump	2025-06-23 12:54:31 -04:00
.version-bump.yml	Version bump	2025-04-19 19:09:16 -04:00
CODE_OF_CONDUCT.md	Add contributing guidelines, templates, and security policy	2024-06-19 09:58:19 -04:00
CONTRIBUTING.md	Add contributing guidelines, templates, and security policy	2024-06-19 09:58:19 -04:00
LICENSE	Initial release	2022-06-05 19:34:08 -04:00
README.md	Version bump	2025-04-19 19:09:16 -04:00
renovate.json	Add renovate.json	2025-09-09 23:17:55 +01:00
SECURITY.md	Add contributing guidelines, templates, and security policy	2024-06-19 09:58:19 -04:00

README.md

regclient actions

This repo contains various GitHub actions for regclient.

regctl-install

This action installs the regctl binary.

regctl-install Usage

- name: Install regctl
  uses: regclient/actions/regctl-installer@main
  with:
    release: 'v0.4.7' # optional version

regctl-installer Inputs

The following inputs are available for regctl-installer:

Input	Description
`release`	`regctl` version to use. Defaults to `latest` (most recent release). Set to `main` to build the latest commit using `go install`.
`install-dir`	directory to place the `regctl` binary into instead of the default (`$HOME/.regctl/bin`).

If cosign is installed, signatures on downloaded binaries will be verified.

This action performs a login to a registry, similar to docker login.

- name: regctl login
  uses: regclient/actions/regctl-login@main

The following inputs are available for regctl-login:

Input	Description
`registry`	Registry to use. Defaults to `ghcr.io`. Use `docker.io` to login to Docker Hub.
`username`	Username for the login. Defaults to `${{ github.actor }}`.
`password`	Password for the login. Defaults to `${{ github.token }}`.

Examples

Install latest release:

jobs:
  example:
    runs-on: ubuntu-latest
    name: example
    steps:
      # if cosign is installed, signatures will be verified
      - name: Install cosign
        uses: sigstore/cosign-installer@main
      - name: Install regctl
        uses: regclient/actions/regctl-installer@main
      - name: regctl login
        uses: regclient/actions/regctl-login@main

Install from main branch using go install, and login to Docker Hub using a secret:

jobs:
  example:
    runs-on: ubuntu-latest
    name: example
    steps:
      - name: Set up Go
        uses: actions/setup-go@v5
      - name: Install cosign
        uses: sigstore/cosign-installer@main
      - name: Install regctl
        uses: regclient/actions/regctl-installer@main
        with:
          release: 'main'
      - name: regctl login
        uses: regclient/actions/regctl-login@main
        with:
          registry: docker.io
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}

Project Details

For more details on the regclient project, see regclient/regclient.