Skip to content

ci: Add docker labels #771

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

halkeye
Copy link
Contributor

@halkeye halkeye commented Jun 2, 2025

What kind of change does this PR introduce?

CI/Docker Image

Why was this change needed?

Tools like renovate and dependabot will show changelogs based on docker images. By having the opencontainer labels, PRs should include what changed since last docker deploy

Other information:

docker/metadata-action is a much better solution to make sure the image is populated with the right tags, but it involves some changes to the build script.

As a plan B, I would be up for updating the build scripts to be more like https://docs.docker.com/build/ci/github-actions/multi-platform/ (I could also update it to handle on push, so #704 could have forks build a docker image on prs, and docker image for dependabot prs on this repo)

Testable via docker inspect, or my preference regctl

regctl image config --format '{{ jsonPretty .Config.Labels }}' ghcr.io/gitroomhq/postiz-app:v1.45.1                              
null

vs

regctl image config --format '{{ jsonPretty .Config.Labels }}' ghcr.io/advplyr/audiobookshelf
{
  "org.opencontainers.image.created": "2025-06-01T21:31:28.515Z",
  "org.opencontainers.image.description": "Self-hosted audiobook and podcast server",
  "org.opencontainers.image.licenses": "GPL-3.0",
  "org.opencontainers.image.revision": "c377b57601f82f76d677b09e6bbabda732c18861",
  "org.opencontainers.image.source": "https://github.com/advplyr/audiobookshelf",
  "org.opencontainers.image.title": "audiobookshelf",
  "org.opencontainers.image.url": "https://github.com/advplyr/audiobookshelf",
  "org.opencontainers.image.version": "2.24.0"
}

Checklist:

Put a "X" in the boxes below to indicate you have followed the checklist;

  • I have read the CONTRIBUTING guide.
  • I checked that there were not similar issues or PRs already open for this.
  • This PR fixes just ONE issue (do not include multiple issues or types of change in the same PR) For example, don't try and fix a UI issue and include new dependencies in the same PR.

Summary by CodeRabbit

  • Chores
    • Enhanced container image metadata by adding version, revision, and source labels to Docker builds. This improves traceability of built images.

Copy link

vercel bot commented Jun 2, 2025

@halkeye is attempting to deploy a commit to the Listinai Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

coderabbitai bot commented Jun 2, 2025

Walkthrough

The Docker build process in the GitHub Actions workflow was updated to include three OCI-compliant labels: image version with architecture, Git commit SHA, and repository URL. These metadata labels are now added during the image build without affecting other build parameters or logic.

Changes

File(s) Change Summary
.github/workflows/build-containers.yml Added OCI-compliant labels (version, revision, source) to Docker image build command.

Possibly related PRs

Poem

🐇
Labels added, neat and clear,
Version, source, and SHA appear.
In the Docker build they stay,
Guiding rabbits on their way.
Metadata hops along,
In containers, strong and strong!


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
.github/workflows/build-containers.yml (2)

59-61: Consider enriching OCI metadata with additional labels
Great addition of org.opencontainers.image.version, org.opencontainers.image.revision, and org.opencontainers.image.source. To maximize compatibility with OCI-aware tools and provide richer context, you may also want to include these standard labels:

  • org.opencontainers.image.created (build timestamp)
  • org.opencontainers.image.title / org.opencontainers.image.description
  • org.opencontainers.image.licenses
  • org.opencontainers.image.revision (already present)

Adding these will improve discoverability and auditing of your images.


52-63: Evaluate using docker/metadata-action for label management
Inline labels work well, but for long-term maintainability and consistency, consider switching to docker/metadata-action. It can automatically generate and apply standard OCI labels and tags based on your workflow inputs—reducing custom shell logic and keeping your CI pipeline simpler.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8fe70bb and 69111ff.

📒 Files selected for processing (1)
  • .github/workflows/build-containers.yml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build-and-publish

@halkeye
Copy link
Contributor Author

halkeye commented Jun 2, 2025

Inline labels work well, but for long-term maintainability and consistency, consider switching to docker/metadata-action. It can automatically generate and apply standard OCI labels and tags based on your workflow inputs—reducing custom shell logic and keeping your CI pipeline simpler.

yay ai agrees with me

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.

1 participant