Skip to content

Impersonate a GitHub App in a GitHub Action

License

Notifications You must be signed in to change notification settings

dynamicaction/github-app-token

This branch is 5 commits behind tibdex/github-app-token:main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

c2055a0 · Jan 27, 2023

History

20 Commits
Jan 27, 2023
Jan 26, 2023
Apr 11, 2020
Jan 26, 2023
Jan 26, 2023
Oct 16, 2022
Jan 26, 2023
Jan 26, 2023
Jan 26, 2023
Jan 26, 2023
Jan 26, 2023

Repository files navigation

GitHub App Token

This JavaScript GitHub Action can be used to impersonate a GitHub App when secrets.GITHUB_TOKEN's limitations are too restrictive and a personal access token is not suitable.

For instance, from GitHub Actions' docs:

When you use the repository's GITHUB_TOKEN to perform tasks, events triggered by the GITHUB_TOKEN, with the exception of workflow_dispatch and repository_dispatch, will not create a new workflow run. This prevents you from accidentally creating recursive workflow runs. For example, if a workflow run pushes code using the repository's GITHUB_TOKEN, a new workflow will not run even when the repository contains a workflow configured to run when push events occur.

A workaround is to use a personal access token from a personal user/bot account. However, for organizations, GitHub Apps are a more appropriate automation solution.

Example Workflow

jobs:
  job:
    runs-on: ubuntu-latest
    steps:
      - name: Generate token
        id: generate_token
        uses: tibdex/github-app-token@v1
        with:
          app_id: ${{ secrets.APP_ID }}

          # Optional.
          # github_api_url: https://api.example.com

          # Optional.
          # installation_id: 1337

          # Optional.
          # Using a YAML multiline string to avoid escaping the JSON quotes.
          # permissions: >-
          #   {"members": "read"}

          private_key: ${{ secrets.PRIVATE_KEY }}

          # Optional.
          # repository: owner/repo

      - name: Use token
        env:
          TOKEN: ${{ steps.generate_token.outputs.token }}
        run: |
          echo "The generated token is masked: ${TOKEN}"

Another use case for this action can (or could) be found in GitHub's own docs.

About

Impersonate a GitHub App in a GitHub Action

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 63.2%
  • JavaScript 36.8%