Make Job Summary Reporting Configurable in Harden Runner

[pputman-clabs]

In a workflow with two jobs, both with harden runner activated, one of them prints a summary to the github actions workflow summary, and the other does not. It is because of this environment variable, but not sure how or where this is set. This is set for the first job in the logs, and not the second job.

could you add an input into the github action to set this, or document how this is determined? Both instances the action is called with the same options so not sure what the difference is.

[pputman-clabs]

The variable I'm referring to is STATE_addSummary

[varunsh-coder]

Thank you @pputman-clabs for reaching out!

The behavior you're seeing is intentional. To keep the GitHub Actions workflow summary uncluttered, Harden-Runner prints the summary for only one job — the first job where the action runs. This prevents multiple entries from being added to the summary when Harden-Runner is used in several jobs.

While the workflow summary shows a preview with key details from one job, you can view complete insights for all jobs by clicking the provided link to the detailed insights page.

Technical details

This first job of a workflow gets a true response for this attribute

harden-runner/src/setup.ts

Line 191 in 0080882

`${api_url}/github/${process.env["GITHUB_REPOSITORY"]}/actions/runs/${process.env["GITHUB_RUN_ID"]}/monitor`,

harden-runner/src/setup.ts

Line 208 in 0080882

addSummary = responseData.monitoring_started ? "true" : "false";

harden-runner/src/setup.ts

Line 215 in 0080882

`addSummary=${addSummary}${EOL}`,

and if the variable is true, the markdown is rendered for that job

harden-runner/src/cleanup.ts

Line 93 in 0080882

await common.addSummary();

harden-runner/src/common.ts

Line 57 in 0080882

export async function addSummary() {

[pputman12]

Thanks for the comment. It would be nice to have this configurable. In my case, the first job is just go-tests, which isn't the main concern, then a docker build and deploy which I'd much rather have a report of, however since all jobs will have it in the insights this isn't really a huge concern, just a "nice to have" if possible.