📝 update merge block documentation

Staffbase · Apr 25, 2024 · d9faf2e · d9faf2e
1 parent d564b9a
commit d9faf2e
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -231,6 +231,27 @@ jobs:
 
 </details>
 
+### Merge Block
+
+<details>
+<summary>The action can be used to block the merge if a do not merge label is set.</summary>
+
+```yml
+name: Merge Block
+
+on:
+  pull_request:
+    types: [opened, labeled, unlabeled]
+
+jobs:
+  block:
+    uses: Staffbase/gha-workflows/.github/workflows/template_do_not_merge.yml@v2.0.0
+    with:
+      # optional: name of the label if the PR should not be merged, default: do not merge
+      label: merge block
+```
+</details>
+
 ### Release Drafter
 
 <details>