Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation in README.md about app creation step #89

Open
grossag opened this issue Dec 23, 2023 · 2 comments · May be fixed by #90
Open

Improve documentation in README.md about app creation step #89

grossag opened this issue Dec 23, 2023 · 2 comments · May be fixed by #90
Labels
documentation Improvements or additions to documentation pull request welcome

Comments

@grossag
Copy link

grossag commented Dec 23, 2023

My company is going to be installing this action once per organization in order to get submodules to work. I would really like to be able to point them to https://github.com/actions/create-github-app-token for the documentation, but step 1 is not very clear and I am worried that people will get confused about what permissions to request.

I am wondering, can you expand upon step 1 which says:

Register new GitHub App

Option 1 would be to list which settings we are supposed to check and uncheck, as well as which permissions we should be requesting.
Option 2 would be to follow the example of GitHub ARC in https://github.com/actions/actions-runner-controller/blob/master/docs/authenticating-to-the-github-api.md which actually provides two useful links that prepopulate various settings:

Using GitHub ARC, it was really cool to be able to click one link and have it prepopulate the settings that it thinks I'll need.
@gr2m
Copy link
Contributor

gr2m commented Dec 26, 2023

I like that a lot. Pull request welcome!

@gr2m gr2m added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Dec 26, 2023
@grossag
Copy link
Author

grossag commented Dec 27, 2023

Thanks @gr2m . I can give it a try next week.

grossag added a commit to grossag/create-github-app-token that referenced this issue Dec 27, 2023
@grossag
Improve the README.md documentation of how to create a GitHub App
58c1ffb 
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?
@grossag grossag linked a pull request Dec 27, 2023 that will close this issue
Open
@parkerbxyz parkerbxyz linked a pull request Mar 1, 2024 that will close this issue
Improve the README.md documentation of how to create a GitHub App #90
Open
@gr2m gr2m added pull request welcome and removed help wanted Extra attention is needed labels May 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation pull request welcome
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve the README.md documentation of how to create a GitHub App grossag/create-github-app-token
2 participants
@gr2m @grossag