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.

Sign up for GitHub

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

Jump to bottom

Investigate tools for checking semver violations #1517

Closed
SchmErik opened this issue Mar 5, 2024 · 4 comments · Fixed by #1556
Closed

Investigate tools for checking semver violations #1517

SchmErik opened this issue Mar 5, 2024 · 4 comments · Fixed by #1556
Assignees
@SchmErik

Comments

@SchmErik
Copy link
Contributor

SchmErik commented Mar 5, 2024

No description provided.

@SchmErik SchmErik self-assigned this Mar 5, 2024
@linear Linear
Copy link

linear bot commented Mar 5, 2024

ZKVM-366 Investigate tools for checking semver violations

@SchmErik
Copy link
Contributor Author

SchmErik commented Mar 5, 2024 •
edited

Here's an excellent discussion: rust-lang/cargo#374 (comment)
I think we should at the very least go with cargo-semver-checks and cargo-public-api seems nice for generating a diff suitable for inclusion in a changelog.

@SchmErik
Copy link
Contributor Author

SchmErik commented Mar 5, 2024

From reading the thread rust-semverver was deprecated because there weren't any active maintainers rust-lang/cargo#374 (comment)

@SchmErik
Copy link
Contributor Author

SchmErik commented Mar 5, 2024

cargo-breaking is another one but it's also deprecated and recommends cargo-semver-checks.

@SchmErik SchmErik mentioned this issue Mar 14, 2024
Merged
morgangibbs87 added a commit that referenced this issue Apr 17, 2024
@SchmErik @morgangibbs87
CI: add cargo-semver-checks (#1556)
faaa0d9 
This adds an action to check an in-coming PR against the target to point
out any changes in the crates we publish that might break semver. This
implementation lists a few packages that we exclude from the check.
Among the excluded are packages that do not need to be published, will
be moved, or ones that cargo semverchecks cannot locate correctly due to
a possible bug (`risc0-zkvm-platform`).

This change is designed for us to get used to seeing what sort of
changes break semver and is intended to not block PR's from getting at
this time.

Closes: #1517

---------

Co-authored-by: morgangibbs87 <133707571+morgangibbs87@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@SchmErik SchmErik

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

CI: add cargo-semver-checks risc0/risc0
1 participant
@SchmErik