Whitelist API breaks #61
Draft
Conversation
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
nyonson
force-pushed
the
better-api-breaks
branch
from
7bd91f4 to
524740e
Compare
The cargo-public-api crate has an interesting dependency on the nightly toolchain version due to how it ingests the api docs generated. They have a compatability matrix here: https://github.com/cargo-public-api/cargo-public-api?tab=readme-ov-file#compatibility-matrix
Add allow_breaking_changes configuration option to filter out intentional breaking changes from API check failures.
nyonson
force-pushed
the
better-api-breaks
branch
from
524740e to
490aa14
Compare
Collaborator
Author
|
Found that the public-api crate exposes the min version it needs for the nightly toolchain, MINIMUM_NIGHTLY_RUST_VERSION, so can at least have rbmt fail in a helpful way. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Opening this as a draft because it showing some short comings using the
cargo-public-apicrate. It uses rustdocs to generate the api snapshot files and diffs, but this gives it an unexpected (to me) dependency on the nightly toolchain version: https://github.com/cargo-public-api/cargo-public-api?tab=readme-ov-file#compatibility-matrixSo to use a modern nightly toolchain, need to up to
0.50which bumps the MSRV of rbmt. That isn't all that terrible, this is just a dev tool after all. But I am curious how painful it will be to keep in-step with nightly versions.Related to #58