Skip to content

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

Open
@grossag

Description

@grossag

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.

Activity

gr2m

gr2m commented on Dec 26, 2023

@gr2m
Contributor

I like that a lot. Pull request welcome!

added
documentationImprovements or additions to documentation
help wantedExtra attention is needed
on Dec 26, 2023
grossag

grossag commented on Dec 27, 2023

@grossag
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Participants

      @gr2m@grossag

      Issue actions

        Improve documentation in README.md about app creation step · Issue #89 · actions/create-github-app-token