Automated publishing, Makefile cleanup, Black, improved release instructions

.eslintignore

@@ -2,7 +2,6 @@ node_modules
 *.min.js
 **/lib/
 public/
-coverage/
 **/vendor/
 docs/_build
 sphinx_wagtail_theme/static

.github/workflows/ci.yml

@@ -0,0 +1,50 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  qa:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          cache: 'pip'
+      - run: npm ci
+      - run: make lint-frontend
+      - run: make frontend
+      - run: make install-python
+      - run: make lint-python
+      - run: make test
+
+  visual-regression-tests:
+    needs: qa
+    runs-on: ubuntu-latest
+    env:
+      PERCY_TOKEN: ${{ secrets.PERCY_TOKEN }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - uses: browser-actions/setup-firefox@v1
+      - run: make install-python
+      - run: npm ci
+      # Check against the dist version of the frontend, as it would be appear when deployed
+      - run: make frontend-dist
+      - run: make docs
+      - name: Percy Test
+        run: make test-visual-regression

.github/workflows/publish.yml

@@ -0,0 +1,60 @@
+name: Publish to PyPI
+on:
+  release:
+    # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#release
+    types: [released]
+jobs:
+  test:
+    uses: ./.github/workflows/ci.yml
+
+  build:
+    needs: ['test']
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+
+      - name: Install Node dependencies
+        run: |
+          npm ci
+
+      - name: Compile JavaScript
+        run: |
+          make frontend-dist
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+
+      - name: Install dependencies
+        run: make setup-python
+
+      - name: Build package distributions
+        run: make build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          path: ./dist
+
+  # https://docs.pypi.org/trusted-publishers/using-a-publisher/
+  pypi-publish:
+    needs: ['build']
+    environment: 'publish'
+
+    name: upload release to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      # Mandatory for trusted publishing
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: artifact/
+          print-hash: true

.gitignore

@@ -2,11 +2,6 @@
 *.egg
 *.egg-info
 *.pyc
-*.sass-cache
-*GENERATED*
-*NOT_VERSIONED*
-.coverage
-.eggs/
 .idea
 .ruby-version
 .tox
@@ -22,7 +17,7 @@ npm-debug.log
 /.vscode
 
 /build/*
-!/build/.gitkeep
+rtd-env/
 venv/
 env/
 .env/

.readthedocs.yaml

@@ -10,7 +10,7 @@ build:
     nodejs: '20'
   jobs:
     post_install:
-      - make setup-frontend
+      - make install-frontend
     pre_build:
       - make frontend
 

CHANGELOG.md

@@ -7,10 +7,11 @@ All notable changes to this project will be documented in this file.
 ### Added
 
 -   Use new Wagtail logo variant for favicon and other logos (Osaf AliSayed)
+-   Set up GitHub Actions for publishing new releases using PyPI's trusted publishing (Storm Heg)
 
 ### Changed
 
--   ...
+-   Clean up development and release instructions and format codebase with Black (Storm Heg)
 
 ### Removed