Skip to content

Commit cbb70da

Browse files
authored
Post 3.11.1 and 4.1.4 (#1477)
* Update docs for 3.11.1 * Update announcement template * Refer to Stack Overflow tags referenced in README.md. * Clarify SBOM serial number should always be updated * Steps previously suggested it only applied on a non-patch release. The SBOM serial number should be updated on the release branch on all releases. * Update docs for 4.1.4 * Remove redundant DOCSP release step * Fix pattern on macOS BSD `sed` * simplify API doc menu and release table * remove redundant CHANGELOG entries
1 parent 83238b9 commit cbb70da

File tree

6 files changed

+90
-33
lines changed

6 files changed

+90
-33
lines changed

CHANGELOG.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,8 @@ Changes prior to 3.9.0 are documented as [release notes on GitHub](https://githu
1919
- `type_view()` in `bsoncxx::document::element` and `bsoncxx::array::element`: equivalent to `get_value()`.
2020
- `type_value()` in `bsoncxx::document::element` and `bsoncxx::array::element`: equivalent to `get_owning_value()`.
2121

22-
### Fixed
23-
24-
- CMake option `ENABLE_TESTS` (`OFF` by default) is no longer overwritten by the auto-downloaded C Driver (`ON` by default) during CMake configuration.
25-
- `storage_engine() const` in `mongocxx::v_noabi::options::index` is correctly exported using mongocxx export macros instead of bsoncxx export macros.
26-
2722
### Changed
2823

29-
- Bump the minimum required C Driver version to [2.1.0](https://github.com/mongodb/mongo-c-driver/releases/tag/2.1.0).
3024
- CMake 3.16.0 or newer is required when `ENABLE_TESTS=ON` for compatibility with the updated Catch2 library version (3.7.0 -> 3.8.1).
3125
- Minimum supported compiler versions to build from source are updated to the following:
3226
- GCC 8.1 (from GCC 4.8.2).
@@ -72,6 +66,16 @@ Changes prior to 3.9.0 are documented as [release notes on GitHub](https://githu
7266
- See: [MongoDB C Driver 2.1.0 Release Notes](https://github.com/mongodb/mongo-c-driver/releases/tag/2.1.0).
7367
- Support for macOS 11 and macOS 12 (deprecated in 4.1.0).
7468

69+
## 4.1.4
70+
71+
### Changed
72+
73+
- Bump the auto-downloaded C Driver version to [2.1.2](https://github.com/mongodb/mongo-c-driver/releases/tag/2.1.2).
74+
75+
### Changed
76+
77+
- Bump the minimum required C Driver version to [1.30.6](https://github.com/mongodb/mongo-c-driver/releases/tag/1.30.6).
78+
7579
## 4.1.3
7680

7781
### Changed
@@ -172,6 +176,12 @@ Changes prior to 3.9.0 are documented as [release notes on GitHub](https://githu
172176
- `bsoncxx::builder::stream::concatenate` in `<bsoncxx/builder/stream/helpers.hpp>`. Use `bsoncxx::builder::concatenate` in `<bsoncxx/builder/concatenate.hpp>` instead.
173177
- `mongocxx::events::read_preference` in `<mongocxx/events/topology_description.hpp>`. Use `mongocxx::read_preference` in `<mongocxx/read_preference.hpp>` instead.
174178

179+
## 3.11.1
180+
181+
### Fixed
182+
183+
- The API version of auto-downloaded C Driver libraries no longer incorrectly inherits the C++ Driver's `BUILD_VERSION` value.
184+
175185
## 3.11.0
176186

177187
> [!IMPORTANT]

Doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1603,7 +1603,7 @@ TOC_EXPAND = NO
16031603
# protocol see https://www.sitemaps.org
16041604
# This tag requires that the tag GENERATE_HTML is set to YES.
16051605

1606-
SITEMAP_URL = https://mongocxx.org/api/mongocxx-4.1.3/
1606+
SITEMAP_URL = https://mongocxx.org/api/mongocxx-4.1.4/
16071607

16081608
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
16091609
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,12 @@ git clone -b releases/stable https://github.com/mongodb/mongo-cxx-driver.git
2828
| Version | ABI Stability | Development Stability | Development Status |
2929
| :---------: | :-------------: | :-------------------------: | :----------------: |
3030
| master | N/A | _Do not use in production!_ | Active |
31-
| 4.1.3 | None | Ready for Use | Bug Fixes Only |
32-
| 4.1.2 | None | Ready for Use | Not Supported |
33-
| 4.1.1 | None | Ready for Use | Not Supported |
34-
| 4.1.0 | None | Ready for Use | Not Supported |
31+
| 4.1.4 | None | Ready for Use | Bug Fixes Only |
32+
| 4.1.3 | None | Ready for Use | Not Supported |
33+
| ... | ... | ... | ... |
3534
| 4.0.0 | None | Ready for Use | Not Supported |
36-
| 3.11.0 | None | Ready for Use | Bug Fixes Only |
37-
| 3.10.2 | None | Ready for Use | Not Supported |
35+
| 3.11.1 | None | Ready for Use | Bug Fixes Only |
36+
| 3.11.0 | None | Ready for Use | Not Supported |
3837
| ... | ... | ... | ... |
3938
| 3.0.0 | None | Ready for Use | Not Supported |
4039

etc/apidocmenu.md

Lines changed: 49 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,50 @@
22

33
## Driver Documentation By Version
44

5-
[4.1.3](../mongocxx-4.1.3) | [4.1.2](../mongocxx-4.1.2) | [4.1.1](../mongocxx-4.1.1) | [4.1.0](../mongocxx-4.1.0) | [4.0.0](../mongocxx-4.0.0) | [3.11.0](../mongocxx-3.11.0) | [3.10.2](../mongocxx-3.10.2) | [3.10.1](../mongocxx-3.10.1) | [3.10.0](../mongocxx-3.10.0) | [3.9.0](../mongocxx-3.9.0) | [3.8.1](../mongocxx-3.8.1) | [3.8.0](../mongocxx-3.8.0) | [3.7.2](../mongocxx-3.7.2) | [3.7.1](../mongocxx-3.7.1) | [3.7.0](../mongocxx-3.7.0) | [3.6.7](../mongocxx-3.6.7) | [3.6.6](../mongocxx-3.6.6) | [3.6.5](../mongocxx-3.6.5) | [3.6.4](../mongocxx-3.6.4) | [3.6.3](../mongocxx-3.6.3) | [3.6.2](../mongocxx-3.6.2) | [3.6.1](../mongocxx-3.6.1) | [3.6.0](../mongocxx-3.6.0) | [3.5.1](../mongocxx-3.5.1) | [3.5.0](../mongocxx-3.5.0) | [3.4.2](../mongocxx-3.4.2) | [3.4.1](../mongocxx-3.4.1) | [3.4.0](../mongocxx-3.4.0) | [3.3.2](../mongocxx-3.3.2) | [3.3.1](../mongocxx-3.3.1) | [3.3.0](../mongocxx-3.3.0) | [3.2.1](../mongocxx-3.2.1) | [3.2.0](../mongocxx-3.2.0) | [3.1.4](../mongocxx-3.1.4/) | [3.1.3](../mongocxx-3.1.3/) | [3.1.2](../mongocxx-3.1.2/) | [3.1.1](../mongocxx-3.1.1/) | [3.1.0](../mongocxx-3.1.0/) | [3.0.3](../mongocxx-3.0.3/) | [3.0.2](../mongocxx-3.0.2/) | [3.0.1](../mongocxx-3.0.1/) | [3.0.0](../mongocxx-3.0.0/)
5+
[4.1.4](../mongocxx-4.1.4) |
6+
[4.1.3](../mongocxx-4.1.3) |
7+
[4.1.2](../mongocxx-4.1.2) |
8+
[4.1.1](../mongocxx-4.1.1) |
9+
[4.1.0](../mongocxx-4.1.0) |
10+
[4.0.0](../mongocxx-4.0.0) |
11+
[3.11.1](../mongocxx-3.11.1) |
12+
[3.11.0](../mongocxx-3.11.0) |
13+
[3.10.2](../mongocxx-3.10.2) |
14+
[3.10.1](../mongocxx-3.10.1) |
15+
[3.10.0](../mongocxx-3.10.0) |
16+
[3.9.0](../mongocxx-3.9.0) |
17+
[3.8.1](../mongocxx-3.8.1) |
18+
[3.8.0](../mongocxx-3.8.0) |
19+
[3.7.2](../mongocxx-3.7.2) |
20+
[3.7.1](../mongocxx-3.7.1) |
21+
[3.7.0](../mongocxx-3.7.0) |
22+
[3.6.7](../mongocxx-3.6.7) |
23+
[3.6.6](../mongocxx-3.6.6) |
24+
[3.6.5](../mongocxx-3.6.5) |
25+
[3.6.4](../mongocxx-3.6.4) |
26+
[3.6.3](../mongocxx-3.6.3) |
27+
[3.6.2](../mongocxx-3.6.2) |
28+
[3.6.1](../mongocxx-3.6.1) |
29+
[3.6.0](../mongocxx-3.6.0) |
30+
[3.5.1](../mongocxx-3.5.1) |
31+
[3.5.0](../mongocxx-3.5.0) |
32+
[3.4.2](../mongocxx-3.4.2) |
33+
[3.4.1](../mongocxx-3.4.1) |
34+
[3.4.0](../mongocxx-3.4.0) |
35+
[3.3.2](../mongocxx-3.3.2) |
36+
[3.3.1](../mongocxx-3.3.1) |
37+
[3.3.0](../mongocxx-3.3.0) |
38+
[3.2.1](../mongocxx-3.2.1) |
39+
[3.2.0](../mongocxx-3.2.0) |
40+
[3.1.4](../mongocxx-3.1.4/) |
41+
[3.1.3](../mongocxx-3.1.3/) |
42+
[3.1.2](../mongocxx-3.1.2/) |
43+
[3.1.1](../mongocxx-3.1.1/) |
44+
[3.1.0](../mongocxx-3.1.0/) |
45+
[3.0.3](../mongocxx-3.0.3/) |
46+
[3.0.2](../mongocxx-3.0.2/) |
47+
[3.0.1](../mongocxx-3.0.1/) |
48+
[3.0.0](../mongocxx-3.0.0/)
649

750
## Driver Development Status
851

@@ -12,13 +55,12 @@
1255
| Version | ABI Stability | Development Stability | Development Status |
1356
| :---------: | :-------------: | :-------------------------: | :----------------: |
1457
| master | N/A | _Do not use in production!_ | Active |
15-
| 4.1.3 | None | Ready for Use | Bug Fixes Only |
16-
| 4.1.2 | None | Ready for Use | Not Supported |
17-
| 4.1.1 | None | Ready for Use | Not Supported |
18-
| 4.1.0 | None | Ready for Use | Not Supported |
58+
| 4.1.4 | None | Ready for Use | Bug Fixes Only |
59+
| 4.1.3 | None | Ready for Use | Not Supported |
60+
| ... | ... | ... | ... |
1961
| 4.0.0 | None | Ready for Use | Not Supported |
20-
| 3.11.0 | None | Ready for Use | Bug Fixes Only |
21-
| 3.10.2 | None | Ready for Use | Not Supported |
62+
| 3.11.1 | None | Ready for Use | Bug Fixes Only |
63+
| 3.11.0 | None | Ready for Use | Not Supported |
2264
| ... | ... | ... | ... |
2365
| 3.0.0 | None | Ready for Use | Not Supported |
2466

etc/generate-latest-apidocs.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
set -o errexit
1111
set -o pipefail
1212

13-
LATEST_VERSION="4.1.3"
13+
LATEST_VERSION="4.1.4"
1414
DOXYGEN_VERSION_REQUIRED="1.14.0"
1515

1616
# Permit using a custom Doxygen binary.
@@ -71,8 +71,8 @@ else
7171
# - set OUTPUT_DIRECTORY to `build/docs/api/mongocxx-<version>`.
7272
# - set PROJECT_NUMBER to `<version>`.
7373
sed_in_place \
74-
-e "s|^OUTPUT_DIRECTORY\s*=\s*.*$|OUTPUT_DIRECTORY = ${output_directory:?}|g" \
75-
-e "s|^PROJECT_NUMBER\s*=\s*.*$|PROJECT_NUMBER = ${LATEST_VERSION:?}|g" \
74+
-e "s|^OUTPUT_DIRECTORY[[:space:]]*=[[:space:]]*.*$|OUTPUT_DIRECTORY = ${output_directory:?}|g" \
75+
-e "s|^PROJECT_NUMBER[[:space:]]*=[[:space:]]*.*$|PROJECT_NUMBER = ${LATEST_VERSION:?}|g" \
7676
"${scratch_dir:?}/Doxyfile"
7777
fi
7878

etc/releasing.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -377,6 +377,8 @@ Review the contents of the release draft, then publish the release.
377377
Navigate to the
378378
[fixVersions page on Jira](https://jira.mongodb.com/plugins/servlet/project-config/CXX/versions?status=unreleased).
379379

380+
Close the Jira ticket tracking this release with "Documentation Changes" set to "Not Needed". A DOCSP ticket is generated later.
381+
380382
Click the "..." next to the relevant version and select "Release".
381383

382384
### Update GitHub Webhook
@@ -428,6 +430,10 @@ git push upstream releases/vX.Y
428430

429431
The new branch should be continuously tested on Evergreen. Update the "Display Name" and "Branch Name" of the [mongo-cxx-driver-latest-release Evergreen project](https://spruce.mongodb.com/project/mongo-cxx-driver-latest-release/settings/general) to refer to the new release branch.
430432

433+
### Update SBOM serial number
434+
435+
Check out the release branch `releases/vX.Y`.
436+
431437
Update `etc/cyclonedx.sbom.json` with a new unique serial number for the next upcoming patch release (e.g. for `1.3.1` following the release of `1.3.0`):
432438

433439
```bash
@@ -528,25 +534,25 @@ Commit these changes to the `post-release-changes` branch:
528534
git commit -m "Post-release changes"
529535
```
530536

531-
### Create Documentation Tickets
537+
### Update Documentation Ticket
532538

533-
(Stable Releases Only) Close the Jira ticket tracking this release with "Documentation Changes" set to "Needed". Fill the "Documentation Changes Summary" field with information requesting updates to:
539+
When the Jira fixVersion is released, a DOCSP ticket is created and e-mailed to the `dbx-c-cxx` group with subject "Action Required: Relay Compatibility Updates to Docs Team".
534540

535-
- the tables on the [Compatibility](https://www.mongodb.com/docs/languages/cpp/cpp-driver/current/compatibility/) page,
536-
- the "Driver Status by Family and Version" section of the [home
541+
Add a comment requesting updates to:
542+
543+
- (if applicable) the tables on the [Compatibility](https://www.mongodb.com/docs/languages/cpp/cpp-driver/current/compatibility/) page,
544+
- (if applicable) the "Driver Status by Family and Version" section of the [home
537545
page](https://www.mongodb.com/docs/languages/cpp/cpp-driver/current/#driver-status-by-family-and-version), and
538546
- the [full version](https://github.com/mongodb/docs-cpp/blob/master/snooty.toml) for the C++ Driver documentation pages.
539547

540-
This will generate a DOCSP ticket with instructions to update the C++ Driver docs.
541-
542548
Example (using Jira syntax formatting):
543549

544550
```
545551
* The [Compatibility|https://www.mongodb.com/docs/languages/cpp/cpp-driver/current/compatibility/] page must be updated:
546-
- mongocxx-X.Y.Z may change "libmongoc Compatibility" by requiring mongoc-A.B.C or later.
547-
- mongocxx-X.Y.Z should have the same "MongoDB Compatibility", "Language Compatibility", and "Compiler Compatibility" as version mongocxx-X.Y.(Z-1)
552+
** mongocxx-X.Y.Z may change "libmongoc Compatibility" by requiring mongoc-A.B.C or later.
553+
** mongocxx-X.Y.Z should have the same "MongoDB Compatibility", "Language Compatibility", and "Compiler Compatibility" as version mongocxx-X.Y.(Z-1)
548554
* The [MongoDB C++ Driver|https://www.mongodb.com/docs/languages/cpp/cpp-driver/current/#driver-status-by-family-and-version] page must be updated: {{{}mongocxx X.Y.x{}}} is now a previous stable release and no longer under active development; {{{}mongocxx X.Y+1.x{}}} is the new current stable release eligible for bug fixes.
549-
* the [full version|https://github.com/mongodb/docs-cpp/blob/master/snooty.toml] for C++ Driver documentation must be updated to {{{}X.Y.Z{}}}.
555+
* The [full version|https://github.com/mongodb/docs-cpp/blob/master/snooty.toml] for C++ Driver documentation must be updated to {{{}X.Y.Z{}}}.
550556
```
551557

552558
### Publish Updated Documentation
@@ -790,7 +796,7 @@ See the [MongoDB C++ Driver Manual](https://www.mongodb.com/docs/languages/cpp/c
790796

791797
NOTE: The mongocxx X.Y.x series does not promise API or ABI stability across patch releases.
792798

793-
Please feel free to post any questions on the MongoDB Community forum in the [Drivers](https://www.mongodb.com/community/forums/c/data/drivers/7) category tagged with [cxx](https://www.mongodb.com/community/forums/tag/cxx). Bug reports should be filed against the [CXX](https://jira.mongodb.org/projects/CXX) project in the MongoDB JIRA. Your feedback on the C++11 driver is greatly appreciated.
799+
Please feel free to post any questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/mongodb%20c++). Bug reports should be filed against the [CXX](https://jira.mongodb.org/projects/CXX) project in the MongoDB JIRA. Your feedback on the C++11 driver is greatly appreciated.
794800

795801
Sincerely,
796802

0 commit comments

Comments
 (0)