Skip to content

Latest commit

 

History

History
81 lines (59 loc) · 3.12 KB

RELEASE.rst

File metadata and controls

81 lines (59 loc) · 3.12 KB

Motor Releases

Versioning

Motor's version numbers follow semantic versioning: each version number is structured "major.minor.patch". Patch releases fix bugs, minor releases add features (and may fix bugs), and major releases include API changes that break backwards compatibility (and may add features and fix bugs).

In between releases we add .devN to the version number to denote the version under development. So if we just released 2.3.0, then the current dev version might be 2.3.1.dev0 or 2.4.0.dev0. When we make the next release we replace all instances of 2.x.x.devN in the docs with the new version number.

https://www.python.org/dev/peps/pep-0440/

Release Process

Motor ships a pure Python wheel and a source distribution.

  1. Motor is tested on Evergreen. Ensure that the latest commit is passing CI as expected: https://evergreen.mongodb.com/waterfall/motor.

  2. Check JIRA to ensure all the tickets in this version have been completed.

  3. Add release notes to doc/changelog.rst. Generally just summarize/clarify the git log, but you might add some more long form notes for big changes.

  4. Search and replace the devN version number w/ the new version number (see note above in Versioning). Make sure version number is updated in setup.py and motor/__init__.py. Commit the change and tag the release. Immediately bump the version number to dev0 in a new commit:

    $ # Bump to release version number
$ git commit -a -m "BUMP <release version number>"
$ git tag -a "<release version number>" -m "BUMP <release version number>"
$ # Bump to dev version number
$ git commit -a -m "BUMP <dev version number>"
$ git push
$ git push --tags

  5. Build the release packages by running the release.sh script on macOS:

    $ git clone [email protected]:mongodb/motor.git
$ cd motor
$ git checkout "<release version number>"
$ ./release.sh

    This will create the following distributions:

    $ ls dist
motor-<version>.tar.gz
motor-<version>-py3-none-any.whl

  6. Upload all the release packages to PyPI with twine:

    $ python3 -m twine upload dist/*

  7. Make sure the new version appears on https://motor.readthedocs.io/. If the new version does not show up automatically, trigger a rebuild of "latest": https://readthedocs.org/projects/motor/builds/

  8. Bump the version number to <next version>.dev0 in setup.py/__init__.py, commit, push.

  9. Publish the release version in Jira.

  10. Announce the release on: https://www.mongodb.com/community/forums/c/announcements/driver-releases

  11. Create a GitHub Release for the tag using https://github.com/mongodb/motor/releases/new. The title should be "Motor X.Y.Z", and the description should contain a link to the release notes on the the community forum, e.g. "Release notes: mongodb.com/community/forums/t/motor-2-5-1-released/120313."