Enhance error message when doc tests fail
@@ -69,7 +69,7 @@ jobs:
-v $(eval "echo -n $CIRCLE_WORKING_DIRECTORY")/.git:/go/src/github.com/signalfx/signalfx-agent/.git \
signalfx-agent-dev \
bash -ec "make docs && git diff --exit-code" || \
- (echo 'Docs are not updated in the repo! Run `make docs` in the dev image and commit those changes.' && exit 1)
+ (echo 'Autogenerated docs are not in sync with their source! If you directly edited a doc file, please move the changes to the source where the doc is generated from (use grep to find where based on existing doc content). In either case, you need to run `make docs` in the dev image and commit those changes.' && exit 1)
integration_tests:
<<: *executor
