Skip to content

Commit 0f0eed1

Browse files
committed
NO-ISSUE Explicitly set the default value to false, and update document
1 parent 9eb195e commit 0f0eed1

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,7 @@ The reason we define one `permision-<permission name>` input per permission is t
343343

344344
### `skip-token-revoke`
345345

346-
**Optional:** If truthy, the token will not be revoked when the current job is complete.
346+
**Optional:** If true, the token will not be revoked when the current job is complete.
347347

348348
### `github-api-url`
349349

@@ -370,7 +370,7 @@ The action creates an installation access token using [the `POST /app/installati
370370
1. The token is scoped to the current repository or `repositories` if set.
371371
2. The token inherits all the installation's permissions.
372372
3. The token is set as output `token` which can be used in subsequent steps.
373-
4. Unless the `skip-token-revoke` input is set to a truthy value, the token is revoked in the `post` step of the action, which means it cannot be passed to another job.
373+
4. Unless the `skip-token-revoke` input is set to true, the token is revoked in the `post` step of the action, which means it cannot be passed to another job.
374374
5. The token is masked, it cannot be logged accidentally.
375375

376376
> [!NOTE]

action.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,13 @@ inputs:
2626
description: "Comma or newline-separated list of repositories to install the GitHub App on (defaults to current repository if owner is unset)"
2727
required: false
2828
skip-token-revoke:
29-
description: "If truthy, the token will not be revoked when the current job is complete"
29+
description: "If true, the token will not be revoked when the current job is complete"
3030
required: false
31+
default: "false"
3132
skip_token_revoke:
32-
description: "If truthy, the token will not be revoked when the current job is complete"
33+
description: "If true, the token will not be revoked when the current job is complete"
3334
required: false
35+
default: "false"
3436
deprecationMessage: "'skip_token_revoke' is deprecated and will be removed in a future version. Use 'skip-token-revoke' instead."
3537
# Make GitHub API configurable to support non-GitHub Cloud use cases
3638
# see https://github.com/actions/create-github-app-token/issues/77

0 commit comments

Comments
 (0)