Update README.md with requirements for the Superpower

endersonmenezes · Apr 9, 2024 · 6cc6a61 · 6cc6a61
1 parent beb5582
commit 6cc6a61
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -22,3 +22,11 @@ A GitHub Action that powers the CODEOWNERS.
 This Superpower will check if all codeowners necessary have been approved in the PR. 
 
 Based on: [this discussion](https://github.com/isaacs/github/issues/1205)
+
+#### Requirements for this Superpower
+
+1. Create a GitHub App inside your organization or repository.
+2. That GitHub App needs to have the following permissions:
+    - Read contents of repository.
+    - Read members of the organization.
+3. Use the [actions/create-github-app-token@v1](https://github.com/actions/create-github-app-token) before use the GATE with Superpowers.