im-open/process-code-coverage-summary

GitHub Action that can create a status check or PR comment based on the provided results summary file.

View on GitHub

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Activelast commit Mar 27, 2026
License: MIT

Pinned Snippet

workflow.ymlSHA-pinned

uses: im-open/process-code-coverage-summary@e2984f897702d68619d358a834d80a74aa0d9840 # v2.3.1

tags can be moved; commit SHAs can't. why a SHA?

Inputs

name	description	required	default
github-token	Token used to interact with the repository. Generally `secrets.GITHUB_TOKEN.`	yes	—
summary-file	The summary file generated by the report-generator action.	yes	—
report-name	The desired name of the report that is shown on the PR Comment and inside the Status Check.	yes	Code Coverage Results
create-status-check	Flag indicating whether a status check with code coverage results should be generated.	yes	true
check-name	The desired name of the status check. Only applicable when `create-status-check` is true.	yes	code coverage
create-pr-comment	Flag indicating whether a PR comment with code coverage results should be generated. When `true` the default behavior is to update an existing comment if one exists.	yes	true
update-comment-if-one-exists	This flag determines whether a new comment is created or if the action updates an existing comment (if one is found). Only applicable when `create-pr-comment` is true.	yes	true
update-comment-key	A unique identifier which will be added to the generated markdown as a comment (it will not be visible in the PR comment). This identifier enables creating then updating separate results comments on the PR if more than one instance of this action is included in a single job. This can be helpful when there are multiple coverage projects that run separately but are part of the same job. Each instance of the action should have a different key and this value should be static so it remains the same each time the workflow is run. Defaults to GITHUB_JOB_GITHUB_ACTION if not provided. Only applicable when `create-pr-comment` and `update-comment-if-one-exists` are `true`.	no	—
ignore-threshold-failures	If the coverage falls below the threshold and this is set to `true` the status check's conclusion will be set to `neutral` and the `coverage-outcome` output will be set to `Passed`. This is useful if you want coverage reported but do not want a failing status check to block pull requests.	no	false
line-threshold	Minimum threshold for line coverage. The status check conclusion will be `failure `and `coverage-outcome` will be `Failed` if the actual coverage amount is less than this. Set to `0` to disable line coverage checks. When `0`, the status check will always be `neutral` and the `coverage-outcome` will be `Passed`.	no	0
branch-threshold	Minimum threshold for branch coverage. The status check conclusion will be `failure `and `coverage-outcome` will be `Failed` if the actual coverage amount is less than this. Set to 0 if you do not want thresholds to be applied.	no	0

Outputs

name	description
coverage-outcome	Coverage outcome based on Threshold comparisons: Failed\|Passed. If exceptions are thrown or if it exits early because of argument errors, this is set to Failed.
coverage-results-truncated	Flag indicating whether coverage results were truncated due to markdown exceeding character limit of 65535.
coverage-results-file-path	File path for the file that contains the coverage results in markdown format. This is the same output that is posted in the PR comment.
status-check-id	The ID of the Status Check that was created. This is only set if `create-status-check` is `true` and a status check was created successfully.
pr-comment-id	The ID of the PR comment that was created. This is only set if `create-pr-comment` is `true` and a PR was created successfully.