Add test and release workflows

Author: ankandrew

.github/workflows/release.yaml

@@ -0,0 +1,104 @@
+name: Release
+on:
+  push:
+    tags:
+      - 'v*'  # Triggers on new version tags
+
+jobs:
+  tests:
+    uses: ./.github/workflows/test.yml
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    needs:
+      - tests
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      # TODO
+      url: https://pypi.org/p/project-name
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install poetry
+        run: pipx install poetry
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Build a binary wheel
+        run: poetry build
+
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: Create GitHub Release
+    needs:
+      - publish-to-pypi
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Check package version matches tag
+        id: check-version
+        uses: samuelcolvin/[email protected]
+        with:
+          version_file_path: 'pyproject.toml'
+
+      - name: Create GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ github.ref_name }}
+        run: |
+          gh release create "$tag" \
+              --repo="$GITHUB_REPOSITORY" \
+              --title="${GITHUB_REPOSITORY#*/} ${tag#v}" \
+              --generate-notes
+
+  update_docs:
+    name: Update Documentation
+    needs:
+      - github-release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Install poetry
+        run: pipx install poetry
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+          cache: 'poetry'
+
+      - name: Configure Git user
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+
+      - name: Retrieve version
+        id: check-version
+        uses: samuelcolvin/[email protected]
+        with:
+          version_file_path: 'pyproject.toml'
+          skip_env_check: true
+
+      - name: Deploy the docs
+        run: |
+          poetry run mike deploy \
+              --update-aliases \
+              --push \
+              --branch docs-site \
+              ${{ steps.check-version.outputs.VERSION_MAJOR_MINOR }} latest

.github/workflows/main.yaml renamed to .github/workflows/test.yaml

@@ -1,13 +1,20 @@
-name: test
-run-name: Test
-on: [ push ]
+name: Test
+on:
+  workflow_call:  # Allows this workflow to be called by other workflows
+  push:
+    branches:
+      - master
+      - main
+  pull_request:
+
 jobs:
   test:
+    name: Test
     strategy:
       fail-fast: false
       matrix:
         python-version: [ '3.10', '3.11', '3.12' ]
-        os: [ ubuntu-latest ]
+        os: [ 'ubuntu-latest' ]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3
@@ -18,14 +25,15 @@ jobs:
       - uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
+          cache: 'poetry'
 
       - name: Install dependencies
-        run: poetry install
+        run: poetry install --all-extras
 
-      - name: Check Format
+      - name: Check format
         run: make check_format
 
-      - name: Run Linter
+      - name: Run linters
         run: make lint
 
       - name: Run tests