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

Closed
opened 2026-03-01 18:01:14 +03:00 by kerem · 0 comments
Owner

Original Pull Request: https://github.com/ArchiveBox/ArchiveBox/pull/1525

State: closed
Merged: Yes


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.

Related issues

None

Changes these areas

  • Bugfixes
  • Feature behavior
  • Command line interface
  • Configuration options
  • Internal architecture
  • Snapshot data layout on disk
**Original Pull Request:** https://github.com/ArchiveBox/ArchiveBox/pull/1525 **State:** closed **Merged:** Yes --- <!-- IMPORTANT: Do not submit PRs with only formatting / PEP8 / line length changes. --> # 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
kerem 2026-03-01 18:01:14 +03:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/ArchiveBox#2957
No description provided.