ci: add comments to workflows

.github/workflows/build-installer.yml

@@ -1,3 +1,5 @@
+# Builds and uploads the installer and python build artifacts.
+
 name: build installer
 
 on:

.github/workflows/frontend-checks.yml

@@ -1,3 +1,8 @@
+# Runs frontend code quality checks.
+#
+# Checks for changes to frontend files before running the checks.
+# When manually triggered or when called from another workflow, always runs the checks.
+
 name: 'frontend checks'
 
 on:

.github/workflows/frontend-tests.yml

@@ -1,3 +1,8 @@
+# Runs frontend tests.
+#
+# Checks for changes to frontend files before running the tests.
+# When manually triggered or called from another workflow, always runs the tests.
+
 name: 'frontend tests'
 
 on:

.github/workflows/python-checks.yml

@@ -1,3 +1,8 @@
+# Runs python code quality checks.
+#
+# Checks for changes to python files before running the checks.
+# When manually triggered or called from another workflow, always runs the tests.
+#
 # TODO: Add mypy or pyright to the checks.
 
 name: 'python checks'

.github/workflows/python-tests.yml

@@ -1,3 +1,8 @@
+# Runs python tests on a matrix of python versions and platforms.
+#
+# Checks for changes to python files before running the tests.
+# When manually triggered or called from another workflow, always runs the tests.
+
 name: 'python tests'
 
 on:
@@ -48,7 +53,7 @@ jobs:
           - platform: windows-cpu
             os: windows-2022
             github-env: $env:GITHUB_ENV
-    name: "py${{ matrix.python-version }}: ${{ matrix.platform }}"
+    name: 'py${{ matrix.python-version }}: ${{ matrix.platform }}'
     runs-on: ${{ matrix.os }}
     timeout-minutes: 15 # expected run time: 2-6 min, depending on platform
     env:

.github/workflows/release.yml

@@ -1,3 +1,12 @@
+# Main release workflow. Triggered on tag push or manual trigger.
+#
+# - Runs all code checks and tests
+# - Verifies the app version matches the tag version.
+# - Builds the installer and build, uploading them as artifacts.
+# - Publishes to TestPyPI and PyPI. Both are conditional on the previous steps passing and require a manual approval.
+#
+# See docs/RELEASE.md for more information on the release process.
+
 name: release
 
 on: