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 projects list in README #3

Closed
wotnak opened this issue Feb 19, 2023 · 4 comments
Closed

Automatically generate projects list in README #3

wotnak opened this issue Feb 19, 2023 · 4 comments

Comments

@wotnak
Copy link
Owner

wotnak commented Feb 19, 2023

JSON data format is easy to consume programmatically, but it would be nice to also display the projects list in a more human friendly format, for example in README.md.

Manually keeping README.md in sync with changes in the projects.json would be probably hard, so it should be automated.

The preferred way to achieve this would be to configure GitHub actions so on every push to main branch readme would be automatically updated to reflect changes introduced in the projects.json file.

@paul121
Copy link

paul121 commented Feb 19, 2023

Another approach could be to publish these to a simple GitHub pages site. They could be published in simple markdown and have the ability to add additional styling over time.

It's a step further but I would really love to see this used to generate a list of community/contrib modules on farmOS.org, too!

@wotnak
Copy link
Owner Author

wotnak commented Feb 19, 2023

It's a step further but I would really love to see this used to generate a list of community/contrib modules on farmOS.org, too!

farmOS/farmOS.org@main...wotnak:farmOS.org:community-projects
https://wondrous-tartufo-9df267.netlify.app/community/projects

@paul121
Copy link

paul121 commented Feb 20, 2023

Amazing! I mean.. I think that covers all the basics and would be useful as is. Would you like to open a PR so we could start discussing this possibility?

@wotnak
Copy link
Owner Author

wotnak commented Feb 20, 2023

Created the pr: farmOS/farmOS.org#67
I'll close this issue now. If the list will be included on the main site, there's no need to also generate it into readme. It will be enough to include a link to the farmOS.org page in the readme when the list is added to it.

@wotnak wotnak closed this as not planned Won't fix, can't repro, duplicate, stale Feb 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants