Automate embedmd update commands and document its usage as a pre-commit hook

litmuschaos / litmus

Litmus helps SREs and developers practice chaos engineering in a Cloud-native way. Chaos experiments are published at the ChaosHub (https://hub.litmuschaos.io). Community notes is at https://hackmd.io/a4Zu_sH4TZGeih-xCimi3Q

https://litmuschaos.io

Apache License 2.0

4.4k stars 691 forks source link

Automate embedmd update commands and document its usage as a pre-commit hook #1989

Closed ksatchit closed 4 years ago

ksatchit commented 4 years ago

Litmus-docs makes use of embedmd to pull changes to chaos snippets from the chaos-charts and other such repos
This enables simpler update to snippets/manifests embedded into the docs. However, this is a user-action today, which may to may not be performed. Also, since it is per-file based, a bash script automating this would help.
Adding this to the build may be a good idea. Another approach is to use it as part of a pre-commit hook action. This needs to documented.

uditgaurav commented 4 years ago

This has been done with https://github.com/litmuschaos/litmus-docs/pull/360.

ksatchit commented 4 years ago

This is now automated and added as a as a github actions workflow triggered to push to master branch - https://github.com/litmuschaos/litmus-docs/blob/master/.github/workflows/main.yml