Skip to content

Commit 2d5eced

Browse files
committed
Remove documentation for unimplemented features
1 parent a66c805 commit 2d5eced

File tree

1 file changed

+2
-13
lines changed

1 file changed

+2
-13
lines changed

README.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,6 @@ jobs:
4646
# required
4747
app_id: ${{ vars.APP_ID }}
4848
private_key: ${{ secrets.PRIVATE_KEY }}
49-
# optional: set permissions (#TBD)
50-
permissions_contents: write
51-
# optional: set repositories
52-
owner: gr2m
53-
repositories: my-repo1,my-repo2
54-
# optional: disable token revocation
55-
revoke: false
5649
# do something with the token
5750
```
5851

@@ -103,18 +96,14 @@ GitHub installation access token.
10396
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,
10497

10598
1. The token is scoped to the current repository
106-
2. The token inherits all of the installations permissions
99+
2. The token inherits all the installation's permissions
107100
3. The token is set as output `token` which can be used in subsequent steps
108-
4. The token is revoked in the `post` step of the action, which means it cannot be passed to another job. Set `revoke: false` to disable revoking
101+
4. The token is revoked in the `post` step of the action, which means it cannot be passed to another job.
109102
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.
110103

111104
> **Note**
112105
> 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.
113106

114-
It is considered best practice to only request the permissions that are needed. You can define a subset of permissions using the `permissions_*` inputs. For example, if you only need to read the contents of a repository, you can set `permissions_contents: read`. If you need to read and write, you can set `permissions_contents: write`. You can only define permissions that are a subset of the respective installation's permissions.
115-
116-
You can grant access to the token to multiple repositories using the `account` and `repositories` inputs. For example, if you want to grant access to all repositories of the `gr2m` account, you can set `account: gr2m`. If you want to grant access to specific repositories, you can set `account: gr2m` and `repositories: repo1,repo2`. Unfortunately it is not possible to create a single token that has access across multiple accounts, as different accounts have different installations. You will have to call `gr2m/app-token-action` once per account instead.
117-
118107
## License
119108

120109
[MIT](LICENSE)

0 commit comments

Comments
 (0)