Check incompatible changes with cargo-semver-checks
#28
Conversation
This file contains 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
[`cargo-semver-checks`] can detect if any change which is backward-incompatible is introduced. It works by comparing current version in `Cargo.toml` (unpublished `0.3.0` in our case) against the latest published version (`0.2.0` in this case) and checking against a bunch of rules if the new changes are compatible or whether we need to bump the version. In this case as the `Cargo.toml` was already changed from `0.2.0` => `0.3.0` the checks don't fail, but if we didn't bump the version it would have failed because of the various breaking changes we've made. It is useful to have CI run this as sometimes changes can be backward-incompatible in surprising ways. [`cargo-semver-checks`]: https://github.com/obi1kenobi/cargo-semver-checks
jnioche
approved these changes
Oct 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
cargo-semver-checkscan detect if any change which is backward-incompatible is introduced.It works by comparing current version in
Cargo.toml(unpublished0.3.0in our case) against the latest published version (0.2.0in this case) and checking against a bunch of rules if the new changes are compatible or whether we need to bump the version.In this case as the
Cargo.tomlwas already changed from0.2.0=>0.3.0the checks don't fail, but if we didn't bump the version it would have failed because of the various breaking changes we've made.It is useful to have CI run this as sometimes changes can be backward-incompatible in surprising ways.