This PR adds a step to show a git diff of README.md if the Helm Docs generation fails due to differences (with fail-on-diff set to true). This helps to diagnose what exactly changed in the README.md during the documentation generation.
Which issue(s) does this PR fix/relate to?
Resolves #147
List any changes that modify/break current functionality
No existing functionality is broken.
Have you included tests for your changes?
No
Did you document any new/modified functionality?
No
Notes
This will help to troubleshoot and address failures due to unexpected changes in the README.md during the Helm Docs generation process, giving more insight into what exactly is causing CI failure.
What does this do?
This PR adds a step to show a
git diffofREADME.mdif the Helm Docs generation fails due to differences (withfail-on-diffset to true). This helps to diagnose what exactly changed in the README.md during the documentation generation.Which issue(s) does this PR fix/relate to?
List any changes that modify/break current functionality
No existing functionality is broken.
Have you included tests for your changes?
No
Did you document any new/modified functionality?
No
Notes
This will help to troubleshoot and address failures due to unexpected changes in the
README.mdduring the Helm Docs generation process, giving more insight into what exactly is causing CI failure.