[PR #1525] [MERGED] Add OpenContainer Image Format Annotations as Labels to Docker Image #1444

New issue

Closed

opened 2026-03-01 14:49:49 +03:00 by kerem · 0 comments

kerem commented

2026-03-01 14:49:49 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/ArchiveBox/ArchiveBox/pull/1525
Author: @mpgirro
Created: 9/26/2024
Status: ✅ Merged
Merged: 9/26/2024
Merged by: @pirate

Base: dev ← Head: oci-image-source

📝 Commits (1)

4d6fdbe Add OpenContainer Image Format Annotations as Labels to Docker Image

📊 Changes

1 file changed (+1 additions, -0 deletions)

View changed files

📝 .github/workflows/docker.yml (+1 -0)

📄 Description

Summary

This PR introduces OpenContainer (OCI) image format annotations as labels to our built Docker images. The labels are automatically extracted using the Docker Metadata Action in the GitHub Action workflow, ensuring consistent and accurate metadata is applied to the image during the build process.

Key Benefits

Automated Metadata Generation: The Docker Metadata Action automatically extracts relevant information such as the image’s title, description, source, version, revision, and more. This eliminates manual intervention and ensures the labels remain accurate and up-to-date with each build.
Enhanced Metadata: All labels from the Docker Metadata Action are added, providing comprehensive details about the image. This includes:
- org.opencontainers.image.title
- org.opencontainers.image.description
- org.opencontainers.image.version
- org.opencontainers.image.url
- org.opencontainers.image.source
- org.opencontainers.image.revision
- org.opencontainers.image.created
- org.opencontainers.image.licenses
Integration with Dependency Management Tools: Tools like Dependabot and Renovate will be able to recognize these labels and use them when opening PRs for dependency updates. This allows these tools to show detailed information about image changes, making it easier for developers to evaluate the impact of updates.
Standardization: By adhering to OCI standards and adding all relevant labels, the Docker image becomes more interoperable with various container registries and tools, improving compatibility and usability across different platforms.

This automated process ensures better visibility into the image lifecycle and simplifies maintenance in CI/CD pipelines, aligning the project with best practices for container image management.

None

Changes these areas

Bugfixes
Feature behavior
Command line interface
Configuration options
Internal architecture
Snapshot data layout on disk

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/ArchiveBox/ArchiveBox/pull/1525 **Author:** [@mpgirro](https://github.com/mpgirro) **Created:** 9/26/2024 **Status:** ✅ Merged **Merged:** 9/26/2024 **Merged by:** [@pirate](https://github.com/pirate) **Base:** `dev` ← **Head:** `oci-image-source` --- ### 📝 Commits (1) - [`4d6fdbe`](https://github.com/ArchiveBox/ArchiveBox/commit/4d6fdbe345f03369cfeac07ef86ec75f2a94e478) Add OpenContainer Image Format Annotations as Labels to Docker Image ### 📊 Changes **1 file changed** (+1 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `.github/workflows/docker.yml` (+1 -0) </details> ### 📄 Description  # Summary This PR introduces [OpenContainer (OCI)](https://opencontainers.org) image format [annotations](https://specs.opencontainers.org/image-spec/annotations/) as labels to our built Docker images. The labels are automatically extracted using the [Docker Metadata Action](https://github.com/docker/metadata-action) in the GitHub Action workflow, ensuring consistent and accurate metadata is applied to the image during the build process. # Key Benefits - __Automated Metadata Generation__: The Docker Metadata Action automatically extracts relevant information such as the image’s title, description, source, version, revision, and more. This eliminates manual intervention and ensures the labels remain accurate and up-to-date with each build. - __Enhanced Metadata__: All labels from the Docker Metadata Action are added, providing comprehensive details about the image. This includes: - `org.opencontainers.image.title` - `org.opencontainers.image.description` - `org.opencontainers.image.version` - `org.opencontainers.image.url` - `org.opencontainers.image.source` - `org.opencontainers.image.revision` - `org.opencontainers.image.created` - `org.opencontainers.image.licenses` - __Integration with Dependency Management Tools__: Tools like [Dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide) and [Renovate](https://docs.renovatebot.com) will be able to recognize these labels and use them when opening PRs for dependency updates. This allows these tools to show detailed information about image changes, making it easier for developers to evaluate the impact of updates. - __Standardization__: By adhering to OCI standards and adding all relevant labels, the Docker image becomes more interoperable with various container registries and tools, improving compatibility and usability across different platforms. This automated process ensures better visibility into the image lifecycle and simplifies maintenance in CI/CD pipelines, aligning the project with best practices for container image management. # Related issues None # Changes these areas - [ ] Bugfixes - [ ] Feature behavior - [ ] Command line interface - [x] Configuration options - [ ] Internal architecture - [ ] Snapshot data layout on disk --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>