shrink / actions-docker-registry-tag

:whale: Add many tags to an image in a Docker Registry

Docker Registry Tag

A GitHub Action for adding many tags to an existing image in a Docker Registry without changing the digest, using Docker Registry API V2.

- uses: shrink/actions-docker-registry-tag@v4
  with:
    registry: ghcr.io
    repository: ${{ github.repository }}
    target: sha-${{ github.sha }}
    tags: |
      v1.0.0
      latest

📦 Automatic Release Packaging is used by this action, please reference by tag or commit hash in your Workflows.

Inputs

Token is an optional input for GitHub's Container Registry. Ensure the Actions token has permission to write to the package repository by granting access as described in "About GitHub Packages with GitHub Actions".

ID	Description	Examples
registry	Registry API root domain	ghcr.io index.docker.io
token	Bearer token for the Registry API	${{ secrets.DOCKER_KEY }}
repository	Image repository name	shrink/example
target	Tag of the existing image	branch-name sha-1150f2f
tags	Tag(s) to add to the target (new-line delimited)	v1.0.1 latest

Outputs

No outputs.

Examples

Tag Image with Semantic Version

Add Semantic Version tag to a commit's image in registry when a new tag is pushed to the repository. The target image is assumed to have been tagged with sha-${{ github.sha }} on build.

name: Tag Image With Version

on:
  push:
    tags:
      - 'v*.*.*'

jobs:
  add-version-tag:
    runs-on: ubuntu-latest
    steps:
      - id: version
        uses: battila7/get-version-action@v2
      - name: Add Semantic Version tag to Docker Image
        uses: shrink/actions-docker-registry-tag@v4
        with:
          registry: ghcr.io
          repository: '${{ github.repository }}'
          target: 'sha-${{ github.sha }}'
          tags: '${{ steps.version.outputs.version }}'

Automatic Release Packaging

Packaging (creation of dist) happens automatically when a new tag is created. Any reference to this Action in a Workflow must use a tag (mutable) or the commit hash of a tag (immutable).

✅ uses: shrink/actions-docker-registry-tag@v4
✅ uses: shrink/[email protected]
✅ uses: shrink/actions-docker-registry-tag@57e97909852876c02080eff4d73b2e5e779b845b
❌ uses: shrink/actions-docker-registry-tag@main

The blog post Package GitHub Actions automatically with GitHub Actions describes how this achieved.

actions-docker-registry-tag's Issues

Add complete examples to README

• How to retag with multiple semver aliases
• How to retag on git tag

Document tag edge-cases

Specifically I'm wondering:
Will adding tags replace existing tags on an image?
Will adding an existing tag fail?

Multi-architecture images cannot be re-tagged

This action works by downloading a digest for a tag and then uploading it again to a different tag, however multi-architecture images do not return a digest to the API call: they return a list (application/vnd.docker.distribution.manifest.list.v2+json). Docker's Registry v2 API does not currently support pushing a list of digests to a tag, we must push each tag individually.

Report errors returned in JSON response

As documented here the server returns error messages in the JSON response body. These should be reported to the user in addition to the generic failure message (<repository:tag> could not be tagged with <tag>).

Fix failing tests (due to changed NodeJS version?)

I guess ubuntu-latest has changed its NodeJS version.

https://github.com/shrink/actions-docker-registry-tag/actions/runs/4314123335

• Fix the error
• Set up alerts so I am notified when the tests fail

Rename `action` branch to `main`

Support OCI archives in registry

If an OCI image archive is in a registry, a request must explicitly opt-in to receive information about it by including it in the header.

Accept: application/vnd.oci.image.manifest.v1+json

• Add debugging output when a request to the registry fails
• Find out which accept headers are required to support all images
• Add accept header for each of the above

Tests are failing due to an expired Personal Access Token

e.g: https://github.com/shrink/actions-docker-registry-tag/runs/3859240293?check_suite_focus=true

denied: permission_denied: write_package
Error: Process completed with exit code 1.

GitHub Package Registry now allows for repositories to be granted access to read and write to a Package, so the token hack is no longer required.

• Remove use of Personal Access Token
• Investigate why the failing Workflows did not send a notification

Node 12 deprecation

Node 12 is out of support and deprecated by GitHub Actions with an end date of summer 2023. As of at least 2022-10-13 there have been deprecation warnings around using this Action. I'm hoping you upgrade. Thanks! :)

GitHub Release
https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/

Deprecation warning:
Node.js 12 actions are deprecated. For more information see: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/. Please update the following actions to use Node.js 16: shrink/actions-docker-registry-tag, actions/checkout

Remove `registry` from `repository` if included

Sometimes a user might not have the cleanest of input, i.e: they may have a full repository path (ghcr.io/shrink/example-image) and so when they provide registry or repository this action should identify that case and sanitise the input, so that user sdo not need to implement their own separate input validation.

Document how to obtain a Bearer token for Docker Hub

This may require an additional action, because it looks like the only way to generate a valid token is with an API request, the Docker Hub Personal Access Tokens do not seem to grant API access, they're just revokable passwords.

Integration tests failing: unsupported MIME type

Started failing a few weeks ago without any changes to the action so the issue is likely outside of the action.

unsupported MIME type for compression: application/vnd.in-toto+json

https://github.com/shrink/actions-docker-registry-tag/actions/runs/7347727035/job/20004627646

Error message referenced in containers/skopeo#2174 and the timeline lines up so likely the same issue.

update from node 16 to 20

Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: shrink/actions-docker-registry-tag@v3. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/.