docs: add docs for changeset check workflow

Staffbase · Jan 21, 2025 · b5c2a3d · b5c2a3d
1 parent 5340598
commit b5c2a3d
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -109,6 +109,24 @@ jobs:
 
 </details>
 
+### Changeset Check
+
+<details>
+<summary>The action can be used to check a PR for the existance of <a href="https://github.com/changesets/changesets">changeset</a> files. It will then add/update a comment on the PR.</summary>
+
+```yml
+name: Changeset Check
+on:
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+jobs:
+  changeset-check:
+    uses: Staffbase/gha-workflows/.github/workflows/[email protected]
+```
+
+</details>
+
 ### GitOps
 
 <details>