Require close-comment

Co-authored-by: Wryn (yage) Wagner <[email protected]>

.github/workflows/check.yml

@@ -56,6 +56,7 @@ jobs:
         with:
           stale-label: stale
           days-before-close: 7
+          close-message: Closing this issue as it has become stale.
           dry-run: true
 
       - name: Check output

action.yml

@@ -13,19 +13,20 @@ inputs:
     default: ${{ github.token }}
   github-repo:
     required: true
-    description: GitHub `author/repository` for which stale issues are paused
+    description: GitHub `owner/repository` for which stale issues are paused
     default: ${{ github.repository }}
   stale-label:
     required: true
     description: Label which marks an issue as stale
   days-before-close:
     required: true
-    description: Days before an issue is closed after the stale label has been added it
+    description: Days before an issue is closed after the stale label has been added to it
   close-comment:
+    required: true
     description: Comment which will be added to issues when closing
   dry-run:
     description: Run the action without effectively closing stale issues
-    default: false
+    default: 'false'
 
 outputs:
   closed-issues:

src/lib/close-issue.ts

@@ -3,19 +3,17 @@ import core from '@actions/core';
 import type { Config } from './get-config.js';
 import type { Issue } from './get-stale-issues.js';
 
-export async function closeIssue({ octokit, ownerRepo, closeMessage, dryRun }: Config, { number, url, staleSince }: Issue) {
+export async function closeIssue({ dryRun, octokit, ownerRepo, closeMessage }: Config, { number, url, staleSince }: Issue) {
 	if (dryRun) {
 		core.info(`Issue #${number} (${url}) is stale since ${staleSince} and would have been closed (dry-run)`);
 		return;
 	}
 
-	if (closeMessage) {
-		await octokit.rest.issues.createComment({
-			...ownerRepo,
-			issue_number: number,
-			body: closeMessage,
-		});
-	}
+	await octokit.rest.issues.createComment({
+		...ownerRepo,
+		issue_number: number,
+		body: closeMessage,
+	});
 
 	await octokit.rest.issues.update({
 		...ownerRepo,

src/lib/get-config.ts

@@ -7,7 +7,7 @@ export interface Config {
 	ownerRepo: { owner: string; repo: string };
 	staleLabel: string;
 	daysBeforeClose: number;
-	closeMessage: string | null;
+	closeMessage: string;
 	dryRun: boolean;
 }
 
@@ -52,7 +52,7 @@ export async function getConfig(): Promise<Config> {
 		throw new TypeError('"days-before-close" must be a number');
 	}
 
-	const closeMessage = core.getInput('close-message') || null;
+	const closeMessage = core.getInput('close-message');
 
 	return {
 		octokit,