idealo / github-app-token-generator

GitHub action for generating an installation token for a GitHub App

GitHub App installation access token generator

GitHub Action that can be used to generate an installation access token for a GitHub App. This token can for instance be used to clone repos, given the GitHub App has sufficient permissions to do so.

Usage

name: Checkout repos
on: push
jobs:
  checkout:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: idealo/[email protected]
      id: get-token
      with:
        private-key: ${{ secrets.IDEALO_BOT_GH_APP_PRIVATE_KEY }}
        app-id: ${{ secrets.IDEALO_BOT_GH_APP_ID }}

    - name: Check out an other repo
      uses: actions/checkout@v2
      with:
        repository: owner/repo
        token: ${{ steps.get-token.outputs.token }}

Requirements

The action needs two input parameters, private-key and app-id. To get these, simply create a GitHub App. The private key can be generated and downloaded, and should be added to the repos as a secret.

The installation ID that is used during the creation of the access token is created against the repo running the action. If you need to create the installation ID for a different repo you can use the repo input:

uses: idealo/[email protected]
id: get-token
with:
  private-key: ${{ secrets.IDEALO_BOT_GH_APP_PRIVATE_KEY }}
  app-id: ${{ secrets.IDEALO_BOT_GH_APP_ID }}
  repo: some/repo