Skip to content

Commit

Permalink
Clarify doc generation error (#365)
Browse files Browse the repository at this point in the history
If the generated docs don't match the existing docs,
CI fails with a confusing error message.
This commit clarifies the error so that contributor can resolve the problem.

Signed-off-by: David Enyeart <enyeart@us.ibm.com>
  • Loading branch information
denyeart committed Aug 8, 2023
1 parent b3bc59e commit b32e6d4
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion scripts/regenDocs
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,6 @@ echo "Doc generation completed"
# Only checking status under docs/source folder
cd $docsdir
if [[ $(git status . --porcelain --untracked-file=no) ]]; then
echo "ERROR: New readme files generated, commit changes before doing push"
echo "ERROR: New rst documentation files generated that don't match the existing docs, run `make docs` to re-generate the rst documentation files before pushing"
exit 1
fi

0 comments on commit b32e6d4

Please sign in to comment.