https://github.com/stevenacoffman/setup-docker-credential-gcr
Github Action to Install docker-credential-gcr
https://github.com/stevenacoffman/setup-docker-credential-gcr
Last synced: about 1 year ago
JSON representation
Github Action to Install docker-credential-gcr
- Host: GitHub
- URL: https://github.com/stevenacoffman/setup-docker-credential-gcr
- Owner: StevenACoffman
- License: apache-2.0
- Created: 2024-02-01T21:55:17.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-11T20:57:01.000Z (over 1 year ago)
- Last Synced: 2025-03-15T05:37:49.829Z (about 1 year ago)
- Language: Go
- Size: 50.8 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Action to install and setup [docker-credential-gcr](https://github.com/GoogleCloudPlatform/docker-credential-gcr)
[](https://github.com/StevenACoffman/setup-docker-credential-gcr/actions/workflows/use-action.yaml)
This action will just install [docker-credential-gcr](https://github.com/GoogleCloudPlatform/docker-credential-gcr).
### What is docker-credential-gcr?
[docker-credential-gcr](https://github.com/GoogleCloudPlatform/docker-credential-gcr) [Google Container Registry](https://cloud.google.com/container-registry/)'s _standalone_, `gcloud` SDK-independent Docker credential helper. It allows for **v18.03+ Docker clients** to easily make authenticated requests to GCR's repositories (gcr.io, eu.gcr.io, etc.).
**Note:** `docker-credential-gcr` is primarily intended for users wishing to authenticate with GCR in the **absence of `gcloud`**, though they are [not mutually exclusive](#gcr-credentials). For normal development setups, users are encouraged to use [`gcloud auth configure-docker`](https://cloud.google.com/sdk/gcloud/reference/auth/configure-docker), instead.
The helper implements the [Docker Credential Store](https://docs.docker.com/engine/reference/commandline/login/#/credentials-store) API, but enables more advanced authentication schemes for GCR's users. In particular, it respects [Application Default Credentials](https://developers.google.com/identity/protocols/application-default-credentials) and is capable of generating credentials automatically (without an explicit login operation) when running in App Engine or Compute Engine.
For even more authentication options, see GCR's documentation on [advanced authentication methods](https://cloud.google.com/container-registry/docs/advanced-authentication).
## Example usage
```yaml
name: Publish
on:
push:
branches: ['main']
jobs:
publish:
name: Publish
runs-on: ubuntu-latest
steps:
- uses: actions/setup-go@v4
with:
go-version: '1.20.x'
- uses: actions/checkout@v3
- uses: StevenACoffman/setup-docker-credential-gcr@v0.0.3
- name: 'Configure GCP Artifact Registry'
run: docker-credential-gcr configure-docker --registries="us-central1-docker.pkg.dev"
```
_That's it!_ This workflow will install docker-credential-gcr so you can use ko or docker (or whatever).
You probably want to [set up Workload Identity](https://github.com/google-github-actions/auth#usage) between your GitHub Actions workflow and your GCP project.
### Select `docker-credential-gcr` version to install
By default, `setup-docker-credential-gcr` installs the [latest released version of `ko`](https://github.com/GoogleCloudPlatform/docker-credential-gcr/releases).
You can select a version with the `version` parameter:
```yaml
- uses: StevenACoffman/setup-docker-credential-gcr@v0.0.3
with:
version: v0.14.1
```
To build and install `docker-credential-gcr` from source using `go install`, specify `version: tip`.
```yaml
steps:
...
- uses: StevenACoffman/setup-docker-credential-gcr@v0.0.3
- name: 'Configure Docker Credentials for Artifact Registry'
run: |
docker-credential-gcr configure-docker --registries="us-central1-docker.pkg.dev"
```
### Why?
The `gcloud` CLI is great.
It's like a Swiss army knife for the cloud, if a knife could do anything to a cloud.
It does so much.
_It does soooo much!_
Too much.
This leads it to be really huge.
Hundreds of megabytes of sweet delicious Python.
Python that has to be interpreted before it can even start running anything.
If you're downloading and installing and running `gcloud` just to execute `docker-credential-gcr configure-docker ` so you can switch to using `ko` -- _especially_ in a CI environment -- you're wasting a lot of time.
Installing `gcloud` can take _minutes_, compared to just a few seconds with `setup-docker-credential-gcr`, even if you have to build it from source.