Should we run `semver` test on release instead of each PR?

Question

Should we run `semver` test on release instead of each PR?

BugenZhao opened this issue a year ago · 4 comments

Currently, we'll run cargo semver-checks to prevent API changes without bumping the major version (or minor version under 0.x). Essentially, this requires each PR with breaking changes to bump the major version in place.

Imagine that we have 10 PRs with breaking changes merged one day and we intend to publish them together. Then we have to bump the version 10 times under current restrictions. 😕 Also, I don't think it's a good idea to bump the version in place. A separate PR (or commit) can be much clearer.

So I'm wondering whether we should only run semver test on release (publish) instead?

xxchan commented a year ago

sure

Answer 1 · 2023-09-15T13:14:21.000Z

IIRC semver compares with latest version on crates.io instead of main? Therefore only the first PR needs to bump version 🤪

Answer 2 · 2023-09-15T13:14:46.000Z

But I'm also open to do semver check on release.

Answer 3 · 2023-09-15T13:32:17.000Z

IIRC semver compares with latest version on crates.io instead of main? Therefore only the first PR needs to bump version

Yes, since we don't have many PRs and release frequently, I also think it's OK to bump version in PR directly. It's a problem for projects that don't release frequently.