aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2018-05-09 16:34:45 -0400
committerPaul Kehrer <paul.l.kehrer@gmail.com>2018-05-09 15:34:45 -0500
commit0830f9233332c8160b90e1af1a9fa4e2058fa3e4 (patch)
tree1b89f14d2a169ccac80f94c0274a475330a0d818
parent2bc941d85df430a4dcbb3ac1b696946c3ec87fd9 (diff)
downloadcryptography-0830f9233332c8160b90e1af1a9fa4e2058fa3e4.tar.gz
cryptography-0830f9233332c8160b90e1af1a9fa4e2058fa3e4.tar.bz2
cryptography-0830f9233332c8160b90e1af1a9fa4e2058fa3e4.zip
Use a checklist for bumping openssl version (#4221)
* Use a checklist for bumping openssl version * words * empty commit to retrigger jenkins
-rw-r--r--.github/ISSUE_TEMPLATE/openssl-release.md9
-rw-r--r--docs/doing-a-release.rst26
2 files changed, 16 insertions, 19 deletions
diff --git a/.github/ISSUE_TEMPLATE/openssl-release.md b/.github/ISSUE_TEMPLATE/openssl-release.md
new file mode 100644
index 00000000..6167739f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/openssl-release.md
@@ -0,0 +1,9 @@
+- [ ] Windows
+ - [ ] Run the `openssl-release-1.1` Jenkins job
+ - [ ] Copy the resulting artifacts to the Windows builders and unzip them in the root of the file system
+- [ ] macOS
+ - [ ] Send a pull request to `homebrew` upgrading the `openssl@1.1` formula
+ - [ ] Wait for it to be merged
+ - [ ] Run the `update-brew-openssl` Jenkins job
+- [ ] manylinux1
+ - [ ] Send a pull request to `pyca/infra` updating the [version and hash](https://github.com/pyca/infra/blob/master/cryptography-manylinux1/install_openssl.sh#L5-L6)
diff --git a/docs/doing-a-release.rst b/docs/doing-a-release.rst
index b70744eb..45617985 100644
--- a/docs/doing-a-release.rst
+++ b/docs/doing-a-release.rst
@@ -3,32 +3,19 @@ Doing a release
Doing a release of ``cryptography`` requires a few steps.
-Verifying and upgrading OpenSSL version
----------------------------------------
+Verifying OpenSSL version
+-------------------------
The release process creates wheels bundling OpenSSL for Windows, macOS, and
Linux. Check that the Windows and macOS Jenkins builders have the latest
version of OpenSSL installed and verify that the latest version is present in
the ``pyca/cryptography-manylinux1`` docker containers. If anything is out
-of date:
+of date follow the instructions for upgrading OpenSSL.
-Upgrading Windows
-~~~~~~~~~~~~~~~~~
+Upgrading OpenSSL
+-----------------
-Run the ``openssl-release-1.1`` Jenkins job, then copy the resulting artifacts
-to the Windows builders and unzip them in the root of the file system.
-
-Upgrading macOS
-~~~~~~~~~~~~~~~
-
-Run the ``update-brew-openssl`` Jenkins job.
-
-Upgrading ``manylinux1`` docker containers
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Send a pull request to the ``pyca/infra`` project updating the version and
-file hash in ``cryptography-manylinux1/install_openssl.sh``. Once this is
-merged the updated image will be available to the wheel builder.
+Use the `upgrading OpenSSL issue template`_.
Bumping the version number
--------------------------
@@ -91,6 +78,7 @@ Post-release tasks
* Send an email to the `mailing list`_ and `python-announce`_ announcing the
release.
+.. _`upgrading OpenSSL issue template`: https://github.com/pyca/cryptography/issues/new?template=openssl-release.md
.. _`milestone`: https://github.com/pyca/cryptography/milestones
.. _`mailing list`: https://mail.python.org/mailman/listinfo/cryptography-dev
.. _`python-announce`: https://mail.python.org/mailman/listinfo/python-announce-list