diff --git a/README.md b/README.md index 40f57b9..9f467e2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# `actions/github-app-token` +# Create GitHub App Token -> GitHub Action for creating a GitHub App Installation Access Token +GitHub Action for creating a GitHub App installation access token. ## Usage @@ -61,29 +61,29 @@ jobs: ### `app_id` -**Required:** GitHub app ID. +**Required:** GitHub App ID. ### `private_key` -**Required:** GitHub app private key. +**Required:** GitHub App private key. ## Outputs ### `token` -GitHub installation access token. +GitHub App installation access token. ## How it works The action creates an installation access token using [the `POST /app/installations/{installation_id}/access_tokens` endpoint](https://docs.github.com/rest/apps/apps?apiVersion=2022-11-28#create-an-installation-access-token-for-an-app). By default, -1. The token is scoped to the current repository -2. The token inherits all the installation's permissions -3. The token is set as output `token` which can be used in subsequent steps +1. The token is scoped to the current repository. +2. The token inherits all the installation's permissions. +3. The token is set as output `token` which can be used in subsequent steps. 4. The token is revoked in the `post` step of the action, which means it cannot be passed to another job. 5. The token is masked, it cannot be logged accidentally. That is not a feature by the action, but by the GitHub Actions runner itself, due to the specific format of GitHub tokens. -> **Note** +> [!NOTE] > Installation permissions can differ from the app's permissions they belong to. Installation permissions are set when an app is installed on an account. When the app adds more permissions after the installation, an account administrator will have to approve the new permissions before they are set on the installation. ## License