Skip to content

chore: Make cargo doc fail on warnings - #1277

Merged
Techassi merged 3 commits into
mainfrom
chore/make-cargo-doc-fail-on-warnings
Sep 25, 2026
Merged

Techassi merged 3 commits into
mainfrom
chore/make-cargo-doc-fail-on-warnings

Conversation

@Techassi

@Techassi Techassi commented Sep 16, 2026 •

Copy link
Copy Markdown
Member

Triggered by stackabletech/issues#848 (comment), similar to stackabletech/operator-templating#650.

cargo doc hooks run by prek now error on warnings.

@Techassi Techassi self-assigned this Sep 16, 2026
@Techassi Techassi added the release-retro/26.7.0 Indicates this issue or PR is part of improvements resulting from the Release Retro 26.7.0 label Sep 16, 2026
@Techassi Techassi moved this to Development: In Progress in Stackable Engineering Sep 16, 2026
@Techassi Techassi moved this from Development: In Progress to Development: Waiting for Review in Stackable Engineering Sep 16, 2026
NickLarsenNZ
NickLarsenNZ previously approved these changes Sep 21, 2026

@NickLarsenNZ NickLarsenNZ left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hmm, I find warnings useful for deprecating things without a breaking change.
I'll approve it since we already do that, but we should maybe look at relaxing that rule (it could be a separate check that is allowed to fail so at least there is feedback).

@NickLarsenNZ NickLarsenNZ moved this from Development: Waiting for Review to Development: In Review in Stackable Engineering Sep 21, 2026
@Techassi

Techassi commented Sep 25, 2026 •

Copy link
Copy Markdown
Member Author

I don't know if the deprecation warnings even apply to cargo doc at all.

If they do, I don't know if there maybe is a way to allow specific warnings but denying the rest. I guess that would be ideal to allow warnings from #[deprecated].

@NickLarsenNZ NickLarsenNZ left a comment •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I don't know if the deprecation warnings even apply to cargo doc at all.

My bad, I didn't see that it was for docs. And I think deprecated things should be removed from docs anyway, so that's fine as is.

LGTM

@Techassi
Techassi added this pull request to the merge queue Sep 25, 2026
Merged via the queue into main with commit c1c9b4b Sep 25, 2026
5 checks passed
@Techassi
Techassi deleted the chore/make-cargo-doc-fail-on-warnings branch September 25, 2026 08:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release-retro/26.7.0 Indicates this issue or PR is part of improvements resulting from the Release Retro 26.7.0

Projects

Status: Development: Done

Development

Successfully merging this pull request may close these issues.

2 participants