fix: Fail fast if githubToken not supplied

Previously if `githubToken` was not supplied we'd fail at the point of commenting. This change fails at the start.
guardian · Nov 20, 2023 · adbca41 · adbca41
1 parent 34464fc
commit adbca41
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 5 deletions.
diff --git a/dist/index.js b/dist/index.js
@@ -63703,7 +63703,7 @@ function getConfiguration() {
       projectName,
       buildNumber,
       commentingStage,
-      githubToken
+      githubToken: githubToken()
     }
   };
 }
@@ -63749,7 +63749,7 @@ function getCommentMessage(config) {
 }
 async function commentOnPullRequest(pullRequestNumber, config) {
   const comment = getCommentMessage(config);
-  const octokit = (0, import_github.getOctokit)(config.githubToken());
+  const octokit = (0, import_github.getOctokit)(config.githubToken);
   const comments = await octokit.rest.issues.listComments({
     ...import_github.context.repo,
     issue_number: pullRequestNumber

diff --git a/src/config.ts b/src/config.ts
@@ -146,7 +146,7 @@ export interface PullRequestCommentConfig {
 	projectName: string;
 	buildNumber: string;
 	commentingStage: string;
-	githubToken: () => string;
+	githubToken: string;
 }
 
 export interface Configuration {
@@ -208,7 +208,7 @@ export function getConfiguration(): Configuration {
 			projectName,
 			buildNumber,
 			commentingStage,
-			githubToken,
+			githubToken: githubToken(),
 		},
 	};
 }
diff --git a/src/index.test.ts b/src/index.test.ts
@@ -30,6 +30,7 @@ describe('action', () => {
 
 		const input = `dryRun: true
 app: foo
+githubToken: ${process.env['GITHUB_SECRET'] ?? 'dev'}
 stagingDir: staging
 contentDirectories: |
   upload:

diff --git a/src/pr-comment.ts b/src/pr-comment.ts
@@ -54,7 +54,7 @@ export async function commentOnPullRequest(
 	config: PullRequestCommentConfig,
 ) {
 	const comment = getCommentMessage(config);
-	const octokit = getOctokit(config.githubToken());
+	const octokit = getOctokit(config.githubToken);
 
 	const comments = await octokit.rest.issues.listComments({
 		...context.repo,