How to Specify a Separate README for a GitHub Container Registry Package

[mo-dkrz]

Select Topic Area

Bug

Body

I'm using ghcr to publish my container images, and I noticed that the README displayed on the package page is pulled from the repository's main README.md by default.
Is there a way to specify a different README for a specific package in GHCR, rather than using the main repository README? For example, can I define a separate README file and have it shown on the package page instead?
I’d appreciate any insights or workarounds if this is possible.
Thanks

[github-actions[bot]]

💬 Your Product Feedback Has Been Submitted 🎉

Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users.

Here's what you can expect moving forward ⏩

• Your input will be carefully reviewed and cataloged by members of our product teams. 
  • Due to the high volume of submissions, we may not always be able to provide individual responses.
  • Rest assured, your feedback will help chart our course for product improvements.
• Other users may engage with your post, sharing their own perspectives or experiences. 
• GitHub staff may reach out for further clarification or insight. 
  • We may 'Answer' your discussion if there is a current solution, workaround, or roadmap/changelog post related to the feedback.

Where to look to see what's shipping 👀

• Read the Changelog for real-time updates on the latest GitHub features, enhancements, and calls for feedback.
• Explore our Product Roadmap, which details upcoming major releases and initiatives.

What you can do in the meantime 💻

• Upvote and comment on other user feedback Discussions that resonate with you.
• Add more information at any point! Useful details include: use cases, relevant labels, desired outcomes, and any accompanying screenshots.

As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities.

Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐

[Rahul-2025-prog]

Yes, you can specify a different README for your GHCR package using the GitHub API. You need to update the package metadata by making a PATCH request to the GitHub API and providing the desired README content. Check out GitHub’s documentation for details on updating container package metadata.

[mo-dkrz]

Back to restful API endpoints of Github packages, I think updating the metadata through PATCH won't be feasible.
This issue has been created some years ago here
https://github.com/orgs/community/discussions/25665

But, since it was an important issue, I re-wrote it here to github developer re-consider it