Skip to content

Automated README Set based on Image Annotations or Labels #9

Description

@Vad1mo

Automated README Set from repo Annotations/Labels

docker-pushrm could read Annotations or Labels from images and use the provided URLs in the annotation or label to fetch the README content.

One of the tricky parts would be that fact that most README files in the corp env are not public, so simply calling http get won't do the trick. An easier and more common approch would be to use GIT + SSH key this setup is support basically everywhere.

Annotations or Labels Format Recommendations

https://docs.docker.com/config/labels-custom-metadata/#key-format-recommendations
https://github.com/opencontainers/image-spec/blob/master/annotations.md

Libs to fetch Image Metadata

https://github.com/containers/skopeo
https://github.com/containers/image

Edit:

In addition to that, especially in the first iteration it would be easier to implement only the use case where the Annotations/Labels is pointing to the README within the image itself.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions