From eb734774557bafd008e21fbde2db883c780efb6f Mon Sep 17 00:00:00 2001 From: Andrey Brusnik Date: Sat, 20 Jul 2024 21:19:09 +0400 Subject: [PATCH 1/3] Add "Bumping supported TBA version" checklist for contributors --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 06b9d35d..6e10503c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -93,6 +93,17 @@ cargo test --features "full nightly" cargo docs ``` +### Bumping supported TBA version + +When you introduce changes that bump suppported Telegram Bot API version (e.g. 6.9 → 7.0), you must: + +- Specify your changes in [crates/teloxide-core/CHANGELOG.md](crates/teloxide-core/CHANGELOG.md) file +- Change TBA version and it's announce date in `api_version: ApiVersion(ver: "7.0", date: "December 29, 2023"),` line in head of [crates/teloxide-core/schema.ron](crates/teloxide-core/schema.ron) file +- Change TBA version in `(Currently, version … is supported)` line in head of [crates/teloxide-core/src/lib.rs](crates/teloxide-core/src/lib.rs) file +- Change TBA version in `Currently, version … of` line in head of [crates/teloxide/src/lib.rs](crates/teloxide/src/lib.rs) file +- Change TBA version in `…https://img.shields.io/badge/API%20coverage…` line in [crates/teloxide-core/README.md](crates/teloxide-core/README.md) file +- Change TBA version in `…https://img.shields.io/badge/API%20coverage…` line in [README.md](README.md) file + ## @teloxidebot `teloxide` uses @teloxidebot as a helper to manage PRs and issues. It is based on triagebot used by rustc developers, which docs can be found [here](https://forge.rust-lang.org/triagebot/index.html). From ad28965d350e8fece9a2198ff8a04526055274d8 Mon Sep 17 00:00:00 2001 From: Andrey Brusnik Date: Sat, 20 Jul 2024 21:20:03 +0400 Subject: [PATCH 2/3] Bump supported TBA version in teloxide-core docs --- crates/teloxide-core/src/lib.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crates/teloxide-core/src/lib.rs b/crates/teloxide-core/src/lib.rs index d01f1f15..a2b8f688 100644 --- a/crates/teloxide-core/src/lib.rs +++ b/crates/teloxide-core/src/lib.rs @@ -1,7 +1,7 @@ //! Core part of the [`teloxide`] library. //! //! This library provides tools for making requests to the [Telegram Bot API] -//! (Currently, version `6.6` is supported) with ease. The library is fully +//! (Currently, version `6.9` is supported) with ease. The library is fully //! asynchronous and built using [`tokio`]. //! //!```toml From e6796d48eb055cafc31b073619a7968f40542e7f Mon Sep 17 00:00:00 2001 From: Andrey Brusnik Date: Sat, 20 Jul 2024 21:20:43 +0400 Subject: [PATCH 3/3] Add current supported TBA version to the teloxide docs --- crates/teloxide/src/lib.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/crates/teloxide/src/lib.rs b/crates/teloxide/src/lib.rs index 9a2ebeb3..7be22d58 100644 --- a/crates/teloxide/src/lib.rs +++ b/crates/teloxide/src/lib.rs @@ -1,6 +1,7 @@ //! A full-featured framework that empowers you to easily build [Telegram bots] //! using [Rust]. It handles all the difficult stuff so you can focus only on -//! your business logic. +//! your business logic. Currently, version `6.9` of [Telegram Bot API] is +//! supported. //! //! For a high-level overview, see [our GitHub repository](https://github.com/teloxide/teloxide). //! @@ -31,6 +32,7 @@ //! //! //! +//! [Telegram Bot API]: https://core.telegram.org/bots/api //! [Telegram bots]: https://telegram.org/blog/bot-revolution //! [`async`/`.await`]: https://rust-lang.github.io/async-book/01_getting_started/01_chapter.html //! [Rust]: https://www.rust-lang.org/