Impersonate Your GitHub App In A GitHub Action
This action helps you retrieve an authenticated app token with a GitHub app id and a app private key. You can use this key inside an actions workflow instead of GITHUB_TOKEN, in cases where the GITHUB_TOKEN has restricted rights.
Why Would You Do This?
Actions have certain limitations. Many of these limitations are for security and stability reasons, however not all of them are. Some examples where you might want to impersonate a GitHub App temporarily in your workflow:
- You want an event to trigger a workflow on a specific ref or branch in a way that is not natively supported by Actions. For example, a pull request comment fires the issue_comment event which is sent to the default branch and not the PR's branch. You can temporarily impersonate a GitHub App to make an event, such as a label a pull_request to trigger a workflow on the right branch. This takes advantage of the fact that Actions cannot create events that trigger workflows, however other Apps can.
Usage
-
If you do not already own a GitHub App you want to impersonate, create a new GitHub App with your desired permissions. If only creating a new app for the purposes of impersonation by Actions, you do not need to provide a
Webhook URL or Webhook Secret -
Install the App on your repositories.
-
See action.yml for the api spec.
Example:
steps:
- name: Get token
id: get_token
uses: tietoevry-dataplatforms/actions-app-token@master
with:
APP_PEM: ${{ secrets.APP_PEM }}
APP_ID: ${{ secrets.APP_ID }}
- name: Get App Installation Token
run: |
echo "This token is masked: ${TOKEN}"
env:
TOKEN: ${{ steps.get_token.outputs.app_token }}
Note: The input APP_PEM needs to be base64 encoded. You can encode your private key file like this from the terminal:
cat your_app_key.pem | base64 -w 0 && echo
The base64 encoded string must be on a single line, so be sure to remove any linebreaks when creating APP_PEM in your project's GitHub secrets.
Mandatory Inputs
-
APP_PEM: description: string version of your PEM file used to authenticate as a GitHub App. -
APP_ID: your GitHub App ID.
Outputs
app_token: The installation access token for the GitHub App corresponding to the current repository.
License
The scripts and documentation in this project are released under the MIT License.
Thank you
A thank you and inspiration from the original repo: https://github.com/machine-learning-apps/actions-app-token !
![:exclamation::exclamation::exclamation: [deprecated] Moved to https://github.com/go-macaron/macaron](https://raw.githubusercontent.com/Unknwon/macaron/master/macaronlogo.png)