{"id":15750656,"url":"https://github.com/iarekylew00t/regctl-installer","last_synced_at":"2026-04-11T00:02:30.405Z","repository":{"id":155772439,"uuid":"614663574","full_name":"IAreKyleW00t/regctl-installer","owner":"IAreKyleW00t","description":"📦 GitHub Action for installing the regctl CLI tool","archived":false,"fork":false,"pushed_at":"2025-03-11T22:05:09.000Z","size":3512,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-11T22:29:43.156Z","etag":null,"topics":["docker","docker-registry","github-actions","regclient","regctl","setup-action","typescript-action"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/regctl-installer","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IAreKyleW00t.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-16T03:47:31.000Z","updated_at":"2025-03-11T22:02:11.000Z","dependencies_parsed_at":"2023-11-08T06:44:39.499Z","dependency_job_id":"ad42c335-9741-456f-b774-5a40fead43dc","html_url":"https://github.com/IAreKyleW00t/regctl-installer","commit_stats":{"total_commits":99,"total_committers":2,"mean_commits":49.5,"dds":0.4242424242424242,"last_synced_commit":"e1b9e3a3c4f4e114b8751abeb363428c9a13afb3"},"previous_names":[],"tags_count":53,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IAreKyleW00t%2Fregctl-installer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IAreKyleW00t%2Fregctl-installer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IAreKyleW00t%2Fregctl-installer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IAreKyleW00t%2Fregctl-installer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IAreKyleW00t","download_url":"https://codeload.github.com/IAreKyleW00t/regctl-installer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243422866,"owners_count":20288538,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-registry","github-actions","regclient","regctl","setup-action","typescript-action"],"created_at":"2024-10-04T06:41:40.771Z","updated_at":"2026-02-03T06:21:48.052Z","avatar_url":"https://github.com/IAreKyleW00t.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 📦 regctl-installer\n\n[![CI](https://github.com/IAreKyleW00t/regctl-installer/actions/workflows/ci.yml/badge.svg)](https://github.com/IAreKyleW00t/regctl-installer/actions/workflows/ci.yml)\n[![Tests](https://github.com/IAreKyleW00t/regctl-installer/actions/workflows/test.yml/badge.svg)](https://github.com/IAreKyleW00t/regctl-installer/actions/workflows/test.yml)\n[![Check dist/](https://github.com/IAreKyleW00t/regctl-installer/actions/workflows/check-dist.yml/badge.svg)](https://github.com/IAreKyleW00t/regctl-installer/actions/workflows/check-dist.yml)\n[![CodeQL](https://github.com/IAreKyleW00t/regctl-installer/actions/workflows/codeql.yml/badge.svg)](https://github.com/IAreKyleW00t/regctl-installer/actions/workflows/codeql.yml)  \n[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-regctl--installer-blue?style=flat\u0026logo=github)](https://github.com/marketplace/actions/regctl-installer)\n[![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/IAreKyleW00t/regctl-installer?style=flat\u0026label=Latest%20Version\u0026color=blue)](https://github.com/IAreKyleW00t/regctl-installer/tags)\n[![License](https://img.shields.io/github/license/IAreKyleW00t/regctl-installer?label=License)](https://github.com/IAreKyleW00t/regctl-installer/blob/main/LICENSE)\n[![Dependabot](https://img.shields.io/badge/Dependabot-0366d6?style=flat\u0026logo=dependabot\u0026logoColor=white)](.github/dependabot.yml)\n\nThis Action downloads [`regctl`](https://github.com/regclient/regclient) and\nadds it to your `PATH`, with optional signature verification if you use\n[Cosign](https://github.com/sigstore/cosign).\n\nFor a quick start guide on the usage of `regctl`, refer to\n[its documentation](https://github.com/regclient/regclient/blob/main/docs/regctl.md).\n\nFor available `regctl` releases, refer to\n[its releases](https://github.com/regclient/regclient/releases).\n\n\u003e This action supports Linux, macOS and Windows runners (results may vary with\n\u003e self-hosted runners).\n\n## Quick Start\n\n```yaml\n- name: Install regctl\n  uses: iarekylew00t/regctl-installer@v4\n```\n\n## Usage\n\n\u003e [!NOTE]\n\u003e\n\u003e `cosign` must be in your `PATH` for signature verification or it will be\n\u003e skipped - See\n\u003e [Automatic verification with Cosign](#automatic-verification-with-cosign). If\n\u003e `regctl` is loaded from cache it will **not** be re-verified.\n\n### Inputs\n\n| Name             | Type    | Description                                | Default               |\n| ---------------- | ------- | ------------------------------------------ | --------------------- |\n| `regctl-release` | String  | `regctl` release version to be installed   | `latest`              |\n| `verify`         | Boolean | Perform signature verification on `regctl` | `true`                |\n| `cache`          | Boolean | Whether to utilize cache with `regctl`     | `true`                |\n| `token`          | String  | GitHub token for REST API access           | `${{ github.token }}` |\n\n### Outputs\n\n| Name        | Type    | Description                               |\n| ----------- | ------- | ----------------------------------------- |\n| `version`   | String  | The version of `regctl` the was installed |\n| `cache-hit` | Boolean | If `regctl` was installed via cache       |\n\n## Examples\n\n### Pinned version\n\n```yaml\n- name: Install regctl\n  uses: iarekylew00t/regctl-installer@v4\n  with:\n    regctl-release: v0.7.1\n```\n\n### Authenticate using Action\n\n```yaml\n- name: Install regctl\n  uses: iarekylew00t/regctl-installer@v4\n\n- name: Login to DockerHub\n  uses: docker/login-action@v3\n  with:\n    username: ${{ secrets.DOCKERHUB_USERNAME }}\n    password: ${{ secrets.DOCKERHUB_TOKEN }}\n\n- name: Login to GHCR\n  uses: docker/login-action@v3\n  with:\n    registry: ghcr.io\n    username: ${{ github.actor }}\n    password: ${{ github.token }}\n```\n\n### Authenticate using `regctl`\n\n```yaml\n- name: Install regctl\n  uses: iarekylew00t/regctl-installer@v4\n\n- name: Login to DockerHub\n  run: |\n    echo \"${{ secrets.DOCKERHUB_TOKEN }}\" | \\\n    regctl registry login docker.io \\\n      --user \"${{ vars.DOCKERHUB_USERNAME }}\" \\\n      --pass-stdin\n\n- name: Login to GHCR\n  run: |\n    echo \"${{ github.token }}\" | \\\n    regctl registry login ghcr.io \\\n      --user \"${{ github.actor }}\" \\\n      --pass-stdin\n```\n\n### Automatic verification with Cosign\n\n```yaml\n- name: Install Cosign\n  uses: sigstore/cosign-installer@v3.6.0\n\n- name: Install regctl\n  uses: iarekylew00t/regctl-installer@v4\n```\n\n## Development\n\n\u003e [!CAUTION]\n\u003e\n\u003e Since this is a TypeScript action you **must** transpile it into native\n\u003e JavaScript. This is done for you automatically as part of the `npm run all`\n\u003e command and will be validated via the\n\u003e [`check-dist.yml`](https://github.com/IAreKyleW00t/regctl-installer/actions/workflows/check-dist.yml)\n\u003e Workflow in any PR.\n\n1. ⚙️ Install the version of [Node.js](https://nodejs.org/en) as defined in the\n   [`.tool-versions`](.tool-versions).  \n   You can use [asdf](https://github.com/asdf-vm/asdf) to help manage your\n   project runtimes.\n\n   ```sh\n   asdf plugin add nodejs https://github.com/asdf-vm/asdf-nodejs.git\n   asdf install\n   ```\n\n2. 🛠️ Install dependencies\n\n   ```sh\n   npm install\n   ```\n\n3. 🏗️ Format, lint, test, and package your code changes.\n\n   ```sh\n   npm run all\n   ```\n\n## Releases\n\nFor maintainers, the following release process should be used when cutting new\nversions.\n\n1. ⏬ Pull down the latest changes and ensure all\n   [Workflows](https://github.com/IAreKyleW00t/regctl-installer/actions) are\n   passing.\n\n   ```sh\n   git checkout main\n   git pull\n   ```\n\n2. ✅ Bump the package version.\n\n   ```sh\n   npm version \u003cmajor|minor|patch\u003e -m \"chore: Bumping version to vX.Y.Z\"\n   ```\n\n3. 🔖 Create a new Tag, push it up, then create a\n   [new Release](https://github.com/IAreKyleW00t/regctl-installer/releases/new)\n   for the version.\n\n   ```sh\n   git tag vX.Y.Z\n   git push -u origin vX.Y.Z\n   ```\n\n   Alternatively you can create the Tag on the GitHub Release page itself.\n\n   When the tag is pushed it will kick off the\n   [Shared Tags](https://github.com/IAreKyleW00t/regctl-installer/actions/workflows/shared-tags.yml)\n   Workflows to update the `v$MAJOR` and `v$MAJOR.MINOR` tags.\n\n## Contributing\n\nFeel free to contribute and make things better by opening an\n[Issue](https://github.com/IAreKyleW00t/regctl-installer/issues) or\n[Pull Request](https://github.com/IAreKyleW00t/regctl-installer/pulls).  \nThank you for your contribution! ❤️\n\n## License\n\nSee\n[LICENSE](https://github.com/IAreKyleW00t/regctl-installer/blob/main/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiarekylew00t%2Fregctl-installer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiarekylew00t%2Fregctl-installer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiarekylew00t%2Fregctl-installer/lists"}