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

*: Consider using semverver #2635

Closed
mxinden opened this issue May 9, 2022 · 5 comments
Closed

*: Consider using semverver #2635

mxinden opened this issue May 9, 2022 · 5 comments
Labels
difficulty:easy getting-started Issues that can be tackled if you don't know the internals of libp2p very well help wanted

Comments

@mxinden
Copy link
Member

mxinden commented May 9, 2022

Description

Consider using https://github.com/rust-lang/rust-semverver to enforce semantic versioning. Instructions on how to integrate semverver in CI can be found on https://github.com/rust-lang/rust-semverver#ci-setup.

Motivation

Complying with Semver makes it easier for users to consume rust-libp2p. Having an automated compliance check makes maintaining rust-libp2p easier.

Are you planning to do it yourself in a pull request?

Help wanted!

@mxinden mxinden added difficulty:easy help wanted getting-started Issues that can be tackled if you don't know the internals of libp2p very well labels May 9, 2022
@maschad
Copy link
Member

maschad commented May 12, 2022

Hey @mxinden I am giving this a shot. Please see this PR

maschad added a commit to maschad/rust-libp2p that referenced this issue May 12, 2022
maschad added a commit to maschad/rust-libp2p that referenced this issue May 23, 2022
maschad added a commit to maschad/rust-libp2p that referenced this issue May 23, 2022
maschad added a commit to maschad/rust-libp2p that referenced this issue May 23, 2022
@maschad
Copy link
Member

maschad commented May 23, 2022

Our current version bump results in a build failure see #2647 (comment)

@mxinden
Copy link
Member Author

mxinden commented Sep 2, 2022

Instead of semverver, we could consider using https://crates.io/crates/cargo-semver-checks.

@maschad
Copy link
Member

maschad commented Sep 2, 2022

Thanks for reviving this @mxinden - I had lost track of it because of work, I agree, particularly because semverver is tightly coupled to specific nightly compiler versions and takes work to stay in sync. I will give it a try on the PR.

maschad added a commit to maschad/rust-libp2p that referenced this issue Oct 10, 2022
@mxinden
Copy link
Member Author

mxinden commented Oct 12, 2022

With #2647 I am closing here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty:easy getting-started Issues that can be tackled if you don't know the internals of libp2p very well help wanted
Projects
None yet
Development

No branches or pull requests

2 participants