From e83361cdbcbb9a6b13a34c5483b1260cdc4d1a8c Mon Sep 17 00:00:00 2001
From: Shane Harvey <shnhrv@gmail.com>
Date: Wed, 4 Dec 2019 15:21:48 -0800
Subject: [PATCH] Document pymongocrypt release process

---
 bindings/python/CHANGELOG.rst | 26 +++++++++++
 bindings/python/RELEASE.rst   | 85 +++++++++++++++++++++++++++++++++++
 2 files changed, 111 insertions(+)
 create mode 100644 bindings/python/CHANGELOG.rst
 create mode 100644 bindings/python/RELEASE.rst

diff --git a/bindings/python/CHANGELOG.rst b/bindings/python/CHANGELOG.rst
new file mode 100644
index 000000000..93d59f4c4
--- /dev/null
+++ b/bindings/python/CHANGELOG.rst
@@ -0,0 +1,26 @@
+Changelog
+=========
+
+Changes in Version 0.1b3
+------------------------
+
+- Add support for custom KMS endpoints with the AWS masterkey provider.
+- Bundle libmongocrypt 1.0.0 in release wheels.
+
+Changes in Version 0.1b2
+------------------------
+
+- Document that pip 19 is required for manylinux2010 wheel installation.
+- Bundle libmongocrypt 1.0.0-beta5 in release wheels.
+
+Changes in Version 0.1b1
+------------------------
+
+- Make pymongocrypt compatible with manylinux2010 releases.
+- Bundle libmongocrypt 1.0.0-beta4 in release wheels.
+
+Changes in Version 0.1b0
+------------------------
+
+- Initial Python binding for libmongocrypt.
+- Bundle libmongocrypt 1.0.0-beta4 in release wheels.
diff --git a/bindings/python/RELEASE.rst b/bindings/python/RELEASE.rst
new file mode 100644
index 000000000..083ea3e8c
--- /dev/null
+++ b/bindings/python/RELEASE.rst
@@ -0,0 +1,85 @@
+=====================
+PyMongoCrypt Releases
+=====================
+
+Versioning
+----------
+
+PyMongoCrypt'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 1.0.0, then the current dev
+version might be 1.0.1.dev0 or 1.1.0.dev0.
+
+PyMongoCrypt's version numbers do not necessarily correspond to the embedded
+libmongocrypt library's version number. For example, assume the current
+PyMongoCrypt version is 1.0 and libmongocrypt is 1.0. Let's say that
+libmongocrypt 2.0.0 is released which has breaking changes to its API. If
+those 2.0.0 changes do not require any breaking changes to PyMongoCrypt, then
+the next version can be 1.1.
+
+.. _semantic versioning: http://semver.org/
+
+Release Process
+---------------
+
+PyMongoCrypt ships wheels for macOS, Windows, and manylinux2010 that include
+an embedded libmongocrypt build. Releasing a new version requires macOS with
+Docker and a Windows machine.
+
+#. Edit the release.sh script to embed the most recent libmongocrypt tag into
+   our wheels, for example::
+
+     # The libmongocrypt git revision release to embed in our wheels.
+     -REVISION=$(git rev-list -n 1 1.0.0)
+     +REVISION=$(git rev-list -n 1 1.0.1)
+
+#. Add a changlog entry for this release in CHANGELOG.rst.
+#. Bump "__version__" in pymongocrypt/version.py. Commit the change and tag
+   the release. Immediately bump the "__version__" to "dev0" in a new commit::
+
+     $ # Bump to release version number
+     $ git commit -a -m "pymongocrypt <release version number>"
+     $ git tag -a "pymongocrypt <release version number>"
+     $ # Bump to dev version number
+     $ git commit -a -m "BUMP pymongocrypt <release version number>"
+     $ git push
+     $ git push --tags
+
+#. Build the release packages for macOS and manylinux by running the release.sh
+   script on macOS. Note that Docker must be running::
+
+     $ git clone git@github.com:mongodb/libmongocrypt.git
+     $ cd libmongocrypt/bindings/python
+     $ git checkout "pymongocrypt <release version number>"
+     $ ./release.sh
+
+   This will create the following distributions::
+
+     $ ls dist
+     pymongocrypt-<version>.tar.gz
+     pymongocrypt-<version>-py2.py3-none-manylinux2010_x86_64.whl
+     pymongocrypt-<version>-py2.py3-none-macosx_10_9_x86_64.whl
+
+#. To build the release package for Windows, launch a windows-64-vs2017-test
+   Evergreen spawn host, clone the repro, checkout the release tag, and run
+   the release script::
+
+     $ git clone git@github.com:mongodb/libmongocrypt.git
+     $ cd libmongocrypt/bindings/python
+     $ git checkout "pymongocrypt <release version number>"
+     $ ./release.sh
+
+   This will create the following distributions::
+
+     $ ls dist
+     pymongocrypt-<version>-py2.py3-none-win_amd64.whl
+
+#. Upload all the release packages to PyPI with twine::
+
+     $ python3 -m twine upload dist/*
+