Automate /examples/README.md generation through CI #351
PrinceOfBorgo
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
When pushing new changes it would be nice to trigger automatically the generation of the README.md inside the /examples/ dir. This is a nice feature to keep the documentation up-to-date both when breaking changes (eventually) happen on the noise functions and if examples are created/edited.
To automate this process in my local branch I wrote this powershell script to run before a push. The script must be located at the same level as the noise-fn repo folder. The script will run a release build of each example in /examples/ folder and it will update the /examples/README.md file with the generated images. Further more, it will also update the pictures used in the main README.md file (Planetary Surface Example and Perlin noise).
I'm not a GitHub guru, so I don't know how this process can be automated through the CI.
Beta Was this translation helpful? Give feedback.
All reactions