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

Create a new major version of the MQTT package, to adopt MQTTnet v4.x #295

Merged
merged 2 commits into from
Aug 1, 2024

Conversation

jskeet
Copy link
Contributor

@jskeet jskeet commented Jul 30, 2024

Fixes #269.

cc @captainsafia, @antiblue, @Clockwork-Muse

This PR doesn't create the new release - I'd do that in a separate (tiny) PR.

RELEASING.md Outdated

A single GitHub release (and tag) will be created for each beta release, to cover all packages.

- Example tag name: "CloudNative.CloudEvents.All-2.0.0"
- Example release title: "All packages version 2.0.0"

### Exception: new major versions

Sometimes, we need a new major version of a "satellite" package, typically
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Sometimes, we need a new major version of a "satellite" package, typically
Usually, all packages shipped from this repo share the same major version. Sometimes, we need a new major version of a "satellite" package, typically

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm... I think I'll reword again. (Because it's a "usually in the sense of most packages" rather than a "usually in the sense of most releases".) Thanks for pointing out that it needs tweaking :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've reworded this whole paragraph and added the specific MQTT example (in the past tense, to avoid having to update it again after the release I expect to do as soon as this is in).

Copy link
Contributor

Choose a reason for hiding this comment

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

Rewording looks good! I mostly wanted to make sure we documented that a different major version was the exception, not the norm, with our current versioning strategy. I think your latest delta conveys that sufficiently.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks! I really appreciate the attention to detail :) Will merge now, then create a release PR (possibly tomorrow).

@jskeet jskeet force-pushed the mqtt-major branch 3 times, most recently from 85e9414 to e9cd37b Compare August 1, 2024 11:26
jskeet added 2 commits August 1, 2024 12:30
This more fine-grained way of referring to the versions will allow us to still only change Directory.Build.props just before a release, but have separate major versions flow from that.

Signed-off-by: Jon Skeet <jonskeet@google.com>
This involves a new major version of CloudNative.CloudEvents.Mqtt.

Signed-off-by: Jon Skeet <jonskeet@google.com>
@jskeet jskeet merged commit 830415d into cloudevents:main Aug 1, 2024
2 checks passed
@jskeet jskeet deleted the mqtt-major branch August 1, 2024 15:20
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.

Dependency MQTTnet out of date and has breaking changes.
3 participants