File tree Expand file tree Collapse file tree 1 file changed +16
-0
lines changed Expand file tree Collapse file tree 1 file changed +16
-0
lines changed Original file line number Diff line number Diff line change @@ -86,6 +86,22 @@ There are a few scenarios:
8686 using command like ` cargo update -p toml_datetime --precise 0.6.3 ` and go back to step 3.
8787 5. Rename ` Cargo.lock ` to ` Cargo.lock.msrv ` .
8888
89+ ### Semver checking
90+
91+ Our CI runs cargo semver-checks and labels PRs that introduce breaking changes.
92+ If you don't intend to change public API, you can perform the checks locally,
93+ using command ` make semver-rev ` . Make sure you have semver-checks installed first,
94+ you can install it using ` cargo install cargo-semver-checks ` .
95+
96+ ` make semver-rev ` will check for API breaking changes using ` main ` branch as baseline.
97+ To use different branch / commit call ` make semver-rev rev=BRANCH ` .
98+
99+ The tool is NOT perfect and only checks some aspect of semver-compatibility.
100+ It is NOT a replacement for a human reviewer, it is only supposed to help them
101+ and catch some erros that they might have missed.
102+
103+ Tool that we curently use: https://github.com/obi1kenobi/cargo-semver-checks
104+
89105## Contributing to the book
90106
91107The documentation book is written using [ mdbook] ( https://github.com/rust-lang/mdBook ) \
You can’t perform that action at this time.
0 commit comments