You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We can automate the doc generation in an action or something but at first we can just pre-commit hook. The hook can be added by each dev. We can then add an action to simply check if values.yaml has changed while README.md didn't fail and request to run helm-docs locally and commit again.
Flow:
Dev changes locally values.yaml
Dev runs locally make helm-docs > docs are generated
Commit and push
CI verifies if values.yaml changed then README.md changes.
values.yamlhas changed whileREADME.mddidn't fail and request to run helm-docs locally and commit again.Flow:
values.yamlmake helm-docs> docs are generatedvalues.yamlchanged thenREADME.mdchanges.