Improve the README.md documentation of how to create a GitHub App #90
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
After struggling twice through creating a GitHub App, I filed actions#89 and was encouraged to submit a pull request. This patch attempts to improve the documentation by: 1. Documenting the requirements for the GitHub app. 2. Providing URLs to make app creation easier like GitHub ARC docs do. I am not certain whether everything I added is correct, so please take a look and confirm. Parts I am unsure of: 1. Is there any use case where users will want to create this app in their account, not in an organization? I included a link to cover that case, but I am not sure if it is necessary. 2. Is there any other customization I need to include in the URL query params? 3. Are the manual requirements I included correct?
|
Hi @gr2m , are you able to take a look at this? My company is getting closer to deploying this app across multiple organizations and I'd like to get the README updated soon if at all possible. Thanks! |
gr2m
reviewed
Jan 13, 2024
|
@grossag can you get back to us regarding the open questions? No worries if you can't finish up the PR, just let us know |
Hi, sorry for the delay in responding. I'll work today on fixing this up based on your feedback. Back when I originally did the PR, I hadn't understood the breadth of how people use create-github-app-token. What you are saying makes sense though. |
It could use some more examples of permissions, but it's a start.
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.
After struggling twice through creating a GitHub App, I filed #89 and was encouraged to submit a pull request. This patch attempts to improve the documentation by:
I am not certain whether everything I added is correct, so please take a look and confirm. Parts I am unsure of: