Dump resources, especially checks, for debugging

.github/workflows/outputs.yml

@@ -0,0 +1,65 @@
+name: Outputs
+on:
+  push:
+    branches: [main]
+    paths:
+      - '.github/workflows/outputs.yml'
+      - 'action.yml'
+      - 'dist/**'
+  pull_request:
+    paths:
+      - '.github/workflows/outputs.yml'
+      - 'action.yml'
+      - 'dist/**'
+  workflow_dispatch:
+
+# Disable all permissions in workflow global as to setup clean room
+# However PRs will have read permissions because this project is on a public repository
+permissions: {}
+
+jobs:
+  echo:
+    runs-on: ubuntu-24.04
+    timeout-minutes: 5
+    steps:
+      - run: echo ':)'
+      # Wait longer than min-interval-seconds
+      - run: sleep 8
+      - run: echo '🎉'
+  dump:
+    runs-on: ubuntu-24.04
+    if: ${{ github.actor != 'dependabot[bot]' && github.actor != 'renovate[bot]' }}
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # v4.1.2
+      - uses: ./
+        id: wait
+        with:
+          retry-method: 'equal_intervals'
+          wait-seconds-before-first-polling: '1'
+          min-interval-seconds: '3'
+          skip-same-workflow: 'false'
+          wait-list: |
+            [
+              {
+                "workflowFile": "outputs.yml",
+                "jobName": "echo",
+                "optional": false
+              }
+            ]
+      - name: 'Copy the output results to files'
+        env:
+          DEBUG_DUMP: '${{ steps.wait.outputs.dump }}'
+        run: |
+          mkdir outputs
+          echo -n "$DEBUG_DUMP" > ./outputs/dump.json
+          ls -alh ./outputs
+          set +e
+          if [[ -s './outputs/dump.json' ]] && [[ '${{ runner.debug }}' != '1' ]]; then
+            exit 2
+          fi
+      - name: Upload dumps as an artifact
+        uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3
+        with:
+          name: 'outputs-${{ github.job }}-${{ github.run_id }}-${{ github.run_number }}-${{ github.run_attempt }}'
+          path: ./outputs

README.md

@@ -89,6 +89,13 @@ permissions:
   actions: read
 ```
 
+## jobs.<job_id>.outputs
+
+(Since v3.4.0)
+
+If used in debug mode, this action outputs the used resources into the `dump` key.\
+This data is only provided for debugging purposes, so the schema is not defined.
+
 ## Examples
 
 I'm using this action for auto-merging bot PRs and wait for deploy.\

dist/index.js

@@ -726,7 +726,7 @@ var require_tunnel = __commonJS({
         connectOptions.headers = connectOptions.headers || {};
         connectOptions.headers["Proxy-Authorization"] = "Basic " + new Buffer(connectOptions.proxyAuth).toString("base64");
       }
-      debug3("making CONNECT request");
+      debug("making CONNECT request");
       var connectReq = self.request(connectOptions);
       connectReq.useChunkedEncodingByDefault = false;
       connectReq.once("response", onResponse);
@@ -746,7 +746,7 @@ var require_tunnel = __commonJS({
         connectReq.removeAllListeners();
         socket.removeAllListeners();
         if (res.statusCode !== 200) {
-          debug3(
+          debug(
             "tunneling socket could not be established, statusCode=%d",
             res.statusCode
           );
@@ -758,21 +758,21 @@ var require_tunnel = __commonJS({
           return;
         }
         if (head.length > 0) {
-          debug3("got illegal response body from proxy");
+          debug("got illegal response body from proxy");
           socket.destroy();
           var error2 = new Error("got illegal response body from proxy");
           error2.code = "ECONNRESET";
           options.request.emit("error", error2);
           self.removeSocket(placeholder);
           return;
         }
-        debug3("tunneling connection has established");
+        debug("tunneling connection has established");
         self.sockets[self.sockets.indexOf(placeholder)] = socket;
         return cb(socket);
       }
       function onError(cause) {
         connectReq.removeAllListeners();
-        debug3(
+        debug(
           "tunneling socket could not be established, cause=%s\n",
           cause.message,
           cause.stack
@@ -834,9 +834,9 @@ var require_tunnel = __commonJS({
       }
       return target;
     }
-    var debug3;
+    var debug;
     if (process.env.NODE_DEBUG && /\btunnel\b/.test(process.env.NODE_DEBUG)) {
-      debug3 = function() {
+      debug = function() {
         var args = Array.prototype.slice.call(arguments);
         if (typeof args[0] === "string") {
           args[0] = "TUNNEL: " + args[0];
@@ -846,10 +846,10 @@ var require_tunnel = __commonJS({
         console.error.apply(console, args);
       };
     } else {
-      debug3 = function() {
+      debug = function() {
       };
     }
-    exports.debug = debug3;
+    exports.debug = debug;
   }
 });
 
@@ -18878,15 +18878,15 @@ var require_core = __commonJS({
 Support boolean input list: \`true | True | TRUE | false | False | FALSE\``);
     }
     exports.getBooleanInput = getBooleanInput2;
-    function setOutput(name, value) {
+    function setOutput2(name, value) {
       const filePath = process.env["GITHUB_OUTPUT"] || "";
       if (filePath) {
         return file_command_1.issueFileCommand("OUTPUT", file_command_1.prepareKeyValueMessage(name, value));
       }
       process.stdout.write(os2.EOL);
       command_1.issueCommand("set-output", { name }, utils_1.toCommandValue(value));
     }
-    exports.setOutput = setOutput;
+    exports.setOutput = setOutput2;
     function setCommandEcho(enabled) {
       command_1.issue("echo", enabled ? "on" : "off");
     }
@@ -18896,14 +18896,14 @@ Support boolean input list: \`true | True | TRUE | false | False | FALSE\``);
       error2(message);
     }
     exports.setFailed = setFailed2;
-    function isDebug3() {
+    function isDebug2() {
       return process.env["RUNNER_DEBUG"] === "1";
     }
-    exports.isDebug = isDebug3;
-    function debug3(message) {
+    exports.isDebug = isDebug2;
+    function debug(message) {
       command_1.issueCommand("debug", {}, message);
     }
-    exports.debug = debug3;
+    exports.debug = debug;
     function error2(message, properties = {}) {
       command_1.issueCommand("error", utils_1.toCommandProperties(properties), message instanceof Error ? message.toString() : message);
     }
@@ -31125,9 +31125,6 @@ function parseInput() {
     if (typeof prSha === "string") {
       commitSha = prSha;
     } else {
-      if ((0, import_core.isDebug)()) {
-        (0, import_core.debug)(JSON.stringify({ label: "PullRequestContext", pr: pr2 }, null, 2));
-      }
       (0, import_core.error)("github context has unexpected format: missing context.payload.pull_request.head.sha");
     }
   }
@@ -31161,7 +31158,7 @@ function parseInput() {
   const trigger = { ...repo, ref: commitSha, runId, jobName: job, eventName };
   const githubToken = (0, import_core.getInput)("github-token", { required: true, trimWhitespace: false });
   (0, import_core.setSecret)(githubToken);
-  return { trigger, options, githubToken };
+  return { trigger, options, githubToken, payload };
 }
 
 // node_modules/.pnpm/[email protected]/node_modules/universal-user-agent/index.js
@@ -32555,8 +32552,9 @@ function colorize(severity, message) {
 async function run() {
   const startedAt = performance.now();
   (0, import_core3.startGroup)("Parameters");
-  const { trigger, options, githubToken } = parseInput();
+  const { trigger, options, githubToken, payload } = parseInput();
   (0, import_core3.info)(JSON.stringify(
+    // Do NOT include payload
     {
       trigger,
       startedAt,
@@ -32572,6 +32570,7 @@ async function run() {
   if (options.isDryRun) {
     return;
   }
+  const dumper = { trigger, options, payload, results: [] };
   for (; ; ) {
     attempts += 1;
     if (attempts > options.attemptLimits) {
@@ -32589,9 +32588,6 @@ async function run() {
     const elapsed = mr.Duration.from({ milliseconds: Math.ceil(performance.now() - startedAt) });
     (0, import_core3.startGroup)(`Polling ${attempts}: ${(/* @__PURE__ */ new Date()).toISOString()} # total elapsed ${readableDuration(elapsed)}`);
     const checks = await fetchChecks(githubToken, trigger);
-    if ((0, import_core3.isDebug)()) {
-      (0, import_core3.debug)(JSON.stringify({ label: "rawdata", checks, elapsed }, null, 2));
-    }
     const report = generateReport(
       getSummaries(checks, trigger),
       trigger,
@@ -32613,9 +32609,7 @@ async function run() {
         `${workflowBasename}(${colorize(severity, jobName)}): [eventName: ${eventName}][runStatus: ${runStatus}][runConclusion: ${runConclusion ?? nullStr}][runURL: ${checkRunUrl}]`
       );
     }
-    if ((0, import_core3.isDebug)()) {
-      (0, import_core3.debug)(JSON.stringify({ label: "filtered", report }, null, 2));
-    }
+    dumper.results.push({ elapsed, checks, report });
     const { ok, done, logs } = report;
     for (const { severity, message, resource } of logs) {
       (0, import_core3.info)(colorize(severity, message));
@@ -32645,6 +32639,9 @@ async function run() {
       break;
     }
   }
+  if ((0, import_core3.isDebug)()) {
+    (0, import_core3.setOutput)("dump", JSON.stringify(dumper, null, 2));
+  }
 }
 void run();
 /*! Bundled license information:

snapshots/README.md

@@ -0,0 +1,4 @@
+# How to get snapshot of resources
+
+Since v3.4.0, we can use GITHUB_OUTPUT only in debug mode\
+See the section in [README](../README.md#jobsjob_idoutputs)

src/input.ts

@@ -1,9 +1,10 @@
-import { debug, getInput, getBooleanInput, setSecret, isDebug, error } from '@actions/core';
+import { getInput, getBooleanInput, setSecret, error } from '@actions/core';
+import { WebhookPayload } from '@actions/github/lib/interfaces.ts';
 import { context } from '@actions/github';
 
 import { Durationable, Options, Trigger } from './schema.ts';
 
-export function parseInput(): { trigger: Trigger; options: Options; githubToken: string } {
+export function parseInput(): { trigger: Trigger; options: Options; githubToken: string; payload: WebhookPayload } {
   const {
     repo,
     payload,
@@ -19,10 +20,6 @@ export function parseInput(): { trigger: Trigger; options: Options; githubToken:
     if (typeof prSha === 'string') {
       commitSha = prSha;
     } else {
-      if (isDebug()) {
-        // Do not print secret even for debug code
-        debug(JSON.stringify({ label: 'PullRequestContext', pr }, null, 2));
-      }
       error('github context has unexpected format: missing context.payload.pull_request.head.sha');
     }
   }
@@ -62,5 +59,5 @@ export function parseInput(): { trigger: Trigger; options: Options; githubToken:
   const githubToken = getInput('github-token', { required: true, trimWhitespace: false });
   setSecret(githubToken);
 
-  return { trigger, options, githubToken };
+  return { trigger, options, githubToken, payload };
 }

src/main.ts

@@ -1,4 +1,4 @@
-import { debug, info, setFailed, isDebug, startGroup, endGroup } from '@actions/core';
+import { info, setFailed, isDebug, startGroup, endGroup, setOutput } from '@actions/core';
 import styles from 'ansi-styles';
 
 function colorize(severity: Severity, message: string): string {
@@ -24,15 +24,31 @@ function colorize(severity: Severity, message: string): string {
 
 import { parseInput } from './input.ts';
 import { fetchChecks } from './github-api.ts';
-import { Severity, generateReport, getSummaries, readableDuration } from './report.ts';
+import { Report, Severity, generateReport, getSummaries, readableDuration } from './report.ts';
 import { getInterval, wait } from './wait.ts';
 import { Temporal } from 'temporal-polyfill';
+import { Check, Options, Trigger } from './schema.ts';
+import { WebhookPayload } from '@actions/github/lib/interfaces.ts';
+
+interface Attempt {
+  elapsed: Temporal.Duration;
+  checks: Check[];
+  report: Report;
+}
+
+interface Dumper {
+  trigger: Trigger;
+  options: Options;
+  payload: WebhookPayload;
+  results: Attempt[];
+}
 
 async function run(): Promise<void> {
   const startedAt = performance.now();
   startGroup('Parameters');
-  const { trigger, options, githubToken } = parseInput();
+  const { trigger, options, githubToken, payload } = parseInput();
   info(JSON.stringify(
+    // Do NOT include payload
     {
       trigger,
       startedAt,
@@ -50,6 +66,9 @@ async function run(): Promise<void> {
     return;
   }
 
+  // Do not include secret even in debug mode
+  const dumper: Dumper = { trigger, options, payload, results: [] };
+
   for (;;) {
     attempts += 1;
     if (attempts > options.attemptLimits) {
@@ -70,9 +89,7 @@ async function run(): Promise<void> {
     const elapsed = Temporal.Duration.from({ milliseconds: Math.ceil(performance.now() - startedAt) });
     startGroup(`Polling ${attempts}: ${(new Date()).toISOString()} # total elapsed ${readableDuration(elapsed)}`);
     const checks = await fetchChecks(githubToken, trigger);
-    if (isDebug()) {
-      debug(JSON.stringify({ label: 'rawdata', checks, elapsed }, null, 2));
-    }
+
     const report = generateReport(
       getSummaries(checks, trigger),
       trigger,
@@ -101,9 +118,7 @@ async function run(): Promise<void> {
       );
     }
 
-    if (isDebug()) {
-      debug(JSON.stringify({ label: 'filtered', report }, null, 2));
-    }
+    dumper.results.push({ elapsed, checks, report });
 
     const { ok, done, logs } = report;
 
@@ -139,6 +154,10 @@ async function run(): Promise<void> {
       break;
     }
   }
+
+  if (isDebug()) {
+    setOutput('dump', JSON.stringify(dumper, null, 2));
+  }
 }
 
 void run();