Skip to content

Commit 685e338

Browse files
kjluedkesnskArora
andauthored
Docs: Update readme for org team approvers (#194)
* Docs: Update readme for org team approvers * Update README.md --------- Co-authored-by: Sunny <[email protected]>
1 parent 157e108 commit 685e338

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ For a seamless experience, it is recommended that you add the custom words to a
110110

111111
If you want to have `approvers` set to an org team, then you need to take a different approach. The default [GitHub Actions automatic token](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) does not have the necessary permissions to list out team members. If you would like to use this, then you need to generate a token from a GitHub App with the correct set of permissions. Apart from this, the GH app will also need the Issue: Read & Write role.
112112

113-
Create a GitHub App with **read-only access to organization members**. Once the app is created, add a repo secret with the app ID. In the GitHub App settings, generate a private key and add that as a secret in the repo as well. You can get the app token by using the [`tibdex/github-app-token`](https://github.com/tibdex/github-app-token) GitHub Action:
113+
Create an Organization GitHub App with **read-only access to organization members**. Once the app is created, add a repo secret with the app ID. In the GitHub App settings, generate a private key and add that as a secret in the repo as well. You can get the app token by using the [`actions/create-github-app-token`](https://github.com/actions/create-github-app-token) GitHub Action:
114114

115115
*Note: The GitHub App tokens expire after 1 hour, which implies the duration for the approval cannot exceed 60 minutes, or the job will fail due to bad credentials. See [docs](https://docs.github.com/en/rest/apps/apps#create-an-installation-access-token-for-an-app).*
116116

@@ -121,10 +121,10 @@ jobs:
121121
steps:
122122
- name: Generate token
123123
id: generate_token
124-
uses: tibdex/github-app-token@v1
124+
uses: actions/create-github-app-token@v2
125125
with:
126-
app_id: ${{ secrets.APP_ID }}
127-
private_key: ${{ secrets.APP_PRIVATE_KEY }}
126+
app-id: ${{ secrets.APP_ID }}
127+
private-key: ${{ secrets.APP_PRIVATE_KEY }}
128128
- name: Wait for approval
129129
uses: trstringer/manual-approval@v1
130130
with:

0 commit comments

Comments
 (0)