feat(action): Update "Leaping" comment when workflow failed or cancelled early (#230)

* feat(action): Do cleanup when workflow failed or cancelled early.

* fix: avoid naming collision with get-installation-token state.

* tmp: add more logging for debugging purposes.

* fix: rm wasUpdated state.

* FIX: changing approach, separate entrypoint, using db to handle cases when main() never ran.

* fix(cleanup): revert changes to exitHandler.

* FIX: using event payload for issue and comment retrieval instead of DB.

* FIX: use installation token.

* feat(docs): wiki article explaining how it works.

* fix(docs): shortening.

* fix(docs): shortening.

* fix: no console.

* todo: DNRY for findPullfrogComment.

* FIX(DNRY): upgrading octokit/rest and reusing findInitialComment() from triggerWorkflow.ts.

* Revert "FIX(DNRY): upgrading octokit/rest and reusing findInitialComment() from triggerWorkflow.ts."

This reverts commit 7dd239ba0986c5b0aeacb6ddc9f2deddb83aee82.

* fix: rm todo.

* fix(DNRY): shortening early exit logging statements.

* FIX(API): Avoid extra call for comment body.

* feat(DNRY): extracting and reusing buildWorkflowErrorMessage() from exitHandler.ts.

* fix(DNRY): extracting more similarities into buildErrorCommentBody.

* feat: Add conditional reason check.

* fix(merge): replacing resolveInstallationToken with getJobToken.

* fix(debug): using higher severity.

* fix: Adjusting the implementation of getIsCancelled to use job status instead of workflow.

* fix: Take steps conclusion into account when job is in progress.

* fix: generic log msg.

* fix: jsdoc.

* fix(docs): Updating the wiki article according to recent changes.

* fix(post): Handling the case when current job runs within matrix.

* fix: finding the most recent comment that is ours ANS stuck.

* feat(opt): using progressCommentId from object-based prompt when present.

* fix(docs): Shortening the documentation 3 times down.

* FIX: Only using the prompt.progressCommentId but with validation that it is stuck.

entry

@@ -145666,6 +145666,19 @@ ${ctx.error}` : ctx.error;
 }
 
 // utils/exitHandler.ts
+function buildErrorCommentBody(params) {
+  const workflowRunLink = params.runId ? `[workflow run logs](https://github.com/${params.owner}/${params.repo}/actions/runs/${params.runId})` : "workflow run logs";
+  const errorMessage = params.isCancellation ? `This run was cancelled \u{1F6D1}
+
+The workflow was cancelled before completion. Please check the ${workflowRunLink} for details.` : `This run croaked \u{1F635}
+
+The workflow encountered an error before any progress could be reported. Please check the ${workflowRunLink} for details.`;
+  const footer = buildPullfrogFooter({
+    triggeredBy: true,
+    workflowRun: params.runId ? { owner: params.owner, repo: params.repo, runId: params.runId } : void 0
+  });
+  return `${errorMessage}${footer}`;
+}
 var cleanupFn;
 function setupExitHandler(toolState) {
   let hasCleanedUp = false;
@@ -145689,21 +145702,17 @@ function setupExitHandler(toolState) {
         const commentBody = existingComment.data.body || "";
         if (commentBody.startsWith(LEAPING_INTO_ACTION_PREFIX)) {
           const runId = process.env.GITHUB_RUN_ID;
-          const workflowRunLink = runId ? `[workflow run logs](https://github.com/${repoContext.owner}/${repoContext.name}/actions/runs/${runId})` : "workflow run logs";
-          const errorMessage = isCancellation ? `This run was cancelled \u{1F6D1}
-
-The workflow was cancelled before completion. Please check the ${workflowRunLink} for details.` : `This run croaked \u{1F635}
-
-The workflow encountered an error before any progress could be reported. Please check the ${workflowRunLink} for details.`;
-          const footer = buildPullfrogFooter({
-            triggeredBy: true,
-            workflowRun: runId ? { owner: repoContext.owner, repo: repoContext.name, runId } : void 0
+          const body = buildErrorCommentBody({
+            owner: repoContext.owner,
+            repo: repoContext.name,
+            runId,
+            isCancellation
           });
           await octokit.rest.issues.updateComment({
             owner: repoContext.owner,
             repo: repoContext.name,
             comment_id: commentId,
-            body: `${errorMessage}${footer}`
+            body
           });
           log.info("\xBB updated progress comment with error message");
         }