Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
BugenZhao opened this issue Sep 15, 2023 · 4 comments
Closed

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

BugenZhao opened this issue Sep 15, 2023 · 4 comments

Comments

@BugenZhao
Copy link
Collaborator

BugenZhao commented Sep 15, 2023

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
Copy link
Member

xxchan commented Sep 15, 2023

sure

@skyzh
Copy link
Member

skyzh commented Sep 15, 2023

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

@skyzh
Copy link
Member

skyzh commented Sep 15, 2023

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

@xxchan
Copy link
Member

xxchan commented Sep 15, 2023

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.

@xxchan xxchan closed this as not planned Won't fix, can't repro, duplicate, stale Jan 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants