fix(ci): emit GHCR package description as index annotation#39
Merged
Conversation
GHCR shows "No description provided" on the package page because the description annotation only lives on the per-platform manifests, not on the multi-arch index. The package UI reads from the index level. `docker/metadata-action` controls which manifest levels get annotations via the `DOCKER_METADATA_ANNOTATIONS_LEVELS` env var. Default is `manifest` only; setting it to `manifest,index` adds the second level. We also have to forward the resulting annotation list through `docker/build-push-action`'s `annotations:` input — the action doesn't pick it up implicitly. After this change the next docker-publish run will produce manifest indexes with annotations on both levels, and GHCR's package page will display the description without further intervention.
|
Note Gemini is unable to generate a summary for this pull request due to the file types involved not being currently supported. |
There was a problem hiding this comment.
Pull request overview
Updates the Docker publish workflow so GHCR package pages display the intended OCI description by ensuring the org.opencontainers.image.description annotation is applied to the multi-arch image index (not just per-platform manifests).
Changes:
- Configure
docker/metadata-actionto emit annotations for bothmanifestandindexlevels viaDOCKER_METADATA_ANNOTATIONS_LEVELS. - Forward
steps.meta.outputs.annotationsintodocker/build-push-actionso buildx actually applies those index annotations during push.
7 tasks
github-actions Bot
pushed a commit
that referenced
this pull request
May 11, 2026
## <small>0.2.1 (2026-05-11)</small> * fix(ci): emit GHCR package description as index annotation (#39) ([12c6b6c](12c6b6c)), closes [#39](#39) * fix(ci): lowercase image ref before push-by-digest (#41) ([9dd954e](9dd954e)), closes [#41](#41) * fix(ci): repair docker-publish.yml startup failure (#37) ([fb7cb59](fb7cb59)), closes [#37](#37) * fix(ci): repair Verify multi-arch manifest step + drop fail-fast (#38) ([5d2ff7d](5d2ff7d)), closes [#38](#38) * refactor(ci): split docker-publish into native-arch matrix + manifest merge (#40) ([8cd824d](8cd824d)), closes [#40](#40) * chore(deps): bump github.com/go-chi/chi/v5 from 5.1.0 to 5.2.2 in /frontend (#36) ([a5971b9](a5971b9)), closes [#36](#36) [skip ci]
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The problem
GHCR shows "No description provided" on the package pages for both
label-printer-hub-backendandlabel-printer-hub-frontend, even thoughdocker/metadata-actionis configured withlabels: org.opencontainers.image.description=….Why
The description labels are baked into each per-platform image manifest, but GHCR's package UI reads the description from a separate place: the
org.opencontainers.image.descriptionannotation on the multi-arch manifest index (the OCI image-index that points at the per-arch manifests).docker/metadata-actiondecides which manifest levels to annotate via theDOCKER_METADATA_ANNOTATIONS_LEVELSenv var. Its default ismanifestonly, so the index never gets annotated — hence the empty GHCR page.Quote from a previous run's logs (run 25638802588):
→ Only
manifest:, noindex:.The fix
Two small changes to
.github/workflows/docker-publish.yml:DOCKER_METADATA_ANNOTATIONS_LEVELS: manifest,index— tellsmetadata-actionto emit annotations for both levels.annotations: \${{ steps.meta.outputs.annotations }}— forwards the resulting list tobuild-push-action, which translates it into--annotation manifest:* --annotation index:*calls on the underlying buildx invocation.Verification (after merge)
Should show
org.opencontainers.image.descriptionpopulated on the index.GHCR package page will then display the description automatically — no further config needed.
Test plan