fix: Rename input, from 'revoke' to 'skip-token-revoke'

Author: smockle

README.md

@@ -145,9 +145,9 @@ jobs:
 > [!NOTE]
 > If `owner` is set and `repositories` is empty, access will be scoped to all repositories in the provided repository owner's installation. If `owner` and `repositories` are empty, access will be scoped to only the current repository.
 
-### `revoke`
+### `skip-token-revoke`
 
-**Optional:** Whether to revoke the token when the current job is complete. Default: `"true"`.
+**Optional:** If truthy, the token will not be revoked when the current job is complete.
 
 ## Outputs
 
@@ -162,7 +162,7 @@ The action creates an installation access token using [the `POST /app/installati
 1. The token is scoped to the current repository or `repositories` if set.
 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. Unless `revoke: "false"` is set, the token is revoked in the `post` step of the action, which means it cannot be passed to another job.
+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.
 5. The token is masked, it cannot be logged accidentally.
 
 > [!NOTE]

action.yml

@@ -17,10 +17,9 @@ inputs:
   repositories:
     description: "Repositories to install the GitHub App on (defaults to current repository if owner is unset)"
     required: false
-  revoke:
-    description: "Whether to revoke the token when the current job is complete"
+  skip-token-revoke:
+    description: "If truthy, the token will not be revoked when the current job is complete"
     required: false
-    default: "true"
 outputs:
   token:
     description: "GitHub installation access token"

dist/main.cjs

@@ -15043,7 +15043,7 @@ var import_core = __toESM(require_core(), 1);
 var import_auth_app = __toESM(require_dist_node12(), 1);
 
 // lib/main.js
-async function main(appId2, privateKey2, owner2, repositories2, core2, createAppAuth2, request2, revoke2) {
+async function main(appId2, privateKey2, owner2, repositories2, core2, createAppAuth2, request2, skipTokenRevoke2) {
   let parsedOwner = "";
   let parsedRepositoryNames = "";
   if (!owner2 && !repositories2) {
@@ -15119,7 +15119,7 @@ async function main(appId2, privateKey2, owner2, repositories2, core2, createApp
   }
   core2.setSecret(authentication.token);
   core2.setOutput("token", authentication.token);
-  if (revoke2) {
+  if (!skipTokenRevoke2) {
     core2.saveState("token", authentication.token);
   }
 }
@@ -15144,7 +15144,7 @@ var appId = import_core.default.getInput("app_id");
 var privateKey = import_core.default.getInput("private_key");
 var owner = import_core.default.getInput("owner");
 var repositories = import_core.default.getInput("repositories");
-var revoke = import_core.default.getInput("revoke") === "true";
+var skipTokenRevoke = Boolean(import_core.default.getInput("skip-token-revoke"));
 main(
   appId,
   privateKey,
@@ -15155,7 +15155,7 @@ main(
   request_default.defaults({
     baseUrl: process.env["GITHUB_API_URL"]
   }),
-  revoke
+  skipTokenRevoke
 ).catch((error) => {
   console.error(error);
   import_core.default.setFailed(error.message);

dist/post.cjs

@@ -2955,8 +2955,8 @@ var import_core = __toESM(require_core(), 1);
 
 // lib/post.js
 async function post(core2, request2) {
-  const revoke = core2.getInput("revoke") === "true";
-  if (!revoke) {
+  const skipTokenRevoke = Boolean(core2.getInput("skip-token-revoke"));
+  if (skipTokenRevoke) {
     core2.info("Token revocation was skipped");
     return;
   }

lib/main.js

@@ -8,7 +8,7 @@
  * @param {import("@actions/core")} core
  * @param {import("@octokit/auth-app").createAppAuth} createAppAuth
  * @param {import("@octokit/request").request} request
- * @param {boolean} revoke
+ * @param {boolean} skipTokenRevoke
  */
 export async function main(
   appId,
@@ -18,7 +18,7 @@ export async function main(
   core,
   createAppAuth,
   request,
-  revoke
+  skipTokenRevoke
 ) {
   let parsedOwner = "";
   let parsedRepositoryNames = "";
@@ -124,7 +124,7 @@ export async function main(
   core.setOutput("token", authentication.token);
 
   // Make token accessible to post function (so we can invalidate it)
-  if (revoke) {
+  if (!skipTokenRevoke) {
     core.saveState("token", authentication.token);
   }
 }

lib/post.js

@@ -5,9 +5,9 @@
  * @param {import("@octokit/request").request} request
  */
 export async function post(core, request) {
-  const revoke = core.getInput("revoke") === "true";
+  const skipTokenRevoke = Boolean(core.getInput("skip-token-revoke"));
 
-  if (!revoke) {
+  if (skipTokenRevoke) {
     core.info("Token revocation was skipped");
     return;
   }

main.js

@@ -19,7 +19,7 @@ const privateKey = core.getInput("private_key");
 const owner = core.getInput("owner");
 const repositories = core.getInput("repositories");
 
-const revoke = core.getInput("revoke") === "true";
+const skipTokenRevoke = Boolean(core.getInput("skip-token-revoke"));
 
 main(
   appId,
@@ -31,7 +31,7 @@ main(
   request.defaults({
     baseUrl: process.env["GITHUB_API_URL"],
   }),
-  revoke
+  skipTokenRevoke
 ).catch((error) => {
   console.error(error);
   core.setFailed(error.message);

tests/post-token-set.test.js

@@ -4,10 +4,6 @@ import { MockAgent, setGlobalDispatcher } from "undici";
 // https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#sending-values-to-the-pre-and-post-actions
 process.env.STATE_token = "secret123";
 
-// inputs are set as environment variables with the prefix INPUT_
-// https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#example-specifying-inputs
-process.env.INPUT_REVOKE = "true";
-
 const mockAgent = new MockAgent();
 
 setGlobalDispatcher(mockAgent);

tests/post-token-skipped.test.js

@@ -6,7 +6,7 @@ process.env.STATE_token = "secret123";
 
 // inputs are set as environment variables with the prefix INPUT_
 // https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#example-specifying-inputs
-process.env.INPUT_REVOKE = "false";
+process.env["INPUT_SKIP-TOKEN-REVOKE"] = "true";
 
 const mockAgent = new MockAgent();
 

tests/post-token-unset.test.js

@@ -2,8 +2,4 @@
 // https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#sending-values-to-the-pre-and-post-actions
 delete process.env.STATE_token;
 
-// inputs are set as environment variables with the prefix INPUT_
-// https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#example-specifying-inputs
-process.env.INPUT_REVOKE = "true";
-
 await import("../post.js");