Skip to content

Commit d0fa699

Browse files
xdgxdg
committed
minor: Update mongocxx release instructions
1 parent a53ebce commit d0fa699

File tree

1 file changed

+100
-31
lines changed

1 file changed

+100
-31
lines changed

‎docs/content/contributing/mongocxx-release-guide.md‎

Lines changed: 100 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,27 @@ title = "Releasing the mongocxx driver"
88

99
## Releasing the mongocxx driver
1010

11-
## Confirm Version Status in Jira
12-
13-
- Ensure that all tickets under the version to be released are in
14-
'Resolved' status on the C++ Driver [project
15-
page](https://jira.mongodb.org/browse/CXX/?selectedTab=com.atlassian.jira.jira-projects-plugin:versions-panel)
11+
## Update fixVersion Status in Jira tickets
12+
13+
* Ensure that all tickets under the version to be released are in
14+
'Closed' status on the C++ Driver [roadmap
15+
page](https://jira.mongodb.org/browse/CXX/?selectedTab=com.atlassian.jira.jira-projects-plugin:roadmap-panel)
16+
* Bulk change **Closed** tickets going into the release to include a `fixVersion`
17+
corresponding to the release (create it if necessary):
18+
* For pre-release candidates, **add** the `fixVersion` to any existing
19+
scheduling `fixVersion`.
20+
* For a final release, **replace** all existing `fixVersion` entries (rc or
21+
scheduling) with the release version.
22+
23+
## Audit Jira ticket titles and types for use in release notes
24+
25+
* From the [roadmap page](https://jira.mongodb.org/browse/CXX/?selectedTab=com.atlassian.jira.jira-projects-plugin:roadmap-panel)
26+
click the "Release Notes" link to see a summary of tickets to be included
27+
in release notes.
28+
* Update the ticket type and title as appropriate. User-facing issues
29+
should generally be either "Bug" or "New Feature". Non-user facing
30+
issues should generally be "Task" tickets (and will be omitted later, so
31+
you can ignore them here).
1632

1733
## Create a BUMP commit
1834

@@ -53,17 +69,21 @@ git push origin r3.0.1
5369

5470
## Draft & Publish GitHub Release Notes
5571

56-
* Hit up the [GitHub releases
57-
page](https://github.com/mongodb/mongo-cxx-driver/releases)
58-
* Copy the previous announcement and modify with release-specific information
59-
* The "Known Issues", "Bug", and "Improvement" sections are generated by JIRA. Click on the specific version of the [C++ Driver Project](https://jira.mongodb.org/browse/CXX/?selectedTab=com.atlassian.jira.jira-projects-plugin:versions-panel) and on the version Summary page there is a link for "Release Notes" where you can copy the HTML and paste it into the GitHub Release Notes markdown.
60-
* Draft and publish a new release against the tag you just pushed
72+
* Go to the [GitHub releases page](https://github.com/mongodb/mongo-cxx-driver/releases).
73+
* Copy the previous announcement text for reuse.
74+
* Click "Draft a New Release" and set the title and tag. Check the
75+
"This is a pre-release" checkbox if appropriate.
76+
* Paste the previous announcement and modify with release-specific information
77+
* Go back to the "Release Notes" page in Jira; copy the HTML and paste it into
78+
the GitHub Release Notes markdown. Delete the "Task" section and any
79+
other information that doesn't need to be in the release notes.
80+
* Preview the release text and proofread it.
81+
* Publish the release.
6182

6283
## Release the Version in Jira
6384

6485
* Go
6586
[here](https://jira.mongodb.org/plugins/servlet/project-config/CXX/versions)
66-
* Close all the the Resolved tickets via a [bulk transition](https://confluence.atlassian.com/jira/modifying-multiple-bulk-issues-185729606.html)
6787
* Click the cog next to the version you are about to release and select "Release"
6888
* Follow the dialogs/wizards and whatnot, setting the release date to the current date
6989

@@ -106,14 +126,14 @@ and pushed.
106126
`hugo-deploy` and `doxygen-deploy` targets. The doxygen build will take
107127
a long time.
108128

109-
* Check out the "gh-pages" branch and `git pull` the deployed docs.
110-
111-
* Update the api/mongocxx-v3 symlink to point to the newly released
112-
version. If a major version bump has occurred, revise the symlink
113-
structure as needed. Make sure 'current' always points to a *symlink*
114-
tracking the latest release branch.
115-
116-
* Commit and push the symlink change.
129+
* If the release was *not* a release-candidate, update symlinks
130+
* Check out the "gh-pages" branch and `git pull` the deployed docs.
131+
* If the release was *not* a release-candidate, update the
132+
api/mongocxx-v3 symlink to point to the newly released version. If a
133+
major version bump has occurred, revise the symlink structure as
134+
needed. Make sure 'current' always points to a *symlink* tracking
135+
the latest release branch.
136+
* Commit and push the symlink change.
117137

118138
`git commit -am "Update symlink for r3.0.3"`
119139

@@ -136,16 +156,65 @@ git push origin master
136156
## Email Google Groups
137157

138158
* Send it to mongodb-announce@googlegroups.com AND mongodb-user@googlegroups.com
139-
* Template:
140-
141-
> The MongoDB C++ Driver Team is very excited to announce the availability of version X.Y.Z of the new MongoDB C++11 driver.
142-
> We are not promising API or ABI stability until the 3.1.0 release so that we can meaningfully incorporate user feedback after the 3.0.0 GA. We will make every effort to minimize API changes. The new driver is incompatible with the prior legacy, 26compat, and server C++ drivers.
143-
>
144-
> You can obtain the source for the new driver from GitHub, either under the rX.Y.Z tag or from the releases page. General documentation for the new driver is available on the github wiki. Doxygen API documentation is also available.
145-
>
146-
> Please feel free to post any questions to the mongodb-user mailing list. Bug reports should be filed against the CXX project in the MongoDB JIRA. If you are interested in participating in the development of the C++11 driver, questions should be sent to the mongodb-dev mailing list. Github pull requests are welcome, and should be issued against the master branch of the repository, where the C++11 driver is developed.
147-
> We look forward to hearing from you. Happy C++11’ing!
148-
>
149-
> Thank You,
150-
> The MongoDB C++ Driver Team
151159

160+
### Release Candidate Template:
161+
162+
***Subject: MongoDB C++11 Driver 3.1.0-rc0 Released***
163+
164+
The MongoDB C++ Driver Team is pleased to announce the availability of
165+
[mongocxx-3.1.0-rc0](https://github.com/mongodb/mongo-cxx-driver/releases/tag/r3.1.0-rc0),
166+
the first release candidate in the 3.1.x series of the MongoDB C++11
167+
Driver. This release candidate has been published for testing and is not
168+
recommended for production.
169+
170+
This release provides support for new features in MongoDB 3.4.
171+
172+
Please note that this version of mongocxx requires the [MongoDB C driver
173+
1.5.0](https://github.com/mongodb/mongo-c-driver/releases/tag/1.5.0).
174+
175+
See the [MongoDB C++ Driver
176+
Manual](https://mongodb.github.io/mongo-cxx-driver/) and the [Driver
177+
Installation
178+
Instructions](https://mongodb.github.io/mongo-cxx-driver/mongocxx-v3/installation/)
179+
for more details on downloading, installing, and using this driver.
180+
181+
NOTE: The mongocxx 3.1.x series does not promise API or ABI stability
182+
across patch releases.
183+
184+
Please feel free to post any questions to the
185+
[mongodb-user](https://groups.google.com/forum/#!forum/mongodb-user)
186+
mailing list. Bug reports should be filed against the
187+
[CXX](https://jira.mongodb.org/browse/CXX) project in the MongoDB JIRA.
188+
Your feedback on the C++11 driver is greatly appreciated.
189+
190+
Thank you,<br/>
191+
The C++ Driver Team
192+
193+
### GA Release Template:
194+
195+
***Subject: MongoDB C++11 Driver 3.1.0 Released***
196+
197+
The MongoDB C++ Driver Team is pleased to announce the availability of
198+
[mongocxx-3.1.0](https://github.com/mongodb/mongo-cxx-driver/releases/tag/r3.1.0).
199+
This release provides support for new features in MongoDB 3.4.
200+
201+
Please note that this version of mongocxx requires the [MongoDB C driver
202+
1.5.0](https://github.com/mongodb/mongo-c-driver/releases/tag/1.5.0).
203+
204+
See the [MongoDB C++ Driver
205+
Manual](https://mongodb.github.io/mongo-cxx-driver/) and the [Driver
206+
Installation
207+
Instructions](https://mongodb.github.io/mongo-cxx-driver/mongocxx-v3/installation/)
208+
for more details on downloading, installing, and using this driver.
209+
210+
NOTE: The mongocxx 3.1.x series does not promise API or ABI stability
211+
across patch releases.
212+
213+
Please feel free to post any questions to the
214+
[mongodb-user](https://groups.google.com/forum/#!forum/mongodb-user)
215+
mailing list. Bug reports should be filed against the
216+
[CXX](https://jira.mongodb.org/browse/CXX) project in the MongoDB JIRA.
217+
Your feedback on the C++11 driver is greatly appreciated.
218+
219+
Thank you,<br/>
220+
The C++ Driver Team

0 commit comments

Comments
 (0)