Release 0.21.0 #721
Release 0.21.0 #721
Conversation
|
There are may API changes. 0.30 maybe? // Who does not like bike-shedding? |
luckily we do not need to make that decision, semver (https://semver.org) has done it for us :) I do like the idea of a 1.0.0 eventually. We can probably do that after:
|
|
As you mentioned already thousands of projects depend on it and it is sad fact of live that people generally do not read documentation, including semantic versioning guides. No problem picking next minor version, of course. |
|
I'll place an announcement on reddit and the rust user forum noting its a breaking release and explicitly mention the upgrade guide and documentation. maybe that will help |
|
Ready for review and then release. I would prefer to release either next monday or before friday this week. Since during the weekend I can not handle any fallout/questions. |
|
On a business trip now, could offer a few nitpicks but would have to do it on mobile (biggest one: gapless is only with Symphonia, and already was in 0.20 - biggest fix here is the availability of Come to think of, there are also some function return type changes in the Overarching question: the way I perceive the upgrade guide, it's indeed to migrate and fix compilation issues. I'm wondering if we should shed a little more light on some internals; the |
|
another thing, bincode has the migration guide in the docs, seems like a good idea to me. |
|
blocked by #724 |
thank you very much, I'll get on that some day next week. Next time full free to edit the code/docs on the branch directly. Then I'll just look at the diff and bring up any contentious change. |
|
blocked by #730 |
|
rebased on main |
yara-blue
force-pushed
the
0.21
branch
3 times, most recently
from
6d9b6c9 to
d58968b
Compare
|
rebased on master |
yara-blue
force-pushed
the
0.21
branch
3 times, most recently
from
ac0b1b8 to
946cce2
Compare
|
we should be good to release now :) |
|
Mind if I suggest you include #754 in this release as well? |
|
Okay this is rebased on main now. I think we are still missing some stuff in the upgrade guide related to the feature overhaul. Would you mind giving that a look @roderickvd? |
There was a problem hiding this comment.
Pull Request Overview
This PR prepares the 0.21.0 release by updating the announcement, bumping versions, linking the upgrade guide, and refreshing documentation/changelog.
- Drafts and corrects the outreach announcement
- Expands and updates the UPGRADE guide with new migration steps
- Updates README, Cargo.toml, and CHANGELOG.md for version 0.21.0
Reviewed Changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| outreach/v0.21_announcement.md | Draft release announcement for social channels |
| UPGRADE.md | New upgrade instructions and examples for 0.21.0 migration |
| README.md | Added “Breaking Changes” section and bumped example version |
| Cargo.toml | Bumped crate version to 0.21.0 |
| CHANGELOG.md | Inserted new 0.21.0 section and reformatted older entries |
Comments suppressed due to low confidence (5)
UPGRADE.md:5
- [nitpick] Use a consistent heading level here (e.g. '##') rather than another top-level '#'.
# rodio 0.21 to current GitHub version
UPGRADE.md:7
- [nitpick] Clarify this placeholder—consider replacing with 'No changes are required.' for readability.
nothing
UPGRADE.md:15
- Add a leading hyphen to maintain list formatting, e.g. '- To revert to the old decoders…'.
to revert to the old decoders, you need to disable default-features and enable the `claxon`, `hound` and `lewton` features in `Cargo.toml` for respectively FLAC, WAV and Ogg Vorbis.
CHANGELOG.md:12
- Replace '(TODO)' with the actual release date in the same format as other entries (e.g. '- YYYY-MM-DD').
## Version [0.21] (TODO)
UPGRADE.md:71
- The example uses an undefined
music.ogg; it should likely be the openedfileor aBufReaderinstance.
let source = Decoder::try_from(music.ogg)?;
As the upgrade guide contains required code changes, and does not aim to replace the changelog, I think the upgrade contents on features is good enough. I did go through it to improve readability. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
- Clarify required code changes for upgrading to 0.21 - Add missing details on features, decoders, and trait changes - Improve examples and explanations for Sink, Decoder, and Mixer updates - Reorganize sections for better readability
|
rebases on main |
|
Congratulations to all contributors on this new and pretty hefty release. Should we do some communication on it on the socials? I think we did previously on Reddit. |
Almost forgot 😅 I've just done reddit, we will also get a channel and a announcement in the rust audio discord. If you know any other places please do go ahead and post there too. We've got the announcement text ready in outreach/v0.21_announcement.md |
Chores: