Chore: Release v0.5.0

This commit is contained in:
Kyle Simpson
2025-02-21 22:05:58 +00:00
parent e09843ded7
commit 84accb0e3a
5 changed files with 78 additions and 7 deletions

View File

@@ -1,5 +1,75 @@
# Changelog # Changelog
## [v0.5.0] — 2025-02-21 — **Starling**
Starlings are social birds, known for chittering loudly (often sounding like human speech!) and flocking en masse. Iridescent and speckled like the night sky after twilight, their murmurations make for a beautiful evening sight.
This is a smaller breaking release which adds support for the latest version of [*twilight*](https://twilight.rs/) (v0.16), with a few main breaking changes:
- `TrackHandle`s now store an arbitrary `Arc<dyn Any>`, rather than a `TypeMap`. You can set this field to any desired type during track creation using the `Track::new_with_data` API.
- Legacy encryption modes `"xsalsa20_poly1305"`, `"xsalsa20_poly1305_suffix"`, and `"xsalsa20_poly1305_lite"` have been removed. If you were explicitly specifying these then please change over to one of the new modes. Discord have ceased serving voice connections with these parameters.
- `simd-json` support has been removed from the library.
Thanks to the following for their contributions:
- [@decahedron1]
- [@DPlayer234]
- [@Erk-]
- [@FelixMcFelix]
- [@GnomedDev]
### Added
- Driver: Support `tokio-websockets` ([@decahedron1]) [c:c4331c4]
### Changed
- Chore: quick respin on twilight-example. ([@FelixMcFelix]) [c:e09843d]
- Chore: clippy appeasement ([@FelixMcFelix]) [c:47cf0b2]
- Chore: Bump rubato->0.16 ([@FelixMcFelix]) [c:5d320a3]
- Chore: Bump rand->0.9, tokio-tungstenite->0.26 ([@FelixMcFelix]) [c:b39ab98]
- Support for Twilight 0.16 ([@Erk-]) [c:b46a568]
- Update `tokio-tungstenite` dependency to 0.24 ([@DPlayer234]) [c:1c52e6e]
- Update to DashMap 6 ([@GnomedDev]) [c:9a244ba]
- Bump dependencies ([@GnomedDev]) [c:e9b2243]
- Chore: Update `tokio-websockets` to v0.7 ([@decahedron1]) [c:3bc132f]
- Tracks: Replace `RwLock<TypeMap>` data store with `Arc<dyn Any>` ([@GnomedDev]) [c:0d6a226]
- Allow borrowed strings for YoutubeDl ([@GnomedDev]) [c:2bcc522]
- Deps: Replace OnceCell with std::sync::OnceLock ([@GnomedDev]) [c:743a1d2]
### Fixed
- Docs: remove unused link. ([@FelixMcFelix]) [c:d0b7fbb]
- Remove unnecessary simd-json feature gate ([@GnomedDev]) [c:b435e16]
### Removed
- Driver: Remove legacy encryption algorithms. ([@FelixMcFelix]) [c:f05b262]
- Remove Simd-json ([@Erk-]) [c:c81f2a9]
<!-- COMPARISONS -->
[v0.5.0]: https://github.com/serenity-rs/songbird/compare/v0.4.6...v0.5.0
<!-- COMMITS -->
[c:e09843d]: https://github.com/serenity-rs/songbird/commit/e09843ded7d8a492159ad62854a88c17d013703a
[c:d0b7fbb]: https://github.com/serenity-rs/songbird/commit/d0b7fbb911931b9ad9bc9988bef48d79650e11d6
[c:f05b262]: https://github.com/serenity-rs/songbird/commit/f05b262dfe25c35c9ac010c53cce54b6ca464581
[c:47cf0b2]: https://github.com/serenity-rs/songbird/commit/47cf0b27ebe5587b23d7fe8b8e125ae0ccde304b
[c:5d320a3]: https://github.com/serenity-rs/songbird/commit/5d320a394b2b00cb4dd04636c0c98aabdbbb7923
[c:b39ab98]: https://github.com/serenity-rs/songbird/commit/b39ab982238a50eecfefbfd25a07ffc1be44a516
[c:b46a568]: https://github.com/serenity-rs/songbird/commit/b46a568fb51b4ae92841485ee626728d43ad0731
[c:1c52e6e]: https://github.com/serenity-rs/songbird/commit/1c52e6ebc047d21a64551704cc02ef42d29f5f86
[c:b435e16]: https://github.com/serenity-rs/songbird/commit/b435e167d2760cd4a353fa422f33a0039f4151b5
[c:9a244ba]: https://github.com/serenity-rs/songbird/commit/9a244ba4c28377458a0ebb039f20093b09969399
[c:e9b2243]: https://github.com/serenity-rs/songbird/commit/e9b2243b83e61c874b0026e8d223ecbb7b879bba
[c:3bc132f]: https://github.com/serenity-rs/songbird/commit/3bc132faaff77bafaae85f93ed6a0a82083b8ec1
[c:c81f2a9]: https://github.com/serenity-rs/songbird/commit/c81f2a95780b0e32b878a664c8e69f714650e47a
[c:c4331c4]: https://github.com/serenity-rs/songbird/commit/c4331c451fc233ac97c8363cea32e6c5b30c5df5
[c:0d6a226]: https://github.com/serenity-rs/songbird/commit/0d6a226910943a56c5d53e3651958f480c5ee7c4
[c:2bcc522]: https://github.com/serenity-rs/songbird/commit/2bcc5223feb1e631cd623c71628010a56aff97bb
[c:743a1d2]: https://github.com/serenity-rs/songbird/commit/743a1d262e6bf9e9f3767b6d9646c680ef4172c4
<!-- generated by git-cliff -->
## [v0.4.6] — 2024-12-04 ## [v0.4.6] — 2024-12-04
This patch release adds the ability to pass custom arguments into `yt-dlp` instances, and fixes early event handling needed for voice receive as well as inner track handle state after `set_track` is called. This patch release adds the ability to pass custom arguments into `yt-dlp` instances, and fixes early event handling needed for voice receive as well as inner track handle state after `set_track` is called.
@@ -23,7 +93,6 @@ Thanks to the following for their contributions:
<!-- COMPARISONS --> <!-- COMPARISONS -->
[v0.4.6]: https://github.com/serenity-rs/songbird/compare/v0.4.5...v0.4.6 [v0.4.6]: https://github.com/serenity-rs/songbird/compare/v0.4.5...v0.4.6
<!-- COMMITS --> <!-- COMMITS -->
[c:651d037]: https://github.com/serenity-rs/songbird/commit/651d037a54ce37f5b69f456ccdfdb03ba9de8a91 [c:651d037]: https://github.com/serenity-rs/songbird/commit/651d037a54ce37f5b69f456ccdfdb03ba9de8a91
[c:17993bc]: https://github.com/serenity-rs/songbird/commit/17993bc0d0ae7a4e43e86bbb6439c30538b67832 [c:17993bc]: https://github.com/serenity-rs/songbird/commit/17993bc0d0ae7a4e43e86bbb6439c30538b67832
@@ -789,7 +858,9 @@ We'd also like to thank all users who have contributed to this module in the pas
[@clarity0]: https://github.com/clarity0 [@clarity0]: https://github.com/clarity0
[@cycle-five]: https://github.com/cycle-five [@cycle-five]: https://github.com/cycle-five
[@DasEtwas]: https://github.com/DasEtwas [@DasEtwas]: https://github.com/DasEtwas
[@decahedron1]: https://github.com/decahedron1
[@DoumanAsh]: https://github.com/DoumanAsh [@DoumanAsh]: https://github.com/DoumanAsh
[@DPlayer234]: https://github.com/DPlayer234
[@Elinvynia]: https://github.com/Elinvynia [@Elinvynia]: https://github.com/Elinvynia
[@Erk-]: https://github.com/Erk- [@Erk-]: https://github.com/Erk-
[@fee1-dead]: https://github.com/fee1-dead [@fee1-dead]: https://github.com/fee1-dead

View File

@@ -10,8 +10,8 @@ license = "ISC"
name = "songbird" name = "songbird"
readme = "README.md" readme = "README.md"
repository = "https://github.com/serenity-rs/songbird.git" repository = "https://github.com/serenity-rs/songbird.git"
rust-version = "1.74" rust-version = "1.74.1"
version = "0.4.6" version = "0.5.0"
[dependencies] [dependencies]
aead = { optional = true, version = "0.5.2" } aead = { optional = true, version = "0.5.2" }

View File

@@ -30,13 +30,13 @@ project you will need to depend on Symphonia as well.
```toml ```toml
# Including songbird alone gives you support for Opus via the DCA file format. # Including songbird alone gives you support for Opus via the DCA file format.
[dependencies.songbird] [dependencies.songbird]
version = "0.4" version = "0.5"
features = ["builtin-queue"] features = ["builtin-queue"]
# To get additional codecs, you *must* add Symphonia yourself. # To get additional codecs, you *must* add Symphonia yourself.
# This includes the default formats (MKV/WebM, Ogg, Wave) and codecs (FLAC, PCM, Vorbis)... # This includes the default formats (MKV/WebM, Ogg, Wave) and codecs (FLAC, PCM, Vorbis)...
[dependencies.symphonia] [dependencies.symphonia]
version = "0.5.2" version = "0.5"
features = ["aac", "mp3", "isomp4", "alac"] # ...as well as any extras you need! features = ["aac", "mp3", "isomp4", "alac"] # ...as well as any extras you need!
``` ```

View File

@@ -11,7 +11,7 @@ resolver = "2"
[workspace.dependencies] [workspace.dependencies]
reqwest = "0.12" reqwest = "0.12"
serenity = { features = ["cache", "framework", "standard_framework", "voice", "http", "rustls_backend"], version = "0.12" } serenity = { features = ["cache", "framework", "standard_framework", "voice", "http", "rustls_backend"], version = "0.12" }
songbird = { path = "../", version = "0.4", default-features = false } songbird = { path = "../", version = "0.5", default-features = false }
symphonia = { features = ["aac", "mp3", "isomp4", "alac"], version = "0.5.2" } symphonia = { features = ["aac", "mp3", "isomp4", "alac"], version = "0.5.2" }
tokio = { features = ["macros", "rt-multi-thread", "signal", "sync"], version = "1" } tokio = { features = ["macros", "rt-multi-thread", "signal", "sync"], version = "1" }
tracing = "0.1" tracing = "0.1"

View File

@@ -38,7 +38,7 @@
//! ```toml //! ```toml
//! # Including songbird alone gives you support for Opus via the DCA file format. //! # Including songbird alone gives you support for Opus via the DCA file format.
//! [dependencies.songbird] //! [dependencies.songbird]
//! version = "0.4" //! version = "0.5"
//! features = ["builtin-queue"] //! features = ["builtin-queue"]
//! //!
//! # To get additional codecs, you *must* add Symphonia yourself. //! # To get additional codecs, you *must* add Symphonia yourself.