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

Run cargo-semver-checks in CI #822

Merged
merged 3 commits into from
Jun 12, 2024
Merged

Run cargo-semver-checks in CI #822

merged 3 commits into from
Jun 12, 2024

Conversation

Urhengulas
Copy link
Member

@Urhengulas Urhengulas commented Mar 25, 2024

Run cargo-semver-checks in CI for every pull request. This is to ensure we do not accidentally break the API of our crates (again 😅).

When a PR does break the api it should be flagged with the "breaking change" label. If that is done, the check will be skipped. The next release after merging that PR needs to update the version accordingly.

Examples of the CI catching breakages:

Example of the job being skipped:

@Urhengulas Urhengulas added breaking change fix / feature / improvement involves a breaking change and needs to wait until next minor version and removed breaking change fix / feature / improvement involves a breaking change and needs to wait until next minor version labels Mar 25, 2024
@Urhengulas Urhengulas force-pushed the cargo-semver-check branch 2 times, most recently from bfdbd61 to edfde26 Compare March 25, 2024 16:14
@Urhengulas Urhengulas changed the title Run cargo semver-checks in CI Run cargo-semver-checks in CI Mar 25, 2024
@Urhengulas Urhengulas marked this pull request as ready for review March 25, 2024 16:15
@Urhengulas Urhengulas force-pushed the cargo-semver-check branch 2 times, most recently from 6a64d09 to 2e3058e Compare May 13, 2024 15:16
@Urhengulas Urhengulas enabled auto-merge June 12, 2024 12:07
@Urhengulas Urhengulas added this pull request to the merge queue Jun 12, 2024
Merged via the queue into main with commit 75fb317 Jun 12, 2024
16 checks passed
@Urhengulas Urhengulas deleted the cargo-semver-check branch June 12, 2024 12:18
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