step-security/GitHub App token
Run a GitHub Action as a GitHub App instead of using secrets.GITHUB_TOKEN or a personal access token.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| app_id | ID of the GitHub App. | yes | — |
| github_api_url | The API URL of the GitHub server. | — | ${{ github.api_url }} |
| installation_retrieval_mode | The mode used to retrieve the installation for which the token will be requested. One of: - id: use the installation with the specified ID. - organization: use an organization installation (https://docs.github.com/en/rest/apps/apps?apiVersion=2022-11-28#get-an-organization-installation-for-the-authenticated-app). - repository: use a repository installation (https://docs.github.com/en/rest/apps/apps?apiVersion=2022-11-28#get-a-repository-installation-for-the-authenticated-app). - user: use a user installation (https://docs.github.com/en/rest/apps/apps?apiVersion=2022-11-28#get-a-user-installation-for-the-authenticated-app). | — | repository |
| installation_retrieval_payload | The payload used to retrieve the installation. Examples for each retrieval mode: - id: 1337 - organization: github - repository: step-security/github-app-token - user: step-security | — | ${{ github.repository }} |
| permissions | The JSON-stringified permissions granted to the token. Defaults to all permissions granted to the GitHub app. See https://docs.github.com/en/rest/apps/apps?apiVersion=2022-11-28#create-an-installation-access-token-for-an-app's `permissions`. | — | — |
| private_key | Private key of the GitHub App (can be Base64 encoded). | yes | — |
| repositories | The JSON-stringified array of the full names of the repositories the token should have access to. Defaults to all repositories that the installation can access. See https://docs.github.com/en/rest/apps/apps?apiVersion=2022-11-28#create-an-installation-access-token-for-an-app's `repositories`. | — | — |
| revoke | Revoke the token at the end of the job. | — | true |
Outputs
| name | description |
|---|---|
| token | An installation access token for the GitHub App. |