Add some comments to the release drafter workflows (#4140)

* Add some comments to the release drafter workflows * Rename component workflow so they have different names * Fix comment --------- Co-authored-by: Michael Telatynski <7t3chguy@gmail.com>
matrix-org · Apr 30, 2024 · 2bf5547 · 2bf5547
1 parent c268764
commit 2bf5547
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/.github/workflows/release-drafter-workflow.yml b/.github/workflows/release-drafter-workflow.yml
@@ -1,4 +1,5 @@
-name: Release Drafter
+# Workflow used by other workflows to generate draft releases.
+name: Release Drafter Reusable
 on:
     workflow_call:
         inputs:

diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml
@@ -1,3 +1,7 @@
+# Generates the draft release for the js-sdk
+# Normally triggered whenever anything is merged to the staging branch, but
+# also has a workflow dispatch trigger in case it needs running manually due
+# to failures / workflow updates etc.
 name: Release Drafter
 on:
     push: