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

chrono-tz release notes feedback #178

Closed
robsdedude opened this issue Apr 16, 2024 · 3 comments
Closed

chrono-tz release notes feedback #178

robsdedude opened this issue Apr 16, 2024 · 3 comments

Comments

@robsdedude
Copy link

Hi and thanks for the nice crate.

I use it as a dependency on one my libraries and was getting ready to bump chrono-tz from 0.8 to 0.9. While doing so, I noticed that this experience is less smooth than with other crates. For two reasons:

  1. It's harder to find what has changed at all: CHANGELOG.md isn't up to date and the release page is pretty noisy with listing ️parse-zoneinfo releases as well
  2. The release notes for 0.9.0 could be more explicit about what changes are actually breaking changes.

Just figured I leave some feedback on my experience. Feel free to close the issue once you've read it =)

@pitdicker
Copy link
Contributor

@robsdedude Sorry for making it difficult. Can you say a bit more about the problem you hit?

Yesterday we moved parse-zoneinfo into this repo and are still integrating it. Just this morning I added it to the GitHub releases. And I hope to remove the changelogs. The only thing worse than no changelog is an incomplete one 😄.

@djc djc changed the title Chagelog chrono-tz release notes feedback Apr 16, 2024
@pitdicker pitdicker closed this as not planned Won't fix, can't repro, duplicate, stale Apr 16, 2024
@robsdedude
Copy link
Author

robsdedude commented Apr 22, 2024

Can you say a bit more about the problem you hit?

I think I wrote most feedback I had. To summarize: I was bumping the dependency and wanted to check what breaking changes were introduced so that I know if I had to apply any changes to my code. This felt a bit more cumbersome than with other crates, e.g., rustls, which I just use as some random example here because I also was bumping that.

Yesterday we moved parse-zoneinfo into this repo and are still integrating it.

:D it might well be that the releases were only so noisy because of that on-off thing then.

I think the only point that remains that you might want to consider: you could clearly mark what changes in a release constitute the breaking ones. Either by using some marker (e.g., an emoji) or by putting them together under one headline.

@pitdicker
Copy link
Contributor

Thank you for the feedback 👍.
The latest release notes had a 'Changed' section but indeed didn't call out the breaking change.

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

No branches or pull requests

2 participants