Skip to content

ci: consolidate rustdoc validation#1015

Merged
bitwalker merged 1 commit into
nextfrom
fix/docs-ci-rustdoc
May 14, 2026
Merged

ci: consolidate rustdoc validation#1015
bitwalker merged 1 commit into
nextfrom
fix/docs-ci-rustdoc

Conversation

@huitseeker
Copy link
Copy Markdown
Collaborator

Fix doc breakage from #986 and consolidate check jobs into one CI job

@huitseeker huitseeker added the no changelog This PR does not require an entry in the `CHANGELOG.md` file label May 14, 2026
@huitseeker huitseeker force-pushed the fix/docs-ci-rustdoc branch from 8eb8275 to dd92644 Compare May 14, 2026 17:24
Comment thread Makefile
.PHONY: doc
doc: ## Generate and check documentation for workspace crates only
rm -rf "${CARGO_TARGET_DIR:-target}/doc"
rm -rf "$${CARGO_TARGET_DIR:-target}/doc"
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't this escape the env var and try to remove the literal path ${CARGO_TARGET_DIR:-target}/doc?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, this is the Makefile escaping we need here. In a make recipe, $$ is reduced to a single $ before the command is handed to the shell, so the shell still receives:

${CARGO_TARGET_DIR:-target}/doc

and expands it normally.

The previous version with a single $ was actually the broken one: make tried to expand ${CARGO_TARGET_DIR:-target} as a make variable, which was empty locally, so the command became rm -rf "/doc". I verified make doc with this change, and it now cleans the intended target doc directory before building docs.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops, thought I was looking at a task in .github/workflows/* 😬

@bitwalker bitwalker merged commit 2729698 into next May 14, 2026
30 checks passed
@bitwalker bitwalker deleted the fix/docs-ci-rustdoc branch May 14, 2026 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no changelog This PR does not require an entry in the `CHANGELOG.md` file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants