From 974a78919d12beb0bc0bdc1d4fde07f2ad8ef3a2 Mon Sep 17 00:00:00 2001
From: EliteMasterEric <ericmyllyoja@gmail.com>
Date: Wed, 11 Jun 2025 23:50:58 -0400
Subject: [PATCH] Additional documentation for workflows

---
 .github/workflows/build-game.yml                   |  3 +++
 .github/workflows/cancel-merged-branches.yml       |  3 +++
 .github/workflows/label-actions.yml                |  1 +
 .github/workflows/label-pull-request-on-create.yml |  4 ++++
 .github/workflows/label-pull-request.yml           | 12 ++++++++++++
 5 files changed, 23 insertions(+)

diff --git a/.github/workflows/build-game.yml b/.github/workflows/build-game.yml
index aeb05b0d0..da1a3f9ad 100644
--- a/.github/workflows/build-game.yml
+++ b/.github/workflows/build-game.yml
@@ -1,3 +1,6 @@
+# Builds the game on all platforms, to ensure it compiles on all target platforms.
+# This helps to ensure workers focus on the master branch.
+
 name: Build and Upload nightly game builds
 
 on:
diff --git a/.github/workflows/cancel-merged-branches.yml b/.github/workflows/cancel-merged-branches.yml
index 254b21a24..d725d55d4 100644
--- a/.github/workflows/cancel-merged-branches.yml
+++ b/.github/workflows/cancel-merged-branches.yml
@@ -1,3 +1,6 @@
+# When a pull request is merged, cancel all queued workflows for that branch
+# This helps to ensure workers focus on the master branch.
+
 name: Cancel queued workflows on PR merge
 
 on:
diff --git a/.github/workflows/label-actions.yml b/.github/workflows/label-actions.yml
index bc4cf0add..51cd46931 100644
--- a/.github/workflows/label-actions.yml
+++ b/.github/workflows/label-actions.yml
@@ -1,5 +1,6 @@
 # Perform actions when labels are applied to issues, discussions, or pull requests
 # See .github/label-actions.yml
+
 name: 'Label Actions'
 
 on:
diff --git a/.github/workflows/label-pull-request-on-create.yml b/.github/workflows/label-pull-request-on-create.yml
index 94620657d..7137f5fe9 100644
--- a/.github/workflows/label-pull-request-on-create.yml
+++ b/.github/workflows/label-pull-request-on-create.yml
@@ -1,9 +1,13 @@
+# Applies the following labels to pull requests when created:
+#  - status: pending triage
+
 name: "Pull Request Labeler 2 (Runs on PR creation)"
 on:
   pull_request_target:
     types:
       - opened
 
+
 jobs:
   # Apply `status: pending triage` to newly created pull requests
   apply-pending-triage:
diff --git a/.github/workflows/label-pull-request.yml b/.github/workflows/label-pull-request.yml
index 525e1b5a6..91eeb53a5 100644
--- a/.github/workflows/label-pull-request.yml
+++ b/.github/workflows/label-pull-request.yml
@@ -1,7 +1,19 @@
+# Applies the following labels to pull requests whenver they are created or modified:
+#  - pr: documentation
+#  - pr: haxe
+#  - pr: github
+#  - size: tiny
+#  - size: small
+#  - size: medium
+#  - size: large
+#  - size: huge
+# see .github/labeler.yml and .github/changed-lines-count-labeler.yml
+
 name: "Pull Request Labeler"
 on:
 - pull_request_target
 
+
 jobs:
   # Apply labels to pull requests based on which files were edited
   labeler: