Skip to content
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

Add Open Container Image annotations as labels to the Docker image #5323

Merged
merged 1 commit into from
Oct 3, 2024

Conversation

forcalas
Copy link
Contributor

This PR introduces Open Container Image (OCI) format annotations as labels to the built Docker image.

By adding OCI-compliant annotations, we can embed information such as the source of the image, description, authorship, and versioning details directly within the image. This makes it easier to track the origin and intent of the image during distribution and use. Note that version has been omitted in this PR, since this information is not passed into the Dockerfile.

Key Benefits

  • Enhanced Metadata: The added labels include essential details like the image’s source repository, description, and version. This allows anyone inspecting the image to easily understand its purpose and origins.
  • Integration with Dependency Management Tools: Tools like Dependabot and Renovate will be able to recognise these labels and use them when opening PRs for dependency updates. This allows these tools to display detailed information about changes, making it easier for developers to assess the impact of updates.
  • Standardization: Following OCI standards ensures compatibility with a wide range of container registries and tools that expect this metadata, improving interoperability across different platforms.

By including this metadata directly within the Docker image, we are ensuring better visibility into its lifecycle, contributing to improved automation and monitoring in CI/CD pipelines and simplifying compliance with image management standards.

@feederbox826
Copy link
Contributor

Has to be below L21, you're writing it to the intermediary image

@forcalas forcalas force-pushed the oci-annotations branch 2 times, most recently from 90cbef6 to f7e3ff2 Compare October 1, 2024 06:03
@forcalas
Copy link
Contributor Author

forcalas commented Oct 1, 2024

You're right. It's fixed now

@WithoutPants WithoutPants added the chore Pull requests for refactoring and admin work label Oct 3, 2024
@WithoutPants WithoutPants merged commit 3e4515e into stashapp:develop Oct 3, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Pull requests for refactoring and admin work
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants