Add support for github tokens for private repos. (#83)

Signed-off-by: Mathias L. Baumann <mathias.baumann@frequenz.com>

README.md

@@ -41,6 +41,11 @@ The message to emit when the check fails. All other inputs can be specified in
 the message using `${}` syntax, e.g. `${file-pattern}` for the `file-pattern`
 input. All values will be quoted for easy identification of any whitespace.
 
+### `token`
+
+A GitHub auth token to use for private repositories. Falls back to anonymous access if
+not provided. Usually you want to use `${{ secrets.GITHUB_TOKEN }}` for this.
+
 ## Example usage (for requiring a news entry file)
 
 E.g. for use with [scriv](https://scriv.readthedocs.io/):

action.yml

@@ -19,6 +19,10 @@ inputs:
     description: "String template used when the check fails"
     required: false
     default: "the prerequisite file pattern ${prereq-pattern} matched changed files in the pull request, but the ${file-pattern} pattern did NOT and the ${skip-label} label is not set"
+  token:
+    description: "GitHub token to use to checkout the pull request files."
+    default: ""
+    required: False
 runs:
   using: "node16"
   main: "dist/index.js"

dist/index.js

@@ -11624,6 +11624,7 @@ exports.changedFiles = exports.pullRequestLabels = exports.pullRequestPayload =
 const github = __importStar(__nccwpck_require__(5438));
 const core_1 = __nccwpck_require__(6762);
 const plugin_paginate_rest_1 = __nccwpck_require__(4193);
+const core = __importStar(__nccwpck_require__(2186));
 function isPullRequest(eventName, payload) {
     return eventName === "pull_request";
 }
@@ -11651,7 +11652,9 @@ exports.pullRequestLabels = pullRequestLabels;
  */
 async function changedFiles(payload) {
     const MyOctokit = core_1.Octokit.plugin(plugin_paginate_rest_1.paginateRest);
-    const octokit = new MyOctokit(); // Anonymous to avoid asking for an access token.
+    // Get the token from the inputs
+    const token = core.getInput("token");
+    const octokit = token ? new MyOctokit({ auth: token }) : new MyOctokit();
     return await octokit.paginate("GET /repos/{owner}/{repo}/pulls/{pull_number}/files", {
         owner: payload.repository.owner.login,
         repo: payload.repository.name,

src/gh.ts

@@ -2,6 +2,7 @@ import * as github from "@actions/github";
 import { Octokit } from "@octokit/core";
 import { paginateRest } from "@octokit/plugin-paginate-rest";
 import { EventPayloads } from "@octokit/webhooks";
+import * as core from "@actions/core";
 
 function isPullRequest(
   eventName: string,
@@ -40,7 +41,11 @@ export async function changedFiles(
   payload: EventPayloads.WebhookPayloadPullRequest
 ): Promise<string[]> {
   const MyOctokit = Octokit.plugin(paginateRest);
-  const octokit = new MyOctokit(); // Anonymous to avoid asking for an access token.
+
+  // Get the token from the inputs
+  const token = core.getInput("token");
+
+  const octokit = token ? new MyOctokit({ auth: token }) : new MyOctokit();
 
   return await octokit.paginate(
     "GET /repos/{owner}/{repo}/pulls/{pull_number}/files",