-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
54 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,4 +14,4 @@ | |
| "repo": "report-nyc-coverage-github-action", | ||
| "title_prefix": "GitHub Action: ", | ||
| "pretty": "true" | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -47,99 +47,99 @@ jobs: | |
| uses: sidx1024/[email protected] | ||
| with: | ||
| # Path to coverage file generated by "nyc report". | ||
| coverage_file: 'nyc-coverage-report/coverage-summary.json' | ||
| coverage_file: "nyc-coverage-report/coverage-summary.json" | ||
| ``` | ||
| ## Usage | ||
| <!-- start usage --> | ||
| ```yaml | ||
| - uses: sidx1024/report-nyc-coverage-github-action@v1.2.6 | ||
| - uses: sidx1024/report-nyc-coverage-github-action@v1.0.0 | ||
| with: | ||
| # Path to coverage file generated by "nyc report". | ||
| # Default: coverage-summary.json | ||
| coverage_file: '' | ||
| coverage_file: "" | ||
|
|
||
| # Path to coverage file generated by "nyc report" for the base branch (for | ||
| # comparison) | ||
| # Default: .base_nyc_output/coverage-summary.json | ||
| base_coverage_file: '' | ||
| base_coverage_file: "" | ||
|
|
||
| # Template file to be used for GitHub PR comment. Markdown and Svelte are | ||
| # supported. | ||
| # Default: comment-template.md | ||
| comment_template_file: '' | ||
| comment_template_file: "" | ||
|
|
||
| # "replace" or "new" | ||
| # Default: replace | ||
| comment_mode: '' | ||
| comment_mode: "" | ||
|
|
||
| # An alternative GitHub token, other than the default provided by GitHub Actions | ||
| # runner. Optional. | ||
| # Default: ${{ github.token }} | ||
| github_token: '' | ||
| github_token: "" | ||
|
|
||
| # 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. | ||
| # Default: ${{ format('{0}/', github.workspace) }} | ||
| sources_base_path: '' | ||
| sources_base_path: "" | ||
|
|
||
| # 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. | ||
| # Default: SBFL | ||
| files_coverage_table_output_type_order: '' | ||
| files_coverage_table_output_type_order: "" | ||
| ``` | ||
| <!-- end usage --> | ||
| <!-- start inputs --> | ||
| | **Input** | **Description** | **Default** | **Required** | | ||
| | :------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------: | :----------: | | ||
| | **`coverage_file`** | Path to coverage file generated by "nyc report". | `coverage-summary.json` | **true** | | ||
| | **`base_coverage_file`** | Path to coverage file generated by "nyc report" for the base branch (for comparison) | `.base_nyc_output/coverage-summary.json` | **true** | | ||
| | **`comment_template_file`** | Template file to be used for GitHub PR comment. Markdown and Svelte are supported. | `comment-template.md` | **false** | | ||
| | **`comment_mode`** | "replace" or "new" | `replace` | **false** | | ||
| | **`github_token`** | An alternative GitHub token, other than the default provided by GitHub Actions runner. Optional. | `${{ github.token }}` | **false** | | ||
| | **`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. | `${{ format('{0}/', github.workspace) }}` | **false** | | ||
| | **`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. | `SBFL` | **false** | | ||
| | **Input** | **Description** | **Default** | **Required** | | ||
| | -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | ------------ | | ||
| | **`coverage_file`** | Path to coverage file generated by "nyc report". | `coverage-summary.json` | **true** | | ||
| | **`base_coverage_file`** | Path to coverage file generated by "nyc report" for the base branch (for comparison) | `.base_nyc_output/coverage-summary.json` | **true** | | ||
| | **`comment_template_file`** | Template file to be used for GitHub PR comment. Markdown and Svelte are supported. | `comment-template.md` | **false** | | ||
| | **`comment_mode`** | "replace" or "new" | `replace` | **false** | | ||
| | **`github_token`** | An alternative GitHub token, other than the default provided by GitHub Actions runner. Optional. | `${{ github.token }}` | **false** | | ||
| | **`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. | `${{ format('{0}/', github.workspace) }}` | **false** | | ||
| | **`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. | `SBFL` | **false** | | ||
|
|
||
| <!-- end inputs --> | ||
| <!-- start outputs --> | ||
|
|
||
| | **Output** | **Description** | **Default** | **Required** | | ||
| | :------------------------------------------- | :--------------------------------------------------------------------------------------------------------- | ----------- | ------------ | | ||
| | `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 | | | | ||
| | \***\*Output\*\*** | \***\*Description\*\*** | \***\*Default\*\*** | \***\*Required\*\*** | | ||
| | -------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------- | -------------------- | | ||
| | `total_lines_coverage_percent` | Total lines coverage percent (XX.XX%) with level indicator | undefined | undefined | | ||
| | `total_branches_coverage_percent` | Total branches coverage percent (XX.XX%) with level indicator | undefined | undefined | | ||
| | `total_statements_coverage_percent` | Total statements coverage percent (XX.XX%) with level indicator | undefined | undefined | | ||
| | `total_functions_coverage_percent` | Total functions coverage percent (XX.XX%) with level indicator | undefined | undefined | | ||
| | `total_lines_coverage_percent_raw` | Total lines coverage percent (XX.XX) without percent and level indicator | undefined | undefined | | ||
| | `total_branches_coverage_percent_raw` | Total branches coverage percent (XX.XX) without percent and level indicator | undefined | undefined | | ||
| | `total_statements_coverage_percent_raw` | Total statements coverage percent (XX.XX) without percent and level indicator | undefined | undefined | | ||
| | `total_functions_coverage_percent_raw` | Total functions coverage percent (XX.XX) without percent and level indicator | undefined | undefined | | ||
| | `base_total_lines_coverage_percent` | Base total lines coverage percent (XX.XX%) with level indicator | undefined | undefined | | ||
| | `base_total_branches_coverage_percent` | Base total branches coverage percent (XX.XX%) with level indicator | undefined | undefined | | ||
| | `base_total_statements_coverage_percent` | Base total statements coverage percent (XX.XX%) with level indicator | undefined | undefined | | ||
| | `base_total_functions_coverage_percent` | Base total functions coverage percent (XX.XX%) with level indicator | undefined | undefined | | ||
| | `total_lines_coverage_percent_diff` | Total lines coverage percent diff (+XX.XX%) | undefined | undefined | | ||
| | `total_statements_coverage_percent_diff` | Total branches coverage percent diff (+XX.XX%) | undefined | undefined | | ||
| | `total_functions_coverage_percent_diff` | Total statements coverage percent diff (+XX.XX%) | undefined | undefined | | ||
| | `total_branches_coverage_percent_diff` | Total functions coverage percent diff (+XX.XX%) | undefined | undefined | | ||
| | `total_lines_coverage_percent_diff_raw` | Total lines coverage percent diff (-XX.XX) without percent sign | undefined | undefined | | ||
| | `total_statements_coverage_percent_diff_raw` | Total branches coverage percent diff (-XX.XX) without percent sign | undefined | undefined | | ||
| | `total_functions_coverage_percent_diff_raw` | Total statements coverage percent diff (-XX.XX) without percent sign | undefined | undefined | | ||
| | `total_branches_coverage_percent_diff_raw` | Total functions coverage percent diff (-XX.XX) without percent sign | undefined | undefined | | ||
| | `files_coverage_table` | HTML table content containing the file path and corresponding coverage percent for all files | undefined | undefined | | ||
| | `changed_files_coverage_table` | HTML table content containing the file path and corresponding coverage percent for files changed in the PR | undefined | undefined | | ||
| | `comment_body` | The comment body in HTML format | undefined | undefined | | ||
| | `commit_sha` | Last commit SHA (commit due to which this action was executed) | undefined | undefined | | ||
| | `short_commit_sha` | Last commit SHA in shorter format (6ef01b) | undefined | undefined | | ||
| | `commit_link` | Relative link for the last commit | undefined | undefined | | ||
| | `base_commit_sha` | Base commit SHA | undefined | undefined | | ||
| | `base_short_commit_sha` | Base commit SHA in shorter format (bca317) | undefined | undefined | | ||
| | `base_commit_link` | Relative link for the base commit | undefined | undefined | | ||
| | `base_ref` | Base branch name | undefined | undefined | | ||
|
|
||
| <!-- end outputs --> | ||
| <!-- start [.github/ghdocs/examples/] --> | ||
|
|
||
Oops, something went wrong.