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

Add SemVer violation check to publishing CI workflow #50

Merged
merged 1 commit into from
Feb 27, 2025

Conversation

aleasims
Copy link
Contributor

@aleasims aleasims commented Feb 21, 2025

This tool will review the API against the latest version already released on crates.io and try to check if there is a SemVer violation (whether crate version changed properly or not).

Important note

This tool has quite a few false negatives and may not catch all the violations. E.g. adding new item (function, structure) to a public API doesn't trigger minor update.

You should still watch out for SemVer manually. If this step at CI is green it doesn't mean that everything is fine.

However I think that it's still better to have it here that not to have it: it may catch at least something and warn you on time.

This tool has a number of false negatives and may not catch all the violations.
@aleasims aleasims self-assigned this Feb 21, 2025
@aleasims aleasims marked this pull request as ready for review February 21, 2025 11:37
@aleasims aleasims merged commit 8e42487 into dev Feb 27, 2025
1 check passed
@aleasims aleasims deleted the hotfix/ci-semver-check branch February 27, 2025 22:23
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

Successfully merging this pull request may close these issues.

2 participants