Skip to content

Commit

Permalink
docs(README): update title, description, formatting, and more (action…
Browse files Browse the repository at this point in the history
…s#11)

- Update title
- Remove blockquote formatting from description to improve accessibility
- Capitalize "app" in "GitHub App" for consistency
- Add missing periods in unordered list
- Use new highlight syntax for note
  • Loading branch information
parkerbxyz authored Aug 21, 2023
1 parent c04bb41 commit 950f8a0
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 950f8a0

Please sign in to comment.