Add OpenContainer Image Format Annotations as Labels to Docker Image #1525
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.
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