feat: added summary

src/handlers/summary.ts

@@ -0,0 +1,32 @@
+import * as core from "@actions/core";
+import { Context } from "../types";
+
+export interface ResultInfo {
+  url: string;
+  merged: boolean;
+}
+
+function generateGitHubSummary(context: Context, urls: ResultInfo[]): string {
+  let monitored = context.config.repos.monitor.join(" | ") + "\n\n";
+  const ignored = context.config.repos.ignore.join(" | ") + "\n\n";
+
+  monitored +=
+    ignored +
+    urls
+      .map(({ url, merged }) => {
+        const status = merged ? `<span style="color:green">merged</span>` : `<span style="color:grey">no change</span>`;
+        return `- [${url}](${url}) - ${status}`;
+      })
+      .join("\n");
+
+  return monitored;
+}
+
+export async function generateSummary(context: Context, results: ResultInfo[]) {
+  try {
+    const summary = generateGitHubSummary(context, results);
+    await core.summary.addRaw(summary).write();
+  } catch (e) {
+    context.logger.error("Could not publish the summary", { e });
+  }
+}

src/helpers/update-pull-requests.ts

@@ -1,6 +1,7 @@
 import { RestEndpointMethodTypes } from "@octokit/rest";
 import ms from "ms";
 import { getAllTimelineEvents } from "../handlers/github-events";
+import { generateSummary, ResultInfo } from "../handlers/summary";
 import { Context } from "../types";
 import {
   getApprovalCount,
@@ -27,11 +28,12 @@ function isIssueEvent(event: object): event is IssueEvent {
 
 export async function updatePullRequests(context: Context) {
   const { logger } = context;
+  const results: ResultInfo[] = [];
 
   if (!context.config.repos.monitor.length) {
     const owner = context.payload.repository.owner;
     if (owner) {
-      logger.info(`No organizations or repo have been specified, will default to the organization owner: ${owner}.`);
+      logger.info(`No organizations or repo have been specified, will default to the organization owner: ${owner.login}.`);
       context.config.repos.monitor.push(owner.login);
     } else {
       return logger.error("Could not set a default organization to watch, skipping.");
@@ -43,11 +45,14 @@ export async function updatePullRequests(context: Context) {
   if (!pullRequests?.length) {
     return logger.info("Nothing to do.");
   }
+
+  let isMerged = false;
   for (const { html_url } of pullRequests) {
+    isMerged = false;
     try {
       const gitHubUrl = parseGitHubUrl(html_url);
       const pullRequestDetails = await getPullRequestDetails(context, gitHubUrl);
-      logger.debug(`Processing pull-request ${html_url}...`);
+      logger.debug(`Processing pull-request ${html_url} ...`);
       if (pullRequestDetails.merged || pullRequestDetails.closed_at) {
         logger.info(`The pull request ${html_url} is already merged or closed, nothing to do.`);
         continue;
@@ -72,14 +77,16 @@ export async function updatePullRequests(context: Context) {
       if (isNaN(lastActivityDate.getTime())) {
         logger.info(`PR ${html_url} does not seem to have any activity, nothing to do.`);
       } else if (isPastOffset(lastActivityDate, requirements.mergeTimeout)) {
-        await attemptMerging(context, { gitHubUrl, htmlUrl: html_url, requirements, lastActivityDate, pullRequestDetails });
+        isMerged = await attemptMerging(context, { gitHubUrl, htmlUrl: html_url, requirements, lastActivityDate, pullRequestDetails });
       } else {
         logger.info(`PR ${html_url} has activity up until (${lastActivityDate}), nothing to do.`);
       }
     } catch (e) {
       logger.error(`Could not process pull-request ${html_url} for auto-merge: ${e}`);
     }
+    results.push({ url: html_url, merged: isMerged });
   }
+  await generateSummary(context, results);
 }
 
 async function attemptMerging(
@@ -96,12 +103,14 @@ async function attemptMerging(
     if (await isCiGreen(context, data.pullRequestDetails.head.sha, data.gitHubUrl)) {
       context.logger.info(`Pull-request ${data.htmlUrl} is past its due date (${data.requirements.mergeTimeout} after ${data.lastActivityDate}), will merge.`);
       await mergePullRequest(context, data.gitHubUrl);
+      return true;
     } else {
       context.logger.info(`Pull-request ${data.htmlUrl} (sha: ${data.pullRequestDetails.head.sha}) does not pass all CI tests, won't merge.`);
     }
   } else {
     context.logger.info(`Pull-request ${data.htmlUrl} does not have sufficient reviewer approvals to be merged.`);
   }
+  return false;
 }
 
 function isPastOffset(lastActivityDate: Date, offset: string): boolean {