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

let's keep the data in YAML format and render into Markdown on every push #12

Closed
yegor256 opened this issue Apr 2, 2024 · 8 comments
Closed

Comments

@yegor256
Copy link
Owner

yegor256 commented Apr 2, 2024

Maybe we can keep the entire dataset in a YAML file. Then, on each push we configure a GHA job, that will render this YAML file into a Markdown table, put it into the README.md (replacing the existing one), and then submit a pull request with the changes to the repository.

See how it works, for example, here: https://github.com/yegor256/micromap/blob/master/.github/workflows/up.yml

@yegor256
Copy link
Owner Author

yegor256 commented Apr 2, 2024

@uchitsa think about this, please

@uchitsa
Copy link
Contributor

uchitsa commented Apr 2, 2024

@yegor256 thanks, I'll do it

@yegor256
Copy link
Owner Author

yegor256 commented Apr 2, 2024

@uchitsa will be great, if we create a Bash script that does all that: compile.sh. It gets a path to .yml file as an input and prints a Markdown table as an output. We will call this script from GHA job, saving its output to a Bash variable. Then, inject it into the README.md

@yegor256
Copy link
Owner Author

yegor256 commented Apr 2, 2024

@uchitsa would be great to create a unit test (with a synthetic YAML input) for this Bash script (maybe call it test-compile.sh), in order to make sure that it actually prints the right Markdown output.

@yegor256
Copy link
Owner Author

yegor256 commented Apr 3, 2024

@uchitsa I think, this is the most important task now, since our list keeps growing and it will be just more time consuming later to turn it into YAML

@uchitsa
Copy link
Contributor

uchitsa commented Apr 5, 2024

@yegor256 I prepare python script to parse a yaml source and create a result md file

@yegor256
Copy link
Owner Author

yegor256 commented Apr 7, 2024

@uchitsa don't forget to add pylint or pep8 (or both) to GHA

uchitsa referenced this issue in uchitsa/awesome-cfp Apr 8, 2024
uchitsa referenced this issue in uchitsa/awesome-cfp Apr 8, 2024
yegor256 added a commit that referenced this issue Jul 2, 2024
@yegor256
Copy link
Owner Author

yegor256 commented Jul 2, 2024

@uchitsa thanks a lot for implementing this feature!

@yegor256 yegor256 closed this as completed Jul 2, 2024
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