Skip to content

Commit 185602e

Browse files
authored
add step to check tickets in commit messages (#2103)
1 parent 61e6cce commit 185602e

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

docs/dev/releasing.rst

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ process.
3838
- [ ] Do the Release:
3939
- [ ] Start a Release Stopwatch (start time: HH:MM)
4040
- [ ] Clone the Driver Tools
41-
- [ ] If patch release: Check consistency with [the Jira release](https://jira.mongodb.org/projects/CDRIVER/versions/XXXXXX)
41+
- [ ] Check Consistency with [the Jira release](https://jira.mongodb.org/projects/CDRIVER/versions/XXXXXX)
4242
- [ ] Run the Release Script
4343
- [ ] Fixup the `NEWS` Pages
4444
- [ ] Signed & Upload the Release
@@ -305,15 +305,19 @@ Install the Python requirements for the driver tools::
305305
$ pip install -r $CDRIVER_TOOLS/requirements.txt
306306

307307

308-
**For Patch Releases**: Check Consistency with the Jira Release
309-
***************************************************************
308+
Check Consistency with the Jira Release
309+
***************************************
310310

311-
**If we are releasing a patch version**, we must check that the Jira release
311+
We must check that the Jira release
312312
matches the content of the branch to be released. Open
313-
`the releases page on Jira <Jira releases_>`_ and open the release page for the new patch
314-
release. Verify that the changes for all tickets in the Jira release have been
315-
cherry-picked onto the release branch (not including the "Release x.y.z" ticket
316-
that is part of every Jira release).
313+
`the releases page on Jira <Jira releases_>`_ and open the release page for the new
314+
release.
315+
316+
**If we are releasing a patch version**, verify that the changes for all tickets in the Jira release have been
317+
cherry-picked onto the release branch (not including the "Release x.y.z" ticket that is part of every Jira release).
318+
319+
Check tickets referenced in commit messages (e.g. "CDRIVER-1234 fix foo") are in the expected state.
320+
Expect most tickets to be in the "Closed" state with the ``fixVersion`` of the upcoming release.
317321

318322
.. _Jira releases:
319323
.. _jira-releases: https://jira.mongodb.org/projects/CDRIVER?selectedItem=com.atlassian.jira.jira-projects-plugin%3Arelease-page&status=unreleased

0 commit comments

Comments
 (0)