docs: add comment as workflow heading explaining what it does

EbookFoundation · Sep 14, 2022 · 01663e6 · 01663e6
1 parent 25ebb42
commit 01663e6
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/.github/workflows/issues-pinner.yml b/.github/workflows/issues-pinner.yml
@@ -1,3 +1,11 @@
+#
+# This workflow adds a label to the issue involved on event when is pinned
+# and removes it when unpinned.
+#
+# It also is enhanced with `stale.yml` workflow: pinned issues never stales
+# because that label is declared as part of it `exempt-issue-labels`
+# input parameter.
+#
 name: Issues pinner management
 
 on: