Skip to content

Commit cf10718

Browse files
committed
Avoid creating two DOCSP tickets
And fix Jira formatting
1 parent 70f6f98 commit cf10718

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

etc/releasing.md

Lines changed: 11 additions & 9 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
@@ -532,25 +534,25 @@ Commit these changes to the `post-release-changes` branch:
532534
git commit -m "Post-release changes"
533535
```
534536

535-
### Create Documentation Tickets
537+
### Update Documentation Ticket
538+
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".
536540

537-
(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:
541+
Add a comment requesting updates to:
538542

539-
- the tables on the [Compatibility](https://www.mongodb.com/docs/languages/cpp/cpp-driver/current/compatibility/) page,
540-
- the "Driver Status by Family and Version" section of the [home
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
541545
page](https://www.mongodb.com/docs/languages/cpp/cpp-driver/current/#driver-status-by-family-and-version), and
542546
- the [full version](https://github.com/mongodb/docs-cpp/blob/master/snooty.toml) for the C++ Driver documentation pages.
543547

544-
This will generate a DOCSP ticket with instructions to update the C++ Driver docs.
545-
546548
Example (using Jira syntax formatting):
547549

548550
```
549551
* The [Compatibility|https://www.mongodb.com/docs/languages/cpp/cpp-driver/current/compatibility/] page must be updated:
550-
- mongocxx-X.Y.Z may change "libmongoc Compatibility" by requiring mongoc-A.B.C or later.
551-
- 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)
552554
* 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.
553-
* 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{}}}.
554556
```
555557

556558
### Publish Updated Documentation

0 commit comments

Comments
 (0)