Update release.py and release docs for GHA PyPI publishing.

Author: lemon24

docs/dev.rst

@@ -226,25 +226,31 @@ Making a release
 
 .. note::
 
-    :gh:`scripts/release.py <scripts/release.py>` already does most of these.
+    The :gh:`release.py <scripts/release.py>` script together with
+    the :gh:`publish <.github/workflows/publish.yaml>`  GitHub Actions workflow
+    already do most of these.
 
 Making a release (from ``x`` to ``y`` == ``x + 1``):
 
 * (release.py) bump version in ``src/reader/__init__.py`` to ``y``
 * (release.py) update changelog with release version and date
 * (release.py) make sure tests pass / docs build
-* (release.py) clean up dist/: ``rm -rf dist/``
-* (release.py) build tarball and wheel: ``python -m build``
 * (release.py) push to GitHub
-* (release.py prompts) wait for GitHub Actions / Codecov / Read the Docs builds to pass
-* upload to test PyPI and check: ``twine upload --repository-url https://test.pypi.org/legacy/ dist/*``
-* (release.py) upload to PyPI: ``twine upload dist/*``
+* (release.py prompts) wait for GitHub Actions / Read the Docs builds to pass
 * (release.py) tag current commit with `<major>.<minor>` and `<major>.x`
-  (e.g. when releasing `1.20`: `1.20` and `1.x`)
-* (release.py prompts) create release in GitHub
-* build docs from latest and enable ``y`` docs version (should happen automatically after the first time)
+  (e.g. when releasing `1.20`: `1.20` and `1.x`) and push tags to GitHub
+* (release.py prompts) approve publish workflow
+* (publish workflow) build and upload to PyPI
+* alternatively, to make a manual release (should not be needed)
+
+  * clean up dist/: ``rm -rf dist/``
+  * build tarball and wheel: ``python -m build``
+  * upload to test PyPI and check: ``twine upload --repository-url https://test.pypi.org/legacy/ dist/*``
+  * upload to PyPI: ``twine upload dist/*``
+
+* (publish workflow) create draft release in GitHub
+* (release.py prompts) publish release in GitHub
 * (release.py) bump versions from ``y`` to ``(y + 1).dev0``, add ``(y + 1)`` changelog section
-* (release.py prompts) trigger Read the Docs build for `<major>.x` (doesn't happen automatically)
 
 
 

scripts/release.py

@@ -34,11 +34,6 @@ def run_tox():
     run_no_venv('tox -p all', shell=True)
 
 
-def build():
-    run('rm -rf dist/', shell=True)
-    run('python -m build', shell=True)
-
-
 def path_sub(pattern, repl, path):
     with open(path) as f:
         text = f.read()
@@ -112,10 +107,6 @@ def check_unpushed():
         abort("unpushed changes\n\n{}\n", p.stdout.strip('\n'))
 
 
-def upload_to_pypi():
-    run('twine upload dist/*', shell=True)
-
-
 def add_and_push_tags(tags):
     for tag in tags:
         run(['git', 'tag', '--force', tag])
@@ -150,10 +141,6 @@ def main(version, new_version, date, tox, changelog):
 
     confirm("Wait for GitHub Actions / Read the Docs builds to pass.")
 
-    confirm("Upload to PyPI?")
-    build()
-    upload_to_pypi()
-
     tags = [version]
     version_x = version.partition('.')[0] + '.x'
     if new_version_is_final:
@@ -162,7 +149,15 @@ def main(version, new_version, date, tox, changelog):
     confirm(f"Add and push tags ({', '.join(tags)})?")
     add_and_push_tags(tags)
 
-    confirm("Create release {} in GitHub (doesn't happen automatically).", version)
+    confirm(
+        "Approve publish workflow to upload to PyPI.\n  {}\nDone?",
+        "https://github.com/lemon24/reader/actions/workflows/publish.yaml",
+    )
+    confirm(
+        "Publish draft release {} in GitHub.\n  {}\nDone?",
+        version,
+        "https://github.com/lemon24/reader/releases",
+    )
 
     new_version_full = f"{new_version}.dev0"
     update_init_version(new_version_full)
@@ -173,11 +168,6 @@ def main(version, new_version, date, tox, changelog):
     confirm("Push version {}?", new_version_full)
     push()
 
-    # TODO: I just enabled branch or tag creation/deletion for the RtD webhook in GitHub, this might not be needed next time.
-    confirm(
-        f"Trigger Read the Docs build for {version_x} (doesn't happen automatically)."
-    )
-
 
 if __name__ == '__main__':
     main()