From 12776fc6f869a01f1b559b0edb925ea7180a7d70 Mon Sep 17 00:00:00 2001 From: Kyle Simpson Date: Fri, 8 Jan 2021 11:42:07 +0000 Subject: [PATCH] Release v0.1.0 (#34) * Update dependencies, draft initial structure for changelog. * Full changelog! --- CHANGELOG.md | 161 ++++++++++++++++++ README.md | 11 +- examples/serenity/voice/Cargo.toml | 2 +- .../serenity/voice_events_queue/Cargo.toml | 2 +- examples/serenity/voice_receive/Cargo.toml | 2 +- examples/serenity/voice_storage/Cargo.toml | 2 +- 6 files changed, 175 insertions(+), 5 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..b636703 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,161 @@ +# Changelog + +## [0.1.0] — 2021-01-08 — **Robin** + +We're very excited to publish and announce the first release of Songbird, an async Rust voice library for Discord! +It's been a long time coming, but all the hard work has paid off in bringing the first version of this library to completion. + +Thanks to the following for their contributions: + +- [@acdenisSK] +- [@FelixMcFelix] +- [@Maspenguin] +- [@peppizza] +- [@saanuregh] + +Songbird is based heavily on serenity's `voice` module, which has served as its base design, informed many of the design changes, and paved a lot of the API/protocol research needed. +We'd also like to thank all users who have contributed to this module in the past for laying the groundwork for Songbird: + +- [@Arcterus] +- [@acdenisSK] +- [@Elinvynia] +- [@Erk-] +- [@FelixMcFelix] +- [@Flat] +- [@ForsakenHarmony] +- [@ftriquet] +- [@hiratara] +- [@indiv0] +- [@JellyWX] +- [@Lakelezz] +- [@LikeLakers2] +- [@mendess] +- [@nickelc] +- [@nitsuga5124] +- [@perryprog] +- [@Prof-Bloodstone] +- [@Proximyst] +- [@Roughsketch] +- [@s0lst1ce] +- [@Sreyas-Sreelal] +- [@tarcieri] +- [@vivian] + +### Added + +- [tracks] Tracks: Add TypeMap to Handles. ([@FelixMcFelix]) [c:d42e09f] +- [tracks] Tracks: Allow custom UUID setting (#33) ([@peppizza]) [c:873458d] +- [input] Input: Allow Restartable sources to be lazy ([@FelixMcFelix]) [c:03ae0e7] +- [driver] Driver, Input: Performance & Benchmarks (#27) ([@FelixMcFelix]) [c:504b8df] +- [input] Metadata: Add source_url and thumbnail fields (#28) ([@saanuregh]) [c:700f20d] +- [tracks] TrackHandle: add metadata field (#25) ([@peppizza]) [c:57df3fe] +- [tracks] TrackQueue: Add current_queue method (#16) ([@peppizza]) [c:69acea8] +- [tracks] TrackQueues: Convenience methods and extension (#7) ([@FelixMcFelix]) [c:de65225] +- [docs] Docs: Add a dependencies section in the README (#2) ([@acdenisSK]) [c:047ce03] +- [input] Offer youtube-dlc as an alternative to youtube-dl (#1) ([@peppizza]) [c:6702520] +- [misc] Attempt CI similar to serenity ([@FelixMcFelix]) [c:c5ce107] +- [misc] Add the ISC license ([@acdenisSK]) [c:a778d24] +- [examples] Move examples from the Serenity repository ([@acdenisSK]) [c:f5bf54a] +- [misc] Add a `.gitignore` file as songbird is in its own repository ([@acdenisSK]) [c:ec7f5bc] +- [driver] Implement Songbird driver configuration (#1074) ([@FelixMcFelix]) [c:8b7f388] +- [docs] Document intents for Songbird (#1061) ([@FelixMcFelix]) [c:38a55da] +- [driver] Voice Rework -- Events, Track Queues (#806) ([@FelixMcFelix]) [c:7e4392a] + +### Changed + +- [misc] Chore: Bump to published twilight. ([@FelixMcFelix]) [c:7d767d2] +- [misc] Chore: Bump to published serenity. ([@FelixMcFelix]) [c:53ab9da] +- [misc] Songbird: Tokio 1.0 (#36) ([@FelixMcFelix]) [c:f05b741] +- [docs] Docs: Warn about twilight task deadlock ([@FelixMcFelix]) [c:c0d3cb3] +- [misc] Deps: Patch flume. ([@FelixMcFelix]) [c:2fc88a6] +- [input] Input: Json parsing errors now contain the parsed text (#31) ([@Maspenguin]) [c:8d6bd4f] +- [driver] Driver, Tracks: Cleanup of leaky types (#20) ([@FelixMcFelix]) [c:f222ce9] +- [docs] Docs: Move to new intra-doc links, make events non-exhaustive. (#19) ([@FelixMcFelix]) [c:94157b1] +- [input] Input: Make restartable sources fully async. (#15) ([@FelixMcFelix]) [c:2da5901] +- [misc] Lint: Clippy warning cleanup (#8) ([@peppizza]) [c:cb7d8cc] +- [docs] Docs: describe `youtube-dlc` feature ([@FelixMcFelix]) [c:45b1fb1] +- [misc] Some updated links, move to current/next branches. ([@FelixMcFelix]) [c:09da85b] +- [misc] Remove mentions of versions to Serenity git dependencies ([@acdenisSK]) [c:4a897a7] +- [misc] Update `Cargo.toml` to reflect the separation of songbird from Serenity's repository ([@acdenisSK]) [c:6724655] +- [misc] Update versions for twilight and serenity-voice-model in songbird (#1075) ([@FelixMcFelix]) [c:868785b] + +### Fixed + +- [driver] Driver: Handle receiving large non-standard packets (#23) ([@FelixMcFelix]) [c:9fdbcd7] +- [misc] Fix: Remove serenity default features (#18) ([@Maspenguin]) [c:1ada46d] +- [driver] Fix: Use correct tokio features for driver-only mode ([@FelixMcFelix]) [c:a9f8d6c] +- [misc] CI round 2 ([@FelixMcFelix]) [c:35d262d] +- [examples] Fix links in the README regarding examples ([@acdenisSK]) [c:4f5b767] +- [driver] Handle Voice close codes, prevent Songbird spinning WS threads (#1068) ([@FelixMcFelix]) [c:26c9c91] + + +[0.1.0]: https://github.com/serenity-rs/songbird/compare/v0.0.1...v0.1.0 + + +[@acdenisSK]: https://github.com/acdenisSK +[@Arcterus]: https://github.com/Arcterus +[@Elinvynia]: https://github.com/Elinvynia +[@Erk-]: https://github.com/Erk- +[@FelixMcFelix]: https://github.com/FelixMcFelix +[@Flat]: https://github.com/Flat +[@ForsakenHarmony]: https://github.com/ForsakenHarmony +[@ftriquet]: https://github.com/ftriquet +[@hiratara]: https://github.com/hiratara +[@indiv0]: https://github.com/indiv0 +[@JellyWX]: https://github.com/JellyWX +[@Lakelezz]: https://github.com/Lakelezz +[@LikeLakers2]: https://github.com/LikeLakers2 +[@Maspenguin]: https://github.com/Maspenguin +[@mendess]: https://github.com/mendess +[@nickelc]: https://github.com/nickelc +[@nitsuga5124]: https://github.com/nitsuga5124 +[@peppizza]: https://github.com/peppizza +[@perryprog]: https://github.com/perryprog +[@Prof-Bloodstone]: https://github.com/Prof-Bloodstone +[@Proximyst]: https://github.com/Proximyst +[@Roughsketch]: https://github.com/Roughsketch +[@saanuregh]: https://github.com/saanuregh +[@s0lst1ce]: https://github.com/s0lst1ce +[@Sreyas-Sreelal]: https://github.com/Sreyas-Sreelal +[@tarcieri]: https://github.com/tarcieri +[@vivian]: https://github.com/vivian + + +[c:7d767d2]: https://github.com/FelixMcFelix/songbird/commit/7d767d29196a5f1905a720bbebfec02ca1acc211 +[c:53ab9da]: https://github.com/FelixMcFelix/songbird/commit/53ab9dac03d0824d9787b827ac829f9ccd789649 +[c:f05b741]: https://github.com/FelixMcFelix/songbird/commit/f05b7414a0ec52404019dce9530b380d71e41f3b +[c:d42e09f]: https://github.com/FelixMcFelix/songbird/commit/d42e09f72b825ca45ba3e08cf0614eef9acecca1 +[c:873458d]: https://github.com/FelixMcFelix/songbird/commit/873458d28872d9b4106c78938b1ba698bd55f93c +[c:03ae0e7]: https://github.com/FelixMcFelix/songbird/commit/03ae0e7628efd68038ac76c9110e9e8aad99b7c0 +[c:c0d3cb3]: https://github.com/FelixMcFelix/songbird/commit/c0d3cb31130ebeece6acb1b68cf366a57196d244 +[c:504b8df]: https://github.com/FelixMcFelix/songbird/commit/504b8dfaefb71770f9b5c8cb6d0b1d6e0881f085 +[c:2fc88a6]: https://github.com/FelixMcFelix/songbird/commit/2fc88a6ef1f950c17a076dd6e6c2f85f99607962 +[c:8d6bd4f]: https://github.com/FelixMcFelix/songbird/commit/8d6bd4fd637be2c50403062f6f7e462b36647687 +[c:700f20d]: https://github.com/FelixMcFelix/songbird/commit/700f20dff9211e81f170df115433bafe113639f0 +[c:f222ce9]: https://github.com/FelixMcFelix/songbird/commit/f222ce99696ab0dfa396bd6448bb4340b791625b +[c:9fdbcd7]: https://github.com/FelixMcFelix/songbird/commit/9fdbcd77be98be7a7ac20dd6901f934934fef6e6 +[c:57df3fe]: https://github.com/FelixMcFelix/songbird/commit/57df3fe53a0d56da38bf1b0a0198af8904f054cf +[c:94157b1]: https://github.com/FelixMcFelix/songbird/commit/94157b12bcad4f770cffd182609af5e6ac7f823d +[c:1ada46d]: https://github.com/FelixMcFelix/songbird/commit/1ada46d24bde47b9ab3aede425f06257e6b38fb3 +[c:69acea8]: https://github.com/FelixMcFelix/songbird/commit/69acea866465ce9745f5c4f0aeac0eb6a4d91a49 +[c:2da5901]: https://github.com/FelixMcFelix/songbird/commit/2da5901930ea9a97a5101738acacbe4a7570ec55 +[c:cb7d8cc]: https://github.com/FelixMcFelix/songbird/commit/cb7d8cc6180f1aa5ab284cb60204a6b2de3b6f28 +[c:de65225]: https://github.com/FelixMcFelix/songbird/commit/de652250d8ce22ccab5ff45addf3f26230d18b05 +[c:047ce03]: https://github.com/FelixMcFelix/songbird/commit/047ce0379a36011c3901d698caab8d67d4a8327d +[c:45b1fb1]: https://github.com/FelixMcFelix/songbird/commit/45b1fb13bf10f9273de83d25bdd9b650d97e549a +[c:6702520]: https://github.com/FelixMcFelix/songbird/commit/6702520b7c9be819fcbec4a2b4263b459596ff81 +[c:a9f8d6c]: https://github.com/FelixMcFelix/songbird/commit/a9f8d6c93a9b003f004cddba0532653f4f374f4b +[c:35d262d]: https://github.com/FelixMcFelix/songbird/commit/35d262d9466a57a7e1e7ec8b6dbd745066aede31 +[c:c5ce107]: https://github.com/FelixMcFelix/songbird/commit/c5ce107d55f74b54b400f8a5513418436cc7e4f2 +[c:09da85b]: https://github.com/FelixMcFelix/songbird/commit/09da85bfc373689d022e263e9e72869493ebd654 +[c:a778d24]: https://github.com/FelixMcFelix/songbird/commit/a778d2494166617a0684fdd71825031bdcefee3c +[c:4f5b767]: https://github.com/FelixMcFelix/songbird/commit/4f5b767dba218be4f5cda672603e143c043c5d77 +[c:f5bf54a]: https://github.com/FelixMcFelix/songbird/commit/f5bf54a63d41474e3776a89306fcfc7bb2806712 +[c:4a897a7]: https://github.com/FelixMcFelix/songbird/commit/4a897a7b76d28c5d8facc238e3fcf188ddddd04e +[c:ec7f5bc]: https://github.com/FelixMcFelix/songbird/commit/ec7f5bca2db903caa6c9b007567c63863e311224 +[c:6724655]: https://github.com/FelixMcFelix/songbird/commit/67246553515a5f59a24eee892bbcb2b1781c822c +[c:868785b]: https://github.com/FelixMcFelix/songbird/commit/868785ba715bd26f690c1f6beff83bb98967f979 +[c:8b7f388]: https://github.com/FelixMcFelix/songbird/commit/8b7f388f7bb4464cb786f9046dfd841fbe93857b +[c:26c9c91]: https://github.com/FelixMcFelix/songbird/commit/26c9c9117c5c71fc0a3d654ad4cef70f60beb878 +[c:38a55da]: https://github.com/FelixMcFelix/songbird/commit/38a55da88bb61d862fa471e2d7b9a222c230f1cb +[c:7e4392a]: https://github.com/FelixMcFelix/songbird/commit/7e4392ae68f97311f2389fdf8835e70a25912ff3 diff --git a/README.md b/README.md index 69f5e3e..120d863 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![docs-badge][]][docs] [![build badge]][build] +[![docs-badge][]][docs] [![build badge]][build] [![guild-badge][]][guild] [![crates.io version]][crates.io link] [![rust 1.48.0+ badge]][rust 1.48.0+ link] # Songbird @@ -60,3 +60,12 @@ Songbird's logo is based upon the copyright-free image ["Black-Capped Chickadee" [docs-badge]: https://img.shields.io/badge/docs-online-4d76ae.svg?style=flat-square [docs]: https://serenity-rs.github.io/songbird/current + +[guild]: https://discord.gg/9X7vCus +[guild-badge]: https://img.shields.io/discord/381880193251409931.svg?style=flat-square&colorB=7289DA + +[crates.io link]: https://crates.io/crates/songbird +[crates.io version]: https://img.shields.io/crates/v/songbird.svg?style=flat-square + +[rust 1.48.0+ badge]: https://img.shields.io/badge/rust-1.48.0+-93450a.svg?style=flat-square +[rust 1.48.0+ link]: https://blog.rust-lang.org/2020/11/19/Rust-1.48.html diff --git a/examples/serenity/voice/Cargo.toml b/examples/serenity/voice/Cargo.toml index d8e35b6..d190a4b 100644 --- a/examples/serenity/voice/Cargo.toml +++ b/examples/serenity/voice/Cargo.toml @@ -13,7 +13,7 @@ tracing-futures = "0.2" path = "../../../" [dependencies.serenity] -version = "0.10.0" +version = "0.10" features = ["client", "standard_framework", "voice", "rustls_backend"] [dependencies.tokio] diff --git a/examples/serenity/voice_events_queue/Cargo.toml b/examples/serenity/voice_events_queue/Cargo.toml index 006bf00..53feda0 100644 --- a/examples/serenity/voice_events_queue/Cargo.toml +++ b/examples/serenity/voice_events_queue/Cargo.toml @@ -14,7 +14,7 @@ features = ["builtin-queue"] path = "../../../" [dependencies.serenity] -version = "0.10.0" +version = "0.10" features = ["cache", "standard_framework", "voice", "rustls_backend"] [dependencies.tokio] diff --git a/examples/serenity/voice_receive/Cargo.toml b/examples/serenity/voice_receive/Cargo.toml index 46777cd..9f48616 100644 --- a/examples/serenity/voice_receive/Cargo.toml +++ b/examples/serenity/voice_receive/Cargo.toml @@ -13,7 +13,7 @@ tracing-futures = "0.2" path = "../../../" [dependencies.serenity] -version = "0.10.0" +version = "0.10" features = ["client", "standard_framework", "voice", "rustls_backend"] [dependencies.tokio] diff --git a/examples/serenity/voice_storage/Cargo.toml b/examples/serenity/voice_storage/Cargo.toml index 3a96af8..ce34dee 100644 --- a/examples/serenity/voice_storage/Cargo.toml +++ b/examples/serenity/voice_storage/Cargo.toml @@ -13,7 +13,7 @@ tracing-futures = "0.2" path = "../../../" [dependencies.serenity] -version = "0.10.0" +version = "0.10" features = ["cache", "framework", "standard_framework", "voice", "http", "rustls_backend"] [dependencies.tokio]