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

Use a custom README file for the GitHub package rather than the main project README #1093

Closed
eguiraud opened this issue Apr 10, 2024 · 1 comment

Comments

@eguiraud
Copy link

Description

Hi,
we have a monorepo that produces several images and pushes them to the github registry.

They all pick up the main repository's readme, which gets displayed as the package's readme at https://github.com/project/packages.
It would be great if we could specify one readme per image, or if the action automatically picked up a README.md placed next to the dockerfile.

This is a continuation of as a continuation of #722 in which this part of the issue didn't get resolved.

@eguiraud eguiraud added kind/enhancement New feature or request status/triage labels Apr 10, 2024
@crazy-max
Copy link
Member

This is not something we control but GitHub. Atm it uses predefined OCI annotations to figure out from which repo it needs to take the README from: https://docs.github.com/en/packages/learn-github-packages/connecting-a-repository-to-a-package#connecting-a-repository-to-a-container-image-using-the-command-line

Don't think they have anything to specify its path though. Would suggest to open a thread in https://github.com/orgs/community/discussions/categories/packages

Thanks

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

No branches or pull requests

2 participants