From b4346f0f198c89403465d648919ce0d49e087223 Mon Sep 17 00:00:00 2001
From: "Kelvin M. Klann" <kmk3.code@protonmail.com>
Date: Sat, 19 Aug 2023 16:18:37 -0300
Subject: ci: document the intended purpose of each workflow

---
 .github/workflows/build-extra.yml    | 2 ++
 .github/workflows/build.yml          | 3 +++
 .github/workflows/check-c.yml        | 2 ++
 .github/workflows/check-profiles.yml | 2 ++
 .github/workflows/check-python.yml   | 2 ++
 .github/workflows/codespell.yml      | 2 ++
 .github/workflows/test.yml           | 2 ++
 7 files changed, 15 insertions(+)

(limited to '.github')

diff --git a/.github/workflows/build-extra.yml b/.github/workflows/build-extra.yml
index b538fde68..1629733ae 100644
--- a/.github/workflows/build-extra.yml
+++ b/.github/workflows/build-extra.yml
@@ -1,3 +1,5 @@
+# Builds the project with alternative tools.
+
 name: Build-extra
 
 on:
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 1c5fb5f6d..d923f8b2b 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -1,3 +1,6 @@
+# Checks that `make dist` works and builds the project with the default
+# configuration.
+
 name: Build
 
 # Note: Keep this list in sync with DISTFILES in ../../Makefile.
diff --git a/.github/workflows/check-c.yml b/.github/workflows/check-c.yml
index 472238ff0..d8751ddc7 100644
--- a/.github/workflows/check-c.yml
+++ b/.github/workflows/check-c.yml
@@ -1,3 +1,5 @@
+# Checks for potential issues in the source code.
+
 name: Check-C
 
 on:
diff --git a/.github/workflows/check-profiles.yml b/.github/workflows/check-profiles.yml
index 5167516e8..193cfcb9f 100644
--- a/.github/workflows/check-profiles.yml
+++ b/.github/workflows/check-profiles.yml
@@ -1,3 +1,5 @@
+# Lints and checks for potential issues in the profiles.
+
 name: Check-Profiles
 
 on:
diff --git a/.github/workflows/check-python.yml b/.github/workflows/check-python.yml
index 91b87650f..50ddf5669 100644
--- a/.github/workflows/check-python.yml
+++ b/.github/workflows/check-python.yml
@@ -1,3 +1,5 @@
+# Lints and checks for potential issues in Python files.
+
 name: Check-Python
 
 on:
diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml
index e39755dbd..4eacfb244 100644
--- a/.github/workflows/codespell.yml
+++ b/.github/workflows/codespell.yml
@@ -1,3 +1,5 @@
+# Checks the spelling on all non-third-party files.
+
 name: Codespell
 
 on:
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index 771e7ce4c..0b679c1c8 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -1,3 +1,5 @@
+# Checks that the tests are passing.
+
 name: Test
 
 on:
-- 
cgit v1.2.3-54-g00ecf