From 5611f921d9c193430bc69fd5931e07e9e1942c12 Mon Sep 17 00:00:00 2001 From: Josh Gross Date: Sat, 26 Aug 2023 00:51:50 -0400 Subject: [PATCH] docs(README): clarify token masking (#29) With #13, this action is explicitly masking the token so we don't need to mention that we're relying on a specific format of GitHub tokens being masked by the runner. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0b4ec23..ba5f493 100644 --- a/README.md +++ b/README.md @@ -81,7 +81,7 @@ The action creates an installation access token using [the `POST /app/installati 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. +5. The token is masked, it cannot be logged accidentally. > [!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.