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

version bumps for v1.3.0 #1345

Open
plebhash opened this issue Jan 10, 2025 · 10 comments
Open

version bumps for v1.3.0 #1345

plebhash opened this issue Jan 10, 2025 · 10 comments
Assignees
Labels
version-bump version bump for release management
Milestone

Comments

@plebhash
Copy link
Collaborator

plebhash commented Jan 10, 2025

unfortunately cargo semver-checks will only warn us about MAJOR bumps, but MINOR and PATCH bumps still require our own discipline

in the past we had some discussions about bumping MINOR and PATCH crate versions on the same PR that introduces the changes, or right before doing the release

there's pros and cons with both strategies

if we bump on the same PR that introduces the changes:

  • pro: we don't forget to bump the crate
  • con: we could potentially bump 2x before publishing, and end up with version gaps on crates.io (e.g.: 1.2.0 then 1.4.0)

if we bump right before the release:

  • pro: we don't risk bumping 2x before publishing
  • con: we risk forgetting to bump, in case the change happened a long time ago

a good compromise is to keep a dedicated issue to keep track of changes for every release

every time we introduce some change, we take note here

and then before we do the release, we use this issue to analyze all the needed version bumps before publishing the crates


we should use this issue to keep track of the needed version bumps before v1.3.0

@plebhash plebhash added the version-bump version bump for release management label Jan 10, 2025
@plebhash plebhash added this to the 1.3.0 milestone Jan 10, 2025
@plebhash
Copy link
Collaborator Author

starting with #1238

we need to bump MINOR for noise_sv2

@plebhash plebhash moved this from Todo 📝 to In Progress 🏗️ in SV2 Roadmap 🛣️ Jan 10, 2025
@plebhash
Copy link
Collaborator Author

plebhash commented Jan 14, 2025

this one is breaking CI (it requires a MAJOR bump to codec_sv2), so we're bumping it already

#1346

@plebhash
Copy link
Collaborator Author

plebhash commented Jan 18, 2025

this one is breaking CI (it requires a MAJOR bump to roles_logic_sv2), so we're bumping it already

#1352

@plebhash
Copy link
Collaborator Author

#1398

need to bump MINOR on key-utils

@plebhash
Copy link
Collaborator Author

#1404

moving Sv1 example inside the sv1_api crate

not sure if this even deserves a version bump? just taking note here anyways

@plebhash
Copy link
Collaborator Author

#1407

moving interop-cpp examples inside the sv1-ffi crate

not sure if this even deserves a version bump? just taking note here anyways

@plebhash plebhash self-assigned this Jan 28, 2025
@plebhash
Copy link
Collaborator Author

plebhash commented Feb 1, 2025

#1433 and #1389 are introducing breaking changes into network_helpers_sv2

as a consequence, CI is forcing us to bump MAJOR

@plebhash
Copy link
Collaborator Author

plebhash commented Feb 6, 2025

in #1455 CI is forcing us to bump MAJOR for multiple crates:

  • framing_sv2
  • common_messages_sv2
  • job_declaration_sv2
  • mining_sv2
  • template_distribution_sv2
  • sv2-ffi

@plebhash
Copy link
Collaborator Author

plebhash commented Feb 6, 2025

in #1459 CI is forcing us to bump MAJOR in buffer_sv2

@GitGab19
Copy link
Collaborator

#1442 introduces breaking changes into roles_logic_sv2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
version-bump version bump for release management
Projects
Status: In Progress 🏗️
Development

No branches or pull requests

2 participants