Add semver check test command for checking API compatibility of stdlib#159671
Open
Kobzol wants to merge 1 commit into
Open
Add semver check test command for checking API compatibility of stdlib#159671Kobzol wants to merge 1 commit into
Kobzol wants to merge 1 commit into
Conversation
rustbot
added
A-testsuite
Member
|
(I'll look at this during the weekend.) |
Collaborator
|
This PR was rebased onto a different main commit. Here's a range-diff highlighting what actually changed. Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers. |
jhpratt
added a commit
to jhpratt/rust
that referenced
this pull request
Jul 23, 2026
…, r=Mark-Simulacrum Avoid spurious rebuilds of JSON docs in bootstrap Found this while working on rust-lang#159671. Before, repeated runs of e.g. `x dist rust-docs-json` always rebuilt the docs. It was caused by Cargo not knowing that the output should be JSON, so it was trying to find the HTML files. Instead of passing the output format through `RUSTDOCFLAGS`, which Cargo doesn't inspect, we now pass it to Cargo directly, which fixes the issue.
jhpratt
added a commit
to jhpratt/rust
that referenced
this pull request
Jul 24, 2026
…, r=Mark-Simulacrum Avoid spurious rebuilds of JSON docs in bootstrap Found this while working on rust-lang#159671. Before, repeated runs of e.g. `x dist rust-docs-json` always rebuilt the docs. It was caused by Cargo not knowing that the output should be JSON, so it was trying to find the HTML files. Instead of passing the output format through `RUSTDOCFLAGS`, which Cargo doesn't inspect, we now pass it to Cargo directly, which fixes the issue.
jhpratt
added a commit
to jhpratt/rust
that referenced
this pull request
Jul 24, 2026
…, r=Mark-Simulacrum Avoid spurious rebuilds of JSON docs in bootstrap Found this while working on rust-lang#159671. Before, repeated runs of e.g. `x dist rust-docs-json` always rebuilt the docs. It was caused by Cargo not knowing that the output should be JSON, so it was trying to find the HTML files. Instead of passing the output format through `RUSTDOCFLAGS`, which Cargo doesn't inspect, we now pass it to Cargo directly, which fixes the issue.
jhpratt
added a commit
to jhpratt/rust
that referenced
this pull request
Jul 24, 2026
…, r=Mark-Simulacrum Avoid spurious rebuilds of JSON docs in bootstrap Found this while working on rust-lang#159671. Before, repeated runs of e.g. `x dist rust-docs-json` always rebuilt the docs. It was caused by Cargo not knowing that the output should be JSON, so it was trying to find the HTML files. Instead of passing the output format through `RUSTDOCFLAGS`, which Cargo doesn't inspect, we now pass it to Cargo directly, which fixes the issue.
rust-timer
added a commit
that referenced
this pull request
Jul 24, 2026
Rollup merge of #159765 - Kobzol:bootstrap-docs-json-rebuild, r=Mark-Simulacrum Avoid spurious rebuilds of JSON docs in bootstrap Found this while working on #159671. Before, repeated runs of e.g. `x dist rust-docs-json` always rebuilt the docs. It was caused by Cargo not knowing that the output should be JSON, so it was trying to find the HTML files. Instead of passing the output format through `RUSTDOCFLAGS`, which Cargo doesn't inspect, we now pass it to Cargo directly, which fixes the issue.
github-actions Bot
pushed a commit
to rust-lang/rustc-dev-guide
that referenced
this pull request
Jul 25, 2026
…Simulacrum Avoid spurious rebuilds of JSON docs in bootstrap Found this while working on rust-lang/rust#159671. Before, repeated runs of e.g. `x dist rust-docs-json` always rebuilt the docs. It was caused by Cargo not knowing that the output should be JSON, so it was trying to find the HTML files. Instead of passing the output format through `RUSTDOCFLAGS`, which Cargo doesn't inspect, we now pass it to Cargo directly, which fixes the issue.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a new test to bootstrap (not executed by default at the moment) that checks the API compatibility of the standard library using the https://github.com/obi1kenobi/cargo-semver-checks tool.
The command can be executed using
x test std-semver-check.(Note: I realized that
x dist rust-docs-jsonexecuted twice in a row invalidates Cargo cache for some reason, that is a separate issue though).The test is not yet executed on CI, I would do that in a separate PR (maybe pending a t-libs FCP or something).
The test checks that c-s-c is installed, and then uses git to lookup a parent baseline commit (in a future extension, we should make the baseline commit be configurable through
config.toml). Then it downloads the correspondingrust-docs-jsoncomponent of that commit from CI and extracts it. It generates the same JSON docs component from local sources, and then runs c-s-c on those two JSON files to compare their API.Output when API stability is broken:
CC @obi1kenobi @Amanieu
r? @jieyouxu