Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 40974b5

Browse files
kevinAlbseramongodb
andauthored
Update release instructions (#1424)
* fix `sed` command on macOS * remove unnecessary heading The `pre-release-changes` branch is only created for the non-patch release steps. Combine the step within non-patch release steps. * change "will" to "may" A new branch is only created for a non-patch release. * use X.Y For consistency with other version placeholders * fix link in documentation changes needed Previous link is not published for newer releases after (latest is 3.10.0). * do not include next patch release on master branch I do not expect upcoming patch release notes will be added on the master branch. Patch releases are tracked on release branches. --------- Co-authored-by: Ezra Chung <88335979+eramongodb@users.noreply.github.com>
1 parent 0d350d4 commit 40974b5

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

‎etc/generate-latest-apidocs.sh

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,19 @@ else
5757

5858
git clone -q -c advice.detachedHead=false -b "r${LATEST_VERSION}" . "${scratch_dir:?}"
5959

60+
function sed_in_place {
61+
if [[ "${OSTYPE}" == darwin* ]]; then
62+
# macOS uses FreeBSD sed.
63+
sed -i '' "$@"
64+
else
65+
sed -i'' "$@"
66+
fi
67+
}
68+
6069
# Update the Doxyfile configuration file:
6170
# - set OUTPUT_DIRECTORY to `build/docs/api/mongocxx-<version>`.
6271
# - set PROJECT_NUMBER to `<version>`.
63-
sed -i'' \
72+
sed_in_place \
6473
-e "s|^OUTPUT_DIRECTORY\s*=\s*.*$|OUTPUT_DIRECTORY = ${output_directory:?}|g" \
6574
-e "s|^PROJECT_NUMBER\s*=\s*.*$|PROJECT_NUMBER = ${LATEST_VERSION:?}|g" \
6675
"${scratch_dir:?}/Doxyfile"

‎etc/releasing.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -264,8 +264,6 @@ Commit the updates to `etc/apidocmenu.md` and `CHANGELOG.md`.
264264
git commit -m 'Update CHANGELOG for X.Y.Z'
265265
```
266266

267-
### Pre-Release Changes PR
268-
269267
Push the `pre-release-changes` branch to a fork repository and create a PR to merge `pre-release-changes` onto `master`:
270268

271269
```bash
@@ -302,7 +300,7 @@ source "$UV_PROJECT_ENVIRONMENT/bin/activate"
302300
```
303301

304302
> [!NOTE]
305-
> A new release branch `releases/vX.Y` will be created later as part of post-release steps.
303+
> A new release branch `releases/vX.Y` may be created later as part of post-release steps.
306304
307305
### Run etc/make_release.py
308306

@@ -561,8 +559,7 @@ git commit -m "Post-release changes"
561559

562560
(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:
563561

564-
- the "Installing the MongoDB C Driver" section of the [Advanced Configuration and Installation Options](https://www.mongodb.com/docs/languages/cpp/cpp-driver/current/installation/advanced/#installing-the-mongodb-c-driver) page
565-
with any new C Driver version requirements,
562+
- the tables on the [Compatibility](https://www.mongodb.com/docs/languages/cpp/cpp-driver/current/compatibility/) page,
566563
- the "Driver Status by Family and Version" section of the [home
567564
page](https://www.mongodb.com/docs/languages/cpp/cpp-driver/current/#driver-status-by-family-and-version), and
568565
- the [full version](https://github.com/mongodb/docs-cpp/blob/master/snooty.toml) for the C++ Driver documentation pages.
@@ -572,7 +569,9 @@ This will generate a DOCSP ticket with instructions to update the C++ Driver doc
572569
Example (using Jira syntax formatting):
573570

574571
```
575-
* The [Advanced Installation|https://www.mongodb.com/docs/languages/cpp/cpp-driver/current/installation/advanced/#installing-the-mongodb-c-driver] page must be updated with a new requirement: "For mongocxx-X.Y.x, mongoc A.B.C or later is required."
572+
* The [Compatibility|https://www.mongodb.com/docs/languages/cpp/cpp-driver/current/compatibility/] page must be updated:
573+
- mongocxx-X.Y.Z may change "libmongoc Compatibility" by requiring mongoc-A.B.C or later.
574+
- mongocxx-X.Y.Z should have the same "MongoDB Compatibility", "Language Compatibility", and "Compiler Compatibility" as version mongocxx-X.Y.(Z-1)
576575
* 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.
577576
* the [full version|https://github.com/mongodb/docs-cpp/blob/master/snooty.toml] for C++ Driver documentation must be updated to {{{}X.Y.Z{}}}.
578577
```
@@ -735,10 +734,6 @@ Sync the entries in the patch release section to be consistent with the entries
735734
<!-- Will contain entries for the next minor release. -->
736735
<!-- Ensure any existing entries are not removed during the sync. -->
737736

738-
## 1.2.4 [Unreleased]
739-
740-
<!-- Will contain entries for the next patch release. -->
741-
742737
## 1.2.3 <!-- Just released. -->
743738

744739
<!-- Ensure these entries match those in the release. -->
@@ -820,7 +815,7 @@ Please note that this version of mongocxx requires [MongoDB C Driver A.B.C](http
820815

821816
See the [MongoDB C++ Driver Manual](https://www.mongodb.com/docs/languages/cpp/cpp-driver/current/) and the [Driver Installation Instructions](https://www.mongodb.com/docs/languages/cpp/cpp-driver/current/installation/) for more details on downloading, installing, and using this driver.
822817

823-
NOTE: The mongocxx 3.10.x series does not promise API or ABI stability across patch releases.
818+
NOTE: The mongocxx X.Y.x series does not promise API or ABI stability across patch releases.
824819

825820
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.
826821

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /