feat: Add more/better logging

Author: smockle

.github/actions/file/src/index.ts

@@ -6,46 +6,63 @@ import { closeIssueForFinding } from "./closeIssueForFinding.js";
 import { openIssueForFinding } from "./openIssueForFinding.js";
 
 export default async function () {
+  core.info("Started 'file' action");
   const findings: Finding[] = JSON.parse(core.getInput('findings', { required: true }));
   const repoWithOwner = core.getInput('repository', { required: true });
   const token = core.getInput('token', { required: true });
   const cachedFindings: Finding[] = JSON.parse(core.getInput('cached_findings', { required: false }) || "[]");
+  core.debug(`Input: 'findings: ${JSON.stringify(findings)}'`);
+  core.debug(`Input: 'repository: ${repoWithOwner}'`);
+  core.debug(`Input: 'cached_findings: ${JSON.stringify(cachedFindings)}'`);
 
   const findingsMap = toFindingsMap(findings);
   const cachedFindingsMap = toFindingsMap(cachedFindings);
 
   const octokit = new Octokit({ auth: token });
-
   const closedIssueUrls = [];
+  const openedIssueUrls = [];
+  const repeatIssueUrls = [];
+
   for (const cachedFinding of cachedFindings) {
     if (!findingsMap.has(`${cachedFinding.url};${cachedFinding.problemShort};${cachedFinding.html}`)) {
-      // Finding was not found in the latest run, so close its issue (if necessary)
-      const response = await closeIssueForFinding(octokit, repoWithOwner, cachedFinding);
-      closedIssueUrls.push(response.data.html_url);
-      console.log(`Closed issue: ${response.data.title} (${repoWithOwner}#${response.data.number})`);
+      try {
+        // Finding was not found in the latest run, so close its issue (if necessary)
+        const response = await closeIssueForFinding(octokit, repoWithOwner, cachedFinding);
+        closedIssueUrls.push(response.data.html_url);
+        core.info(`Closed issue: ${response.data.title} (${repoWithOwner}#${response.data.number})`);
+      } catch (error) {
+        core.error(`Failed to close issue for finding: ${error}`);
+      }
     }
   }
 
-  const openedIssueUrls = [];
-  const repeatIssueUrls = [];
   for (const finding of findings) {
     const cachedIssueUrl = cachedFindingsMap.get(`${finding.url};${finding.problemShort};${finding.html}`)?.issueUrl
     finding.issueUrl = cachedIssueUrl;
-    const response = await openIssueForFinding(octokit, repoWithOwner, finding);
-    finding.issueUrl = response.data.html_url;
-    if (response.data.html_url === cachedIssueUrl) {
-      // Finding was found in previous and latest runs, so reopen its issue (if necessary)
-      repeatIssueUrls.push(response.data.html_url);
-      console.log(`Repeated issue: ${response.data.title} (${repoWithOwner}#${response.data.number})`);
-    } else {
-      // New finding was found in the latest run, so create its issue
-      openedIssueUrls.push(response.data.html_url);
-      console.log(`Created issue: ${response.data.title} (${repoWithOwner}#${response.data.number})`);
+    try {
+      const response = await openIssueForFinding(octokit, repoWithOwner, finding);
+      finding.issueUrl = response.data.html_url;
+      if (response.data.html_url === cachedIssueUrl) {
+        // Finding was found in previous and latest runs, so reopen its issue (if necessary)
+        repeatIssueUrls.push(response.data.html_url);
+        core.info(`Repeated issue: ${response.data.title} (${repoWithOwner}#${response.data.number})`);
+      } else {
+        // New finding was found in the latest run, so create its issue
+        openedIssueUrls.push(response.data.html_url);
+        core.info(`Created issue: ${response.data.title} (${repoWithOwner}#${response.data.number})`);
+      }
+    } catch (error) {
+      core.error(`Failed to open/reopen issue for finding: ${error}`);
     }
   }
 
   core.setOutput("closed_issue_urls", JSON.stringify(closedIssueUrls));
   core.setOutput("opened_issue_urls", JSON.stringify(openedIssueUrls));
   core.setOutput("repeated_issue_urls", JSON.stringify(repeatIssueUrls));
   core.setOutput("findings", JSON.stringify(findings));
+  core.debug(`Output: 'closed_issue_urls: ${JSON.stringify(closedIssueUrls)}'`);
+  core.debug(`Output: 'opened_issue_urls: ${JSON.stringify(openedIssueUrls)}'`);
+  core.debug(`Output: 'repeated_issue_urls: ${JSON.stringify(repeatIssueUrls)}'`);
+  core.debug(`Output: 'findings: ${JSON.stringify(findings)}'`);
+  core.info("Finished 'file' action");
 }

.github/actions/find/src/index.ts

@@ -2,17 +2,24 @@ import core from "@actions/core";
 import { findForUrl } from "./findForUrl.js";
 
 export default async function () {
+  core.info("Starting 'find' action");
   const urls = core.getMultilineInput('urls', { required: true });
+  core.debug(`Input: 'urls: ${JSON.stringify(urls)}'`);
 
   let findings = [];
   for (const url of urls) {
+    core.info(`Scanning ${url}`)
     const findingsForUrl = await findForUrl(url);
     if (findingsForUrl.length === 0) {
-      console.log(`No accessibility gaps were found on ${url}`);
+      core.info(`No accessibility gaps were found on ${url}`);
       continue;
     }
     findings.push(...findingsForUrl);
+    core.info(`Found ${findingsForUrl.length} findings for ${url}`);
   }
 
   core.setOutput("findings", JSON.stringify(findings));
+  core.debug(`Output: 'findings: ${JSON.stringify(findings)}'`);
+  core.info(`Found ${findings.length} findings in total`);
+  core.info("Finished 'find' action");
 }

.github/actions/fix/src/index.ts

@@ -3,13 +3,21 @@ import { Octokit } from '@octokit/core';
 import { fixIssue } from "./fixIssue.js";
 
 export default async function () {
+  core.info("Started 'fix' action");
   const issueUrls = JSON.parse(core.getInput('issue_urls', { required: true }));
   const repoWithOwner = core.getInput('repository', { required: true });
   const token = core.getInput('token', { required: true });
+  core.debug(`Input: 'issue_urls: ${JSON.stringify(issueUrls)}'`);
+  core.debug(`Input: 'repository: ${repoWithOwner}'`);
 
   const octokit = new Octokit({ auth: token });
   for (const issueUrl of issueUrls) {
-    await fixIssue(octokit, repoWithOwner, issueUrl);
-    console.log(`Assigned ${repoWithOwner}#${issueUrl.split('/').pop()} to Copilot!`);
+    try {
+      await fixIssue(octokit, repoWithOwner, issueUrl);
+      core.info(`Assigned ${repoWithOwner}#${issueUrl.split('/').pop()} to Copilot!`);
+    } catch (error) {
+      core.error(`Failed to assign ${repoWithOwner}#${issueUrl.split('/').pop()} to Copilot: ${error}`);
+    }
   }
+  core.info("Finished 'fix' action");
 }