Tweak instructions for updating version numbers

Living-with-machines · Jul 1, 2022 · 9cba63d · 9cba63d
1 parent 445c6e6
commit 9cba63d
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/.github/workflows/deploy-to-pypi.yml b/.github/workflows/deploy-to-pypi.yml
@@ -3,8 +3,6 @@ name: Publish Tagged Python 🐍 distributions 📦 to PyPI
 
 on:
   push:
-    branches:
-      - main
     tags:
       - v*
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -57,3 +57,13 @@ git push --tags
 ```
 
 GitHub Actions will detect the tagged commit and publish the package to PyPI accordingly.
+
+Immediately afterwards, increase the version number of the package within the code.
+
+```bash
+poetry version patch
+git commit -m "Bump version number"
+git push
+```
+
+This will ensure that development builds, from non-tagged commits, will be published to [TestPyPI](https://test.pypi.org/) as an `alpha` release of the next version. For example, if the latest version on PyPI is `v1.2.3`, the next development build on TestPyPI will be `v1.2.4-alphaX` (sequentially after the latest version).
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,8 +3,6 @@ name: Publish Tagged Python 🐍 distributions 📦 to PyPI @@
     on:
       push:
-        branches:
-          - main
         tags:
           - v*
@@ Expand Down @@