Skip to content

Commit

Permalink
Add clarity to docs check error message
Browse files Browse the repository at this point in the history
Reference dev docs and cover all scenarios.
  • Loading branch information
victorlin committed Jul 10, 2024
1 parent 070a639 commit 0f60f36
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,7 @@ jobs:
if [[ -n $(git status --porcelain) ]]; then
git add .
git diff --staged >&2
echo "There are changes to the developer API docs. Please regenerate, commit, and push the changes." >&2
echo "There are changes that affect the developer API docs. Please update: <https://github.com/nextstrain/augur/blob/-/docs/contribute/DEV_DOCS.md#regenerating-developer-api-docs>" >&2
echo "If there are changes to the Augur CLI, please manually adjust files under 'docs/usage/cli/'." >&2
exit 1
fi

0 comments on commit 0f60f36

Please sign in to comment.