Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iarekylew00t/crane-installer
📦 GitHub Action for installing the crane CLI tool
https://github.com/iarekylew00t/crane-installer
crane docker docker-registry github-actions setup-action typescript-action
Last synced: 2 months ago
JSON representation
📦 GitHub Action for installing the crane CLI tool
- Host: GitHub
- URL: https://github.com/iarekylew00t/crane-installer
- Owner: IAreKyleW00t
- License: apache-2.0
- Created: 2023-03-15T22:09:20.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T04:07:37.000Z (3 months ago)
- Last Synced: 2024-10-21T07:09:48.750Z (3 months ago)
- Topics: crane, docker, docker-registry, github-actions, setup-action, typescript-action
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/crane-installer
- Size: 888 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# 📦 crane-installer
[](https://github.com/IAreKyleW00t/crane-installer/actions/workflows/ci.yml)
[](https://github.com/IAreKyleW00t/crane-installer/actions/workflows/test.yml)
[](https://github.com/IAreKyleW00t/crane-installer/actions/workflows/check-dist.yml)
[](https://github.com/IAreKyleW00t/crane-installer/actions/workflows/codeql.yml)
[](https://github.com/marketplace/actions/crane-installer)
[](https://github.com/IAreKyleW00t/crane-installer/tags)
[](https://github.com/IAreKyleW00t/crane-installer/blob/main/LICENSE)
[](.github/dependabot.yml)
This Action downloads
[`crane`](https://github.com/google/go-containerregistry/tree/main/cmd/crane)
and adds it to your `PATH`, with optional signature verification if you use the
[SLSA Verifier](https://github.com/slsa-framework/slsa-verifier).
For a quick start guide on the usage of `crane`, refer to
[its documentation](https://github.com/google/go-containerregistry/blob/main/cmd/crane/recipes.md).
For available `crane` releases, refer to
[its releases](https://github.com/google/go-containerregistry/releases).
> This action supports Linux, macOS and Windows runners (results may vary with
> self-hosted runners).
## Quick Start
```yaml
- name: Install crane
uses: iarekylew00t/crane-installer@v3
```
## Usage
> [!NOTE]
>
> `slsa-verifier` must be in your `PATH` for signature verification or it will
> be skipped - See
> [Automatic verification with SLSA Verifier](#automatic-verification-with-slsa-verifier).
> If `crane` is loaded from cache it will **not** be re-verified.
## Inputs
| Name | Type | Description | Default |
| --------------- | ------- | ----------------------------------------- | --------------------- |
| `crane-release` | String | `crane` release version to be installed | `latest` |
| `verify` | Boolean | Perform signature verification on `crane` | `true` |
| `cache` | Boolean | Whether to utilize cache with `crane` | `true` |
| `token` | String | GitHub token for REST API access | `${{ github.token }}` |
### Outputs
| Name | Type | Description |
| ----------- | ------- | ---------------------------------------- |
| `version` | String | The version of `crane` the was installed |
| `cache-hit` | Boolean | If `crane` was installed via cache |
## Examples
### Pinned version
```yaml
- name: Install crane
uses: iarekylew00t/crane-installer@v3
with:
crane-release: v0.20.2
```
### Authenticate using Action
```yaml
- name: Install crane
uses: iarekylew00t/crane-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 `crane`
```yaml
- name: Install crane
uses: iarekylew00t/crane-installer@v3
- name: Login to DockerHub
run: |
echo "${{ secrets.DOCKERHUB_TOKEN }}" | \
crane auth login docker.io \
--user "${{ vars.DOCKERHUB_USERNAME }}" \
--pass-stdin
- name: Login to GHCR
run: |
echo "${{ github.token }}" | \
crane auth login ghcr.io \
--user "${{ github.actor }}" \
--pass-stdin
```
### Automatic verification with SLSA Verifier
```yaml
- name: Install SLSA verifier
uses: slsa-framework/slsa-verifier/actions/[email protected]
- name: Install crane
uses: iarekylew00t/crane-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`](https://github.com/IAreKyleW00t/crane-installer/actions/workflows/check-dist.yml)
> Workflow in any PR.
1. ⚙️ Install the version of [Node.js](https://nodejs.org/en) as defined in the
[`.node-version`](.node-version).
You can use [asdf](https://github.com/asdf-vm/asdf) to help manage your
project runtimes.
```sh
asdf plugin add nodejs https://github.com/asdf-vm/asdf-nodejs.git
asdf install
```
2. 🛠️ Install dependencies
```sh
npm install
```
3. 🏗️ Format, lint, test, and package your code changes.
```sh
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](https://github.com/IAreKyleW00t/crane-installer/actions) are
passing.
```sh
git checkout main
git pull
```
2. ✅ Ensure the [`package.json`](package.json#L4) and
[`package-lock.json`](package-lock.json#L3) files are updated to with the new
version being cut.
```sh
npm update
```
3. 🔖 Create a new Tag, push it up, then create a
[new Release](https://github.com/IAreKyleW00t/crane-installer/releases/new)
for the version.
```sh
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](https://github.com/IAreKyleW00t/crane-installer/actions/workflows/shared-tags.yml)
Workflows to update the `v$MAJOR` and `v$MAJOR.MINOR` tags.
## Contributing
Feel free to contribute and make things better by opening an
[Issue](https://github.com/IAreKyleW00t/crane-installer/issues) or
[Pull Request](https://github.com/IAreKyleW00t/crane-installer/pulls).
Thank you for your contribution! ❤️
## License
See
[LICENSE](https://github.com/IAreKyleW00t/crane-installer/blob/main/LICENSE).