sidx1024/Report NYC coverage

GitHub Action that posts the report in a comment on a GitHub Pull Request from coverage data generated by nyc (istanbul).

View on GitHub

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stale
License: None
Runtime: Deprecated runtime

Inputs

name	description	required	default
coverage_file	Path to coverage file generated by "nyc report".	yes	coverage-summary.json
base_coverage_file	Path to coverage file generated by "nyc report" for the base branch (for comparison)	yes	.base_nyc_output/coverage-summary.json
comment_template_file	Template file to be used for GitHub PR comment. Markdown and Svelte are supported.	no	comment-template.md
comment_mode	"replace" or "new"	no	replace
github_token	An alternative GitHub token, other than the default provided by GitHub Actions runner. Optional.	no	${{ github.token }}
sources_base_path	Absolute path to the source files. The path will be trimmed from the coverage data. Optional. Default is the github workspace directory with a trailing slash.	no	${{ format('{0}/', github.workspace) }}
files_coverage_table_output_type_order	Specify the order for coverage types to be included in the output table. (S: statements, B: branches, F: functions, L: lines). Missing types will be excluded.	no	SBFL

Outputs

name	description
total_lines_coverage_percent	Total lines coverage percent (XX.XX%) with level indicator
total_branches_coverage_percent	Total branches coverage percent (XX.XX%) with level indicator
total_statements_coverage_percent	Total statements coverage percent (XX.XX%) with level indicator
total_functions_coverage_percent	Total functions coverage percent (XX.XX%) with level indicator
total_lines_coverage_percent_raw	Total lines coverage percent (XX.XX) without percent and level indicator
total_branches_coverage_percent_raw	Total branches coverage percent (XX.XX) without percent and level indicator
total_statements_coverage_percent_raw	Total statements coverage percent (XX.XX) without percent and level indicator
total_functions_coverage_percent_raw	Total functions coverage percent (XX.XX) without percent and level indicator
base_total_lines_coverage_percent	Base total lines coverage percent (XX.XX%) with level indicator
base_total_branches_coverage_percent	Base total branches coverage percent (XX.XX%) with level indicator
base_total_statements_coverage_percent	Base total statements coverage percent (XX.XX%) with level indicator
base_total_functions_coverage_percent	Base total functions coverage percent (XX.XX%) with level indicator
total_lines_coverage_percent_diff	Total lines coverage percent diff (+XX.XX%)
total_statements_coverage_percent_diff	Total branches coverage percent diff (+XX.XX%)
total_functions_coverage_percent_diff	Total statements coverage percent diff (+XX.XX%)
total_branches_coverage_percent_diff	Total functions coverage percent diff (+XX.XX%)
total_lines_coverage_percent_diff_raw	Total lines coverage percent diff (-XX.XX) without percent sign
total_statements_coverage_percent_diff_raw	Total branches coverage percent diff (-XX.XX) without percent sign
total_functions_coverage_percent_diff_raw	Total statements coverage percent diff (-XX.XX) without percent sign
total_branches_coverage_percent_diff_raw	Total functions coverage percent diff (-XX.XX) without percent sign
files_coverage_table	HTML table content containing the file path and corresponding coverage percent for all files
changed_files_coverage_table	HTML table content containing the file path and corresponding coverage percent for files changed in the PR
comment_body	The comment body in HTML format
commit_sha	Last commit SHA (commit due to which this action was executed)
short_commit_sha	Last commit SHA in shorter format (6ef01b)
commit_link	Relative link for the last commit
base_commit_sha	Base commit SHA
base_short_commit_sha	Base commit SHA in shorter format (bca317)
base_commit_link	Relative link for the base commit
base_ref	Base branch name