Skip to content

Commit 950f8a0

Browse files
authored
docs(README): update title, description, formatting, and more (#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
1 parent c04bb41 commit 950f8a0

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# `actions/github-app-token`
1+
# Create GitHub App Token
22

3-
> GitHub Action for creating a GitHub App Installation Access Token
3+
GitHub Action for creating a GitHub App installation access token.
44

55
## Usage
66

@@ -61,29 +61,29 @@ jobs:
6161

6262
### `app_id`
6363

64-
**Required:** GitHub app ID.
64+
**Required:** GitHub App ID.
6565

6666
### `private_key`
6767

68-
**Required:** GitHub app private key.
68+
**Required:** GitHub App private key.
6969

7070
## Outputs
7171

7272
### `token`
7373

74-
GitHub installation access token.
74+
GitHub App installation access token.
7575

7676
## How it works
7777

7878
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,
7979

80-
1. The token is scoped to the current repository
81-
2. The token inherits all the installation's permissions
82-
3. The token is set as output `token` which can be used in subsequent steps
80+
1. The token is scoped to the current repository.
81+
2. The token inherits all the installation's permissions.
82+
3. The token is set as output `token` which can be used in subsequent steps.
8383
4. The token is revoked in the `post` step of the action, which means it cannot be passed to another job.
8484
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.
8585

86-
> **Note**
86+
> [!NOTE]
8787
> 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.
8888

8989
## License

0 commit comments

Comments
 (0)