Merge pull request #79 from mfisher87/automated-release

Publish to PyPI automatically when publishing a GitHub release

Author: mfisher87

.github/workflows/check.yml

@@ -1,7 +1,8 @@
 name: "Check with pre-commit"
 on:
-  - "push"
-  - "pull_request"
+  push:
+    branches: ["main"]
+  pull_request:
 
 jobs:
 

.github/workflows/release.yml

@@ -0,0 +1,29 @@
+name: "Release"
+on:
+  release:
+    types:
+      - "published"
+
+jobs:
+
+  build-and-release:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v3"
+
+      - name: "Set up Python"
+        uses: "actions/setup-python@v4"
+        with:
+          python-version: "3.9"
+
+      - name: "Install build tool"
+        run: "pip install --user build"
+
+      - name: "Build binary dist (wheel) and source dist"
+        run: "python -m build"
+
+      - name: "Publish to PyPI"
+        uses: "pypa/gh-action-pypi-publish@release/v1"
+        with:
+          password: "${{ secrets.PYPI_TOKEN }}"
+          repository-url: "https://pypi.org/project/viscm"

.github/workflows/test.yml

@@ -1,7 +1,8 @@
-name: "Unit test"
+name: "Test"
 on:
-  - "push"
-  - "pull_request"
+  push:
+    branches: ["main"]
+  pull_request:
 
 jobs:
 

doc/contributing.md

@@ -71,3 +71,13 @@ make typecheck
 ```
 
 Type checking requires `mypy`.
+
+
+## Making a release and publishing to PyPI
+
+Create a release using the GitHub user interface. Tag the version following
+[semver](https://semver.org). *NOTE: As this software is pre-1.x, always increment the
+minor version only.*
+
+Once the release is published in GitHub, a GitHub Action will be triggered to build and
+upload to PyPI.