From 04961ad135ef5bab0cab9f485ff2cd398d52f58c Mon Sep 17 00:00:00 2001 From: Angela Shu Date: Wed, 10 Jul 2024 11:58:33 -0400 Subject: [PATCH 1/5] release notes for 3.0 and 3.1 --- config/redirects | 2 +- snooty.toml | 4 ++-- .../mongodb-compatibility-table-rust.rst | 8 ++++++++ source/whats-new.txt | 20 +++++++++++++++++++ 4 files changed, 31 insertions(+), 3 deletions(-) diff --git a/config/redirects b/config/redirects index 18ec6d26..28d9091c 100644 --- a/config/redirects +++ b/config/redirects @@ -1,6 +1,6 @@ define: prefix docs/drivers/rust define: base https://www.mongodb.com/${prefix} -define: versions v2.7 v2.8 master +define: versions v2.7 v2.8 v3.0 master symlink: current -> master diff --git a/snooty.toml b/snooty.toml index 61c98a9f..8e54e0e0 100644 --- a/snooty.toml +++ b/snooty.toml @@ -21,10 +21,10 @@ driver-long = "MongoDB Rust Driver" driver-short = "Rust driver" server = "MongoDB Server" docs-branch = "master" # always set this to the docs branch (i.e. master, v2.6, v2.5, etc.) -version = "2.8.2" # always set this to the driver version (i.e. 2.6.0, 2.5.0, etc.) +version = "3.0.1" # always set this to the driver version (i.e. 2.6.0, 2.5.0, etc.) min-rust-version = "1.60" # always set this to the minimum supported Rust version api = "https://docs.rs/mongodb/{+version+}/mongodb" -bson-version = "2.8.0" +bson-version = "2.11.0" bson-api = "https://docs.rs/bson/{+bson-version+}/bson" stable-api = "Stable API" tracing-version = "0.1.37" diff --git a/source/includes/mongodb-compatibility-table-rust.rst b/source/includes/mongodb-compatibility-table-rust.rst index 27a38336..49c1949d 100644 --- a/source/includes/mongodb-compatibility-table-rust.rst +++ b/source/includes/mongodb-compatibility-table-rust.rst @@ -11,6 +11,14 @@ - MongoDB 4.2 - MongoDB 4.0 - MongoDB 3.6 + * - 3.0 [#2.5-onwards-limitation]_ + - ⊛ + - ✓ + - ✓ + - ✓ + - ✓ + - ✓ + - ✓ * - 2.8 [#2.5-onwards-limitation]_ - ⊛ - ✓ diff --git a/source/whats-new.txt b/source/whats-new.txt index ee190f43..5d8d395c 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -20,11 +20,31 @@ What's New Learn about new features, improvements, and fixes introduced in the following versions of the {+driver-long+}: +* :ref:`Version 3.0.1 ` * :ref:`Version 3.0 ` * :ref:`Version 2.8 ` * :ref:`Version 2.7 ` * :ref:`Version 2.6 ` +.. _rust-version-3.0.1: + +What's New in 3.0.1 +--------------------- + +The {+driver-short+} v3.0.1 release includes the following features, +improvements, and fixes: + +- Fixes issue where aggregations with both explicit sessions and custom types + wouldn't compile. + +- Fixes issue where ``Collection::watch`` didn't use the ``Collection`` type + parameter. + +To learn more about this release, see the +`v3.0.1 Release Notes +`__ +on GitHub. + .. _rust-version-3.0: What's New in 3.0 From 22d2fe9b1ddff5db93068802e506b852007304b4 Mon Sep 17 00:00:00 2001 From: Angela Shu Date: Wed, 10 Jul 2024 14:31:11 -0400 Subject: [PATCH 2/5] update based on review --- snooty.toml | 1 + source/whats-new.txt | 17 ++++++++--------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/snooty.toml b/snooty.toml index 8e54e0e0..4ebe384c 100644 --- a/snooty.toml +++ b/snooty.toml @@ -29,3 +29,4 @@ bson-api = "https://docs.rs/bson/{+bson-version+}/bson" stable-api = "Stable API" tracing-version = "0.1.37" tracing-sub-version = "0.3.17" +driver-source = "https://github.com/mongodb/mongo-rust-driver/" diff --git a/source/whats-new.txt b/source/whats-new.txt index 5d8d395c..77727d85 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -34,15 +34,14 @@ What's New in 3.0.1 The {+driver-short+} v3.0.1 release includes the following features, improvements, and fixes: -- Fixes issue where aggregations with both explicit sessions and custom types - wouldn't compile. +- Fixes an issue in which aggregations run within explicit sessions which also used custom types wouldn't compile. -- Fixes issue where ``Collection::watch`` didn't use the ``Collection`` type - parameter. +- Fixes an issue in which the ``Collection::watch()`` method didn't use the type + parameter of the ``Collection`` instance it was run on. To learn more about this release, see the `v3.0.1 Release Notes -`__ +<{+driver-source+}releases/tag/v3.0.1>`__ on GitHub. .. _rust-version-3.0: @@ -101,7 +100,7 @@ The {+driver-short+} v3.0 release includes the following features, improvements, structs. To learn more about this release, see the `v3.0 Migration Guide -`__ +<{+driver-source+}blob/main/migration-3.0.md>`__ on GitHub. .. _rust-version-2.8: @@ -126,7 +125,7 @@ improvements, and fixes: To learn more about this release, see the `v2.8.0 Release Highlights -`__ +<{+driver-source+}releases/tag/v2.8.0>`__ on GitHub. .. _rust-version-2.7: @@ -176,7 +175,7 @@ improvements, and fixes: To learn more about this release, see the `v2.7.0 Release Highlights -`__ +<{+driver-source+}releases/tag/v2.7.0>`__ on GitHub. .. _rust-version-2.6: @@ -211,5 +210,5 @@ improvements, and fixes: To learn more about this release, see the `v2.6.0 Release Highlights -`__ +<{+driver-source+}releases/tag/v2.6.0>`__ on GitHub. From 3210159987e82c4096965dc5cee9e2621228947d Mon Sep 17 00:00:00 2001 From: Angela Shu Date: Wed, 10 Jul 2024 14:51:52 -0400 Subject: [PATCH 3/5] fix spacing --- source/whats-new.txt | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/source/whats-new.txt b/source/whats-new.txt index 77727d85..3b88162b 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -37,11 +37,9 @@ improvements, and fixes: - Fixes an issue in which aggregations run within explicit sessions which also used custom types wouldn't compile. - Fixes an issue in which the ``Collection::watch()`` method didn't use the type - parameter of the ``Collection`` instance it was run on. + parameter of the ``Collection`` instance it was run on. -To learn more about this release, see the -`v3.0.1 Release Notes -<{+driver-source+}releases/tag/v3.0.1>`__ +To learn more about this release, see the `v3.0.1 Release Notes <{+driver-source+}releases/tag/v3.0.1>`__ on GitHub. .. _rust-version-3.0: From a3d1c2ab4f36f604305871a42f0779c5ba4b22c0 Mon Sep 17 00:00:00 2001 From: Angela Shu Date: Wed, 10 Jul 2024 15:51:27 -0400 Subject: [PATCH 4/5] apply review --- snooty.toml | 2 +- source/whats-new.txt | 13 +++++++------ 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/snooty.toml b/snooty.toml index 4ebe384c..f483dad0 100644 --- a/snooty.toml +++ b/snooty.toml @@ -29,4 +29,4 @@ bson-api = "https://docs.rs/bson/{+bson-version+}/bson" stable-api = "Stable API" tracing-version = "0.1.37" tracing-sub-version = "0.3.17" -driver-source = "https://github.com/mongodb/mongo-rust-driver/" +driver-source = "https://github.com/mongodb/mongo-rust-driver" diff --git a/source/whats-new.txt b/source/whats-new.txt index 3b88162b..35f7de6a 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -34,12 +34,13 @@ What's New in 3.0.1 The {+driver-short+} v3.0.1 release includes the following features, improvements, and fixes: -- Fixes an issue in which aggregations run within explicit sessions which also used custom types wouldn't compile. +- Fixes an issue in which aggregations wouldn't compile when run within explicit + sessions and also implemented used custom types. - Fixes an issue in which the ``Collection::watch()`` method didn't use the type parameter of the ``Collection`` instance it was run on. -To learn more about this release, see the `v3.0.1 Release Notes <{+driver-source+}releases/tag/v3.0.1>`__ +To learn more about this release, see the `v3.0.1 Release Notes <{+driver-source+}/releases/tag/v3.0.1>`__ on GitHub. .. _rust-version-3.0: @@ -98,7 +99,7 @@ The {+driver-short+} v3.0 release includes the following features, improvements, structs. To learn more about this release, see the `v3.0 Migration Guide -<{+driver-source+}blob/main/migration-3.0.md>`__ +<{+driver-source+}/blob/main/migration-3.0.md>`__ on GitHub. .. _rust-version-2.8: @@ -123,7 +124,7 @@ improvements, and fixes: To learn more about this release, see the `v2.8.0 Release Highlights -<{+driver-source+}releases/tag/v2.8.0>`__ +<{+driver-source+}/releases/tag/v2.8.0>`__ on GitHub. .. _rust-version-2.7: @@ -173,7 +174,7 @@ improvements, and fixes: To learn more about this release, see the `v2.7.0 Release Highlights -<{+driver-source+}releases/tag/v2.7.0>`__ +<{+driver-source+}/releases/tag/v2.7.0>`__ on GitHub. .. _rust-version-2.6: @@ -208,5 +209,5 @@ improvements, and fixes: To learn more about this release, see the `v2.6.0 Release Highlights -<{+driver-source+}releases/tag/v2.6.0>`__ +<{+driver-source+}/releases/tag/v2.6.0>`__ on GitHub. From 907bc89170179c66a9b78e28f8093f4b0463e6ad Mon Sep 17 00:00:00 2001 From: Angela Shu Date: Wed, 10 Jul 2024 15:58:56 -0400 Subject: [PATCH 5/5] fix typo --- source/whats-new.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/whats-new.txt b/source/whats-new.txt index 35f7de6a..914c30b7 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -35,7 +35,7 @@ The {+driver-short+} v3.0.1 release includes the following features, improvements, and fixes: - Fixes an issue in which aggregations wouldn't compile when run within explicit - sessions and also implemented used custom types. + sessions and also implemented custom types. - Fixes an issue in which the ``Collection::watch()`` method didn't use the type parameter of the ``Collection`` instance it was run on.