Skip to content

📖 Add description label to published container images#192

Merged
aquarion merged 1 commit into
mainfrom
ci/image-descriptions
Jul 10, 2026
Merged

📖 Add description label to published container images#192
aquarion merged 1 commit into
mainfrom
ci/image-descriptions

Conversation

@aquarion

Copy link
Copy Markdown
Owner

Fixes #160.

Summary

  • Non-prod images already get tagged staging on PR builds (ci.yml:100) — that part of the issue was already handled.
  • The missing piece: every image, prod or staging, inherited a generic repo-wide description from docker/metadata-action, so there was no way to tell which PR (or release) produced a given package version.
  • Override org.opencontainers.image.description per-build: staging builds link back to the originating PR (html_url, not the untrusted PR title), production builds name the release tag.

Test plan

  • After merge, open the next PR and confirm the staging-tagged package version on GHCR shows a description pointing at that PR
  • Confirm a production release build's package description names the release tag

Fixes #160. Non-prod images were already tagged `staging`, but every
image (prod and staging) inherited a generic repo-wide description
from docker/metadata-action, with no link back to the PR that built
it. Override org.opencontainers.image.description per-build: staging
builds point at the originating PR, production builds name the
release tag.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@aquarion aquarion marked this pull request as ready for review July 10, 2026 12:13
Copilot AI review requested due to automatic review settings July 10, 2026 12:13

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the container-image publishing workflow to set a per-build OCI image description so GHCR packages clearly indicate which PR (staging) or release tag (production) produced a given image.

Changes:

  • Overrides org.opencontainers.image.description during metadata extraction.
  • Uses the PR html_url (not PR title) for staging image descriptions, and the release tag/ref name for production.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@aquarion aquarion merged commit 639246f into main Jul 10, 2026
6 checks passed
@aquarion aquarion deleted the ci/image-descriptions branch July 10, 2026 12:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Images have no descriptions

2 participants