nix
nix copied to clipboard
nix-rust
Add `cargo-semver-checks` to automate checking for breaking changes.
Add cargo-semver-checks to automate checking for breaking changes.
This may allow removing:
- [ ] A change log has been added if this PR modifies nix's API
from the PR template, here: https://github.com/nix-rust/nix/blob/master/.github/PULL_REQUEST_TEMPLATE.md?plain=1#L7
This is a nice tool!
Just gave a brief look at its doc, if I understand correctly, after integrating it to our CI, a PR would fail the test if the changes made in this PR have semver violations.
What if semver violation is allowed, say we are going to bump our major version in the next release
a PR would fail the test if the changes made in this PR have semver violations.
It would be if the PR has semver violations relative to the last release on crates.io.
What if semver violation is allowed, say we are going to bump our major version in the next release
You would bump the version in the 1st commit since the last release that introduces a breaking change.
You would bump the version in the 1st commit since the last release that introduces a breaking change.
This would have an unintended consequence of making it more difficult for downstream crates to test new Nix changes. Right now, Nix never bumps its version number until a release. That means that a downstream crate can use a [patch.crates-io] section to override the Nix dependency temporarily, to test some change or another. I find this mechanism very useful. However, Cargo will ignore the patch section if the patched crate's version is different than the one in Cargo.lock. This means that if we adopt cargo-semver-checks, then downstream crates would have to both add a patch section and change the version in their [dependencies] section. Worse, Cargo won't use the patched Nix transitively in any of that crate's other dependencies.
IMHO the benefit of cargo-semver-checks is not worth the cost.
That said, this tool looks like it would be worthwhile to use in the release procedure, just not in CI.