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

fix(derive): Release breaking change as v0.31.0 #3178

Merged
merged 3 commits into from Nov 29, 2022

Conversation

mxinden
Copy link
Member

@mxinden mxinden commented Nov 29, 2022

Description

libp2p-swarm-derive released a breaking change (#3011) as a patch release v0.30.2.

This patch:

  1. Prepares a new minor release of libp2p-swarm-derive.
  2. Prepares a patch release for libp2p-swarm to use the minor release of libp2p-swarm-derive.

As a follow up we can yank the libp2p-swarm-derive v0.30.2 release. In addition we might want to release libp2p-swarm-derive v0.30.3 containing all patches but #3011.

See #3176 for corresponding discussion.

Notes

//CC @joao-paulo-parity @dvdplm

Links to any relevant issues

Open Questions

If I am not mistaken, we can release this in libp2p-swarm as a patch release. Would appreciate additional eyes on that.

Change checklist

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • A changelog entry has been made in the appropriate crates

`libp2p-swarm-derive` released a breaking change (libp2p#3011)
as a patch release `v0.30.2`.

This patch:

1. Prepares a new minor release of `libp2p-swarm-derive`.
2. Prepares a patch release for `libp2p-swarm` to use the minor release of `libp2p-swarm-derive`.

As a follow up we can yank the `libp2p-swarm-derive` `v0.30.2` release. In addition we might want to
release `libp2p-swarm-derive` `v0.30.3` containing all patches but libp2p#3011.
@@ -46,7 +46,7 @@ libp2p-identify = { path = "../protocols/identify" }
libp2p-kad = { path = "../protocols/kad" }
libp2p-ping = { path = "../protocols/ping" }
libp2p-plaintext = { path = "../transports/plaintext" }
libp2p-swarm-derive = { version = "0.30.2", path = "../swarm-derive" }
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

version was introduced in https://github.com/libp2p/rust-libp2p/pull/3055/files#r1034571199. @thomaseizinger was that a deliberate choice or an oversight?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An oversight! Thanks for fixing it!

@thomaseizinger
Copy link
Contributor

If I am not mistaken, we can release this in libp2p-swarm as a patch release. Would appreciate additional eyes on that.

I agree.

swarm/CHANGELOG.md Outdated Show resolved Hide resolved
swarm-derive/Cargo.toml Outdated Show resolved Hide resolved
@jxs
Copy link
Member

jxs commented Nov 29, 2022

thanks for this Max!

@shamil-gadelshin
Copy link
Contributor

Thanks indeed! I also encountered the issue.

@bkchr
Copy link

bkchr commented Nov 29, 2022

Can we move on here @mxinden?

Co-authored-by: Thomas Eizinger <thomas@eizinger.io>
@mxinden mxinden merged commit be0b62a into libp2p:master Nov 29, 2022
@mxinden
Copy link
Member Author

mxinden commented Nov 29, 2022

I will publish and tag the release after the libp2p community call.

@mxinden
Copy link
Member Author

mxinden commented Nov 29, 2022

@bkchr
Copy link

bkchr commented Nov 29, 2022

Ty @mxinden :)

@Voxelot
Copy link

Voxelot commented Nov 29, 2022

FYI might be worth checking out cargo-semver-checks to detect these issues in the future. Or at the very least use some kind of snapshot tests of the codegen.

@mxinden
Copy link
Member Author

mxinden commented Dec 2, 2022

@Voxelot already part of our CI see #2647.

Though in this case, I don't think it could have caught the breaking change, given that libp2p-swarm-derive is a derive macro.

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.

None yet

6 participants