Add logging and summary to label check

.github/workflows/issues-labels.yml

@@ -27,6 +27,11 @@ jobs:
         uses: ./.github/actions/github-script
         with:
           script: |
+            const fs = require('fs');
+
+            const issueNumber = context.issue.number;
+            const action = context.payload.action;
+            const changedLabel = context.payload.label?.name ?? null;
             const labels = context.payload.issue.labels.map(({ name }) => name);
             const requirements = [
               {
@@ -41,21 +46,54 @@ jobs:
 
             const labelsToAdd = [];
             const labelsToRemove = [];
+            const evaluations = [];
+
+            console.log(`::group::Issue label check for #${issueNumber}`);
+            console.log(`Event action: ${action}`);
+            if (changedLabel) {
+              console.log(`Event label: ${changedLabel}`);
+            }
+            console.log(
+              `Current labels: ${labels.length > 0 ? labels.join(', ') : '(none)'}`,
+            );
 
             for (const { prefix, reminder } of requirements) {
-              const hasRealLabel = labels.some(
+              const matchingRealLabels = labels.filter(
                 (name) => name.startsWith(prefix) && name !== reminder,
               );
+              const hasRealLabel = matchingRealLabels.length > 0;
               const hasReminderLabel = labels.includes(reminder);
 
+              evaluations.push({
+                prefix,
+                reminder,
+                matchingRealLabels,
+                hasReminderLabel,
+              });
+
               if (hasRealLabel && hasReminderLabel) {
                 labelsToRemove.push(reminder);
               } else if (!hasRealLabel && !hasReminderLabel) {
                 labelsToAdd.push(reminder);
               }
             }
 
+            for (const evaluation of evaluations) {
+              if (evaluation.matchingRealLabels.length > 0) {
+                console.log(
+                  `Found required ${evaluation.prefix}label(s): ${evaluation.matchingRealLabels.join(', ')}`,
+                );
+              } else {
+                console.log(`Missing required ${evaluation.prefix}label.`);
+              }
+
+              if (evaluation.hasReminderLabel) {
+                console.log(`Reminder label already present: ${evaluation.reminder}`);
+              }
+            }
+
             if (labelsToAdd.length > 0) {
+              console.log(`Adding reminder labels: ${labelsToAdd.join(', ')}`);
               await github.rest.issues.addLabels({
                 owner: context.repo.owner,
                 repo: context.repo.repo,
@@ -65,10 +103,47 @@ jobs:
             }
 
             for (const name of labelsToRemove) {
+              console.log(`Removing reminder label: ${name}`);
               await github.rest.issues.removeLabel({
                 owner: context.repo.owner,
                 repo: context.repo.repo,
                 issue_number: context.issue.number,
                 name,
               });
             }
+
+            if (labelsToAdd.length === 0 && labelsToRemove.length === 0) {
+              console.log('No label changes required.');
+            }
+
+            console.log('::endgroup::');
+
+            if (process.env.GITHUB_STEP_SUMMARY) {
+              const summaryLines = [
+                '### Issue Label Check',
+                `- Issue: #${issueNumber}`,
+                `- Event: ${action}`,
+                `- Trigger label: ${changedLabel ?? '(none)'}`,
+                `- Current labels: ${labels.length > 0 ? labels.join(', ') : '(none)'}`,
+                '',
+                '#### Requirement status',
+                ...evaluations.map((evaluation) => {
+                  const status =
+                    evaluation.matchingRealLabels.length > 0
+                      ? `found ${evaluation.matchingRealLabels.join(', ')}`
+                      : 'missing';
+                  const reminder = evaluation.hasReminderLabel
+                    ? `reminder present: ${evaluation.reminder}`
+                    : `reminder absent: ${evaluation.reminder}`;
+                  return `- ${evaluation.prefix}: ${status}; ${reminder}`;
+                }),
+                '',
+                `- Labels to add: ${labelsToAdd.length > 0 ? labelsToAdd.join(', ') : '(none)'}`,
+                `- Labels to remove: ${labelsToRemove.length > 0 ? labelsToRemove.join(', ') : '(none)'}`,
+              ];
+
+              fs.appendFileSync(
+                process.env.GITHUB_STEP_SUMMARY,
+                `${summaryLines.join('\n')}\n`,
+              );
+            }