Skip to content

Commit

Permalink
Fix link to create GitHub App: use pull_requests with underscore
Browse files Browse the repository at this point in the history
This fixes a small documentation mistake I made in #26,
where usage of a Github App was introduced. I supplied a link in the docs to help create a new GitHub App, this link was
supposed to pre-populate the form with the 3 necessary permissions (Contents: Read and write, Pull Requests: Read and write,
and Metadata: Read-only). However, checking it now, it only provides 2 of 3, and the 'Pull Requests' permission wasn't
set.

It turned out that I should have been using `pull_requests=write` in the url, rather than `pull-requests=write` - this
isn't documented, so far as I can see:

https://docs.github.com/en/apps/sharing-github-apps/registering-a-github-app-using-url-parameters

...but in the end I managed to guess it!
  • Loading branch information
rtyley committed Jun 26, 2024
1 parent feea7f5 commit 3ad5011
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/github-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ so that we don't share private keys.
You can just click this link to get taken to a pre-filled page to create a new GitHub App - you'll just need to
customise the app name:

https://github.com/settings/apps/new?name=scala-library-release&url=https://github.com/guardian/gha-scala-library-release-workflow&public=false&contents=write&pull-requests=write&webhook_active=false
https://github.com/settings/apps/new?name=scala-library-release&url=https://github.com/guardian/gha-scala-library-release-workflow&public=false&contents=write&pull_requests=write&webhook_active=false

### GitHub App for an organisation account

Expand Down

0 comments on commit 3ad5011

Please sign in to comment.