Fix link to create GitHub App: use pull_requests with underscore
#41
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 provided 2 of 3, and the 'Pull Requests' permission wasn't set:
It turned out that I should have been using
pull_requests=writein the url, rather thanpull-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!