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

automatically generate readme for docker hub #289

Open
McPringle opened this issue Feb 2, 2025 · 0 comments
Open

automatically generate readme for docker hub #289

McPringle opened this issue Feb 2, 2025 · 0 comments
Labels
enhancement New feature or request hackergarten Possible issues for Hackergarten events

Comments

@McPringle
Copy link
Owner

McPringle commented Feb 2, 2025

The README for the Docker Hub repository is limited to 2'000 characters. Actually there is a separate file: README_DOCKERHUB.md

A better solution (to avoid duplicate docs) would be to generate this file automatically by extracting the relevant paragraphs from the main README.md file. I found a GitHub action which looks like an easy solution:

https://github.com/sean0x42/markdown-extract

This should be added to the Docker Nightly action as the second last step just before the Docker Hub Description step.

@McPringle McPringle added enhancement New feature or request hackergarten Possible issues for Hackergarten events labels Feb 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request hackergarten Possible issues for Hackergarten events
Projects
None yet
Development

No branches or pull requests

1 participant