Skip to content

Commit

Permalink
Cleanup docs CI (#1102)
Browse files Browse the repository at this point in the history
* Don't check external urls

* Skip test-docs if no changes
  • Loading branch information
Jake-Shadle authored Feb 6, 2025
1 parent 19935e5 commit bde8747
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
3 changes: 2 additions & 1 deletion build/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,8 @@ test-docs:
docker run --rm $(common_rust_args) \
-e GITHUB_REF_NAME=$(GITHUB_REF_NAME) -e QUILKIN_VERSION=$(QUILKIN_VERSION) \
--entrypoint=bash $(BUILD_IMAGE_TAG) -c \
'export RUSTDOCFLAGS="-Dwarnings" && mkdir /tmp/docs && \
'if ! [git diff --quiet --exit-code origin/main -- docs]; then echo "docs unchanged, skipping docs test" && exit 0; fi; \
export RUSTDOCFLAGS="-Dwarnings" && mkdir /tmp/docs && \
mkdir -p "$(CARGO_TARGET_DIR)/doc"; \
cargo doc --workspace --no-deps && cd docs && mdbook build --dest-dir /tmp/docs/book && \
cp -r "$(CARGO_TARGET_DIR)/doc" /tmp/docs/api && \
Expand Down
2 changes: 1 addition & 1 deletion docs/htmltest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
TestFilesConcurrently: false
IgnoreInternalEmptyHash: true
IgnoreEmptyHref: true
CheckExternal: true
CheckExternal: false # this can be useful occasionally to find dead links, but generally it's not useful as any external link could give an error code and fail CI
ExternalTimeout: 60
IgnoreURLs:
- "http://localhost:9091/"
Expand Down

0 comments on commit bde8747

Please sign in to comment.