Skip to content

Commit ac95f8e

Browse files
committed
README: elaborate on registering the GitHub App
Now that I am trying to establish support for projects other than Git, I need to register a new GitHub App. Let's document that process better for the next person who wants to repeat that feat. Signed-off-by: Johannes Schindelin <[email protected]>
1 parent 7baf3d0 commit ac95f8e

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,4 +91,37 @@ As Webhook URL, the URL of the Azure Function was used, which can be copied in t
9191

9292
The value stored in the Azure Function as `GITHUB_WEBHOOK_SECRET` was used as Webhook secret.
9393

94-
The GitGitGadget GitHub app requires the following permissions: Read access to metadata, and Read and write access to checks, code, commit statuses, issues, pull requests, and workflows.
94+
The GitGitGadget GitHub app requires the following permissions: Read access to metadata, and Read and write access to Actions, Checks, Commit statuses, Contents, Issues, Pull requests, and Workflows. It needs the following webhook events to be enabled: Check run, Commit comment, Issue comment, Pull request, Pull request review, Pull request review comment, Push, Repository, and Status.
95+
96+
#### Using `register-github-app-cli`
97+
98+
A convenient alternative to clicky-clicky in the GitHub UI to register the GitHub is the convenient [`npx re
99+
gister-github-app-cli` command](https://github.com/gr2m/register-github-app-cli): Use it with `--org <owning-organization>` and a vari
100+
ation of this manifest:
101+
102+
```yml
103+
name: <name>
104+
url: https://github.com/apps/<name>
105+
hook_attributes:
106+
url: https://<function-app-name>.azurewebsites.net/api/GitGitGadget
107+
public: false
108+
default_permissions:
109+
actions: write
110+
checks: write
111+
commit_statuses: write
112+
contents: write
113+
issues: write
114+
metadata: read
115+
pull_requests: write
116+
workflows: write
117+
default_events:
118+
- check_run
119+
- commit_comment
120+
- issue_comment
121+
- pull_request
122+
- pull_request_review
123+
- pull_request_review_comment
124+
- push
125+
- repository
126+
- status
127+
```

0 commit comments

Comments
 (0)