MG-147 - Helm Docs Generation Fails with README.md has changed error
#148
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: JeffMboya <[email protected]>
Signed-off-by: JeffMboya <[email protected]>
Signed-off-by: JeffMboya <[email protected]>
Signed-off-by: JeffMboya <[email protected]>
JeffMboya
changed the title
README.md has changed error
dborovcanin
approved these changes
Sep 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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?
README.md has changederror #147List 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.