From 794e4db77fee2cd4c3cb4c56803ac9dd5ee1adfc Mon Sep 17 00:00:00 2001
From: psychedelicious <4822129+psychedelicious@users.noreply.github.com>
Date: Sat, 2 Mar 2024 23:48:23 +1100
Subject: [PATCH] ci: add comments to workflows

---
 .github/workflows/build-installer.yml | 2 ++
 .github/workflows/frontend-checks.yml | 5 +++++
 .github/workflows/frontend-tests.yml  | 5 +++++
 .github/workflows/python-checks.yml   | 5 +++++
 .github/workflows/python-tests.yml    | 7 ++++++-
 .github/workflows/release.yml         | 9 +++++++++
 6 files changed, 32 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/build-installer.yml b/.github/workflows/build-installer.yml
index dbd797c5e6..9d6d42c8d9 100644
--- a/.github/workflows/build-installer.yml
+++ b/.github/workflows/build-installer.yml
@@ -1,3 +1,5 @@
+# Builds and uploads the installer and python build artifacts.
+
 name: build installer
 
 on:
diff --git a/.github/workflows/frontend-checks.yml b/.github/workflows/frontend-checks.yml
index 680c0a5b22..e621348af4 100644
--- a/.github/workflows/frontend-checks.yml
+++ b/.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:
diff --git a/.github/workflows/frontend-tests.yml b/.github/workflows/frontend-tests.yml
index f7bd9be7a3..e4e18f2571 100644
--- a/.github/workflows/frontend-tests.yml
+++ b/.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:
diff --git a/.github/workflows/python-checks.yml b/.github/workflows/python-checks.yml
index f92065059c..cbf986d8da 100644
--- a/.github/workflows/python-checks.yml
+++ b/.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'
diff --git a/.github/workflows/python-tests.yml b/.github/workflows/python-tests.yml
index 4afc3480a0..d261a90451 100644
--- a/.github/workflows/python-tests.yml
+++ b/.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:
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 444ae33714..037a082722 100644
--- a/.github/workflows/release.yml
+++ b/.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: