From 0f42dd4303ab98ea3a20b2f2af3a0420944e7b5a Mon Sep 17 00:00:00 2001 From: "David W.H. Swenson" Date: Mon, 23 Nov 2020 08:25:18 +0100 Subject: [PATCH] Minor README changes This is because apparently Autorelease can't handle squash-and-merge to stable. --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6ef919f..ec5ae6a 100644 --- a/README.md +++ b/README.md @@ -13,17 +13,19 @@ release versions of the code). The workflow for a release is therefore: post will be the release notes. 2. Merge the PR. -That's it. +That's it. Autorelease handles the rest. -When you make the PR to a stable branch, the CI will deploy the package to +When you make the PR to a stable branch, Autorelease will deploy the package to testpypi, and re-download it and test it again. This ensures that you don't -publish broken packages. After you merge to the stable branch, the CI will cut -a new release on GitHub, and then release on PyPI. +publish broken packages. After you merge to the stable branch, Autorelease will +cut a new release on GitHub, and then publish the release on PyPI. Tools included: * Travis config imports and scripts to automatically test-deploy on testpypi, then cut a GitHub release, then deploy to PyPI. +* Vendor-able GitHub Actions workflows for test-deploy, GitHub release, and +PyPI deploy. * Vendor-able `version.py` that gives one true location for version (`setup.cfg`) while also enabling developer installs to give full and correct version information.