feat: Add support for with.token (#106)

Author: fregante

README.md

@@ -62,6 +62,15 @@ steps:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
+or named `token` using [`with:`](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepswith)
+
+```yml
+steps:
+  - name: My action
+    with:
+      token: ${{ secrets.GITHUB_TOKEN }}
+```
+
 `GITHUB_TOKEN` can be set to any of the repository's secret, e.g. if you want to use a personal access token.
 
 ```yml
@@ -73,7 +82,7 @@ steps:
 
 `createActionAuth()` is also checking for the `GITHUB_ACTION` variable to be present to make sure that it runs within a GitHub Action.
 
-If `GITHUB_ACTION` or either `GITHUB_TOKEN` or `INPUT_GITHUB_TOKEN` is not set an error is thrown.
+If `GITHUB_ACTION` or neither `GITHUB_TOKEN`, `INPUT_GITHUB_TOKEN` or `INPUT_TOKEN` are set an error is thrown.
 
 ## `auth()`
 

src/index.ts

@@ -19,18 +19,24 @@ export const createActionAuth: StrategyInterface<
     );
   }
 
-  if (!process.env.GITHUB_TOKEN && !process.env.INPUT_GITHUB_TOKEN) {
+  const definitions = [
+    process.env.GITHUB_TOKEN,
+    process.env.INPUT_GITHUB_TOKEN,
+    process.env.INPUT_TOKEN,
+  ].filter(Boolean);
+
+  if (definitions.length === 0) {
     throw new Error(
       "[@octokit/auth-action] `GITHUB_TOKEN` variable is not set. It must be set on either `env:` or `with:`. See https://github.com/octokit/auth-action.js#createactionauth"
     );
   }
 
-  if (process.env.GITHUB_TOKEN && process.env.INPUT_GITHUB_TOKEN) {
+  if (definitions.length > 1) {
     throw new Error(
-      "[@octokit/auth-action] `GITHUB_TOKEN` variable is set on both `env:` and `with:`. Use either the one or the other. See https://github.com/octokit/auth-action.js#createactionauth"
+      "[@octokit/auth-action] The token variable is specified more than once. Use either `with.token`, `with.GITHUB_TOKEN`, or `env.GITHUB_TOKEN`. See https://github.com/octokit/auth-action.js#createactionauth"
     );
   }
 
-  const token = process.env.GITHUB_TOKEN || process.env.INPUT_GITHUB_TOKEN;
+  const token = definitions.pop();
   return createTokenAuth(token as string);
 };

test/index.test.ts

@@ -7,6 +7,7 @@ afterEach(() => {
   delete process.env.GITHUB_ACTION;
   delete process.env.GITHUB_TOKEN;
   delete process.env.INPUT_GITHUB_TOKEN;
+  delete process.env.INPUT_TOKEN;
 });
 
 test("README example", async () => {
@@ -38,6 +39,20 @@ test("README example using with:", async () => {
   });
 });
 
+test("README example using with.token", async () => {
+  process.env.GITHUB_ACTION = "my-action";
+  process.env.INPUT_TOKEN = "v1.1234567890abcdef1234567890abcdef12345678";
+
+  const auth = createActionAuth();
+  const authentication = await auth();
+
+  expect(authentication).toEqual({
+    type: "token",
+    token: "v1.1234567890abcdef1234567890abcdef12345678",
+    tokenType: "installation",
+  });
+});
+
 test("GITHUB_ACTION not set", async () => {
   try {
     const auth = createActionAuth();
@@ -60,7 +75,22 @@ test("both GITHUB_TOKEN and INPUT_GITHUB_TOKEN set", async () => {
     throw new Error("Should not resolve");
   } catch (error) {
     expect(error.message).toMatch(
-      /\[@octokit\/auth-action\] `GITHUB_TOKEN` variable is set on both `env:` and `with:`/i
+      /\[@octokit\/auth-action\] The token variable is specified more than once/i
+    );
+  }
+});
+
+test("both GITHUB_TOKEN and INPUT_TOKEN set", async () => {
+  process.env.GITHUB_ACTION = "my-action";
+  process.env.GITHUB_TOKEN = "v1.1234567890abcdef1234567890abcdef12345678";
+  process.env.INPUT_TOKEN = "v1.1234567890abcdef1234567890abcdef12345678";
+
+  try {
+    const auth = createActionAuth();
+    throw new Error("Should not resolve");
+  } catch (error) {
+    expect(error.message).toMatch(
+      /\[@octokit\/auth-action\] The token variable is specified more than once/i
     );
   }
 });