Skip to content

Commit 8adfb1b

Browse files
sidx1024sidx1024
committed
Build for v1.2.7
1 parent dfb4449 commit 8adfb1b

5 files changed

Lines changed: 54 additions & 51 deletions

‎.ghadocs.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@
1414
"repo": "report-nyc-coverage-github-action",
1515
"title_prefix": "GitHub Action: ",
1616
"pretty": "true"
17-
}
17+
}

‎README.md‎

Lines changed: 50 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -47,99 +47,99 @@ jobs:
4747
uses: sidx1024/report-nyc-coverage-github-action@v1.2.6
4848
with:
4949
# Path to coverage file generated by "nyc report".
50-
coverage_file: 'nyc-coverage-report/coverage-summary.json'
50+
coverage_file: "nyc-coverage-report/coverage-summary.json"
5151
```
5252
5353
## Usage
5454
5555
<!-- start usage -->
5656
5757
```yaml
58-
- uses: sidx1024/report-nyc-coverage-github-action@v1.2.6
58+
- uses: sidx1024/report-nyc-coverage-github-action@v1.0.0
5959
with:
6060
# Path to coverage file generated by "nyc report".
6161
# Default: coverage-summary.json
62-
coverage_file: ''
62+
coverage_file: ""
6363

6464
# Path to coverage file generated by "nyc report" for the base branch (for
6565
# comparison)
6666
# Default: .base_nyc_output/coverage-summary.json
67-
base_coverage_file: ''
67+
base_coverage_file: ""
6868

6969
# Template file to be used for GitHub PR comment. Markdown and Svelte are
7070
# supported.
7171
# Default: comment-template.md
72-
comment_template_file: ''
72+
comment_template_file: ""
7373

7474
# "replace" or "new"
7575
# Default: replace
76-
comment_mode: ''
76+
comment_mode: ""
7777

7878
# An alternative GitHub token, other than the default provided by GitHub Actions
7979
# runner. Optional.
8080
# Default: ${{ github.token }}
81-
github_token: ''
81+
github_token: ""
8282

8383
# Absolute path to the source files. The path will be trimmed from the coverage
8484
# data. Optional. Default is the github workspace directory with a trailing slash.
8585
# Default: ${{ format('{0}/', github.workspace) }}
86-
sources_base_path: ''
86+
sources_base_path: ""
8787

8888
# Specify the order for coverage types to be included in the output table. (S:
8989
# statements, B: branches, F: functions, L: lines). Missing types will be
9090
# excluded.
9191
# Default: SBFL
92-
files_coverage_table_output_type_order: ''
92+
files_coverage_table_output_type_order: ""
9393
```
9494
9595
<!-- end usage -->
9696
<!-- start inputs -->
9797
98-
| **Input** | **Description** | **Default** | **Required** |
99-
| :------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------: | :----------: |
100-
| **`coverage_file`** | Path to coverage file generated by "nyc report". | `coverage-summary.json` | **true** |
101-
| **`base_coverage_file`** | Path to coverage file generated by "nyc report" for the base branch (for comparison) | `.base_nyc_output/coverage-summary.json` | **true** |
102-
| **`comment_template_file`** | Template file to be used for GitHub PR comment. Markdown and Svelte are supported. | `comment-template.md` | **false** |
103-
| **`comment_mode`** | "replace" or "new" | `replace` | **false** |
104-
| **`github_token`** | An alternative GitHub token, other than the default provided by GitHub Actions runner. Optional. | `${{ github.token }}` | **false** |
105-
| **`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** |
106-
| **`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** |
98+
| **Input** | **Description** | **Default** | **Required** |
99+
| -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | ------------ |
100+
| **`coverage_file`** | Path to coverage file generated by "nyc report". | `coverage-summary.json` | **true** |
101+
| **`base_coverage_file`** | Path to coverage file generated by "nyc report" for the base branch (for comparison) | `.base_nyc_output/coverage-summary.json` | **true** |
102+
| **`comment_template_file`** | Template file to be used for GitHub PR comment. Markdown and Svelte are supported. | `comment-template.md` | **false** |
103+
| **`comment_mode`** | "replace" or "new" | `replace` | **false** |
104+
| **`github_token`** | An alternative GitHub token, other than the default provided by GitHub Actions runner. Optional. | `${{ github.token }}` | **false** |
105+
| **`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** |
106+
| **`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** |
107107

108108
<!-- end inputs -->
109109
<!-- start outputs -->
110110

111-
| **Output** | **Description** | **Default** | **Required** |
112-
| :------------------------------------------- | :--------------------------------------------------------------------------------------------------------- | ----------- | ------------ |
113-
| `total_lines_coverage_percent` | Total lines coverage percent (XX.XX%) with level indicator | | |
114-
| `total_branches_coverage_percent` | Total branches coverage percent (XX.XX%) with level indicator | | |
115-
| `total_statements_coverage_percent` | Total statements coverage percent (XX.XX%) with level indicator | | |
116-
| `total_functions_coverage_percent` | Total functions coverage percent (XX.XX%) with level indicator | | |
117-
| `total_lines_coverage_percent_raw` | Total lines coverage percent (XX.XX) without percent and level indicator | | |
118-
| `total_branches_coverage_percent_raw` | Total branches coverage percent (XX.XX) without percent and level indicator | | |
119-
| `total_statements_coverage_percent_raw` | Total statements coverage percent (XX.XX) without percent and level indicator | | |
120-
| `total_functions_coverage_percent_raw` | Total functions coverage percent (XX.XX) without percent and level indicator | | |
121-
| `base_total_lines_coverage_percent` | Base total lines coverage percent (XX.XX%) with level indicator | | |
122-
| `base_total_branches_coverage_percent` | Base total branches coverage percent (XX.XX%) with level indicator | | |
123-
| `base_total_statements_coverage_percent` | Base total statements coverage percent (XX.XX%) with level indicator | | |
124-
| `base_total_functions_coverage_percent` | Base total functions coverage percent (XX.XX%) with level indicator | | |
125-
| `total_lines_coverage_percent_diff` | Total lines coverage percent diff (+XX.XX%) | | |
126-
| `total_statements_coverage_percent_diff` | Total branches coverage percent diff (+XX.XX%) | | |
127-
| `total_functions_coverage_percent_diff` | Total statements coverage percent diff (+XX.XX%) | | |
128-
| `total_branches_coverage_percent_diff` | Total functions coverage percent diff (+XX.XX%) | | |
129-
| `total_lines_coverage_percent_diff_raw` | Total lines coverage percent diff (-XX.XX) without percent sign | | |
130-
| `total_statements_coverage_percent_diff_raw` | Total branches coverage percent diff (-XX.XX) without percent sign | | |
131-
| `total_functions_coverage_percent_diff_raw` | Total statements coverage percent diff (-XX.XX) without percent sign | | |
132-
| `total_branches_coverage_percent_diff_raw` | Total functions coverage percent diff (-XX.XX) without percent sign | | |
133-
| `files_coverage_table` | HTML table content containing the file path and corresponding coverage percent for all files | | |
134-
| `changed_files_coverage_table` | HTML table content containing the file path and corresponding coverage percent for files changed in the PR | | |
135-
| `comment_body` | The comment body in HTML format | | |
136-
| `commit_sha` | Last commit SHA (commit due to which this action was executed) | | |
137-
| `short_commit_sha` | Last commit SHA in shorter format (6ef01b) | | |
138-
| `commit_link` | Relative link for the last commit | | |
139-
| `base_commit_sha` | Base commit SHA | | |
140-
| `base_short_commit_sha` | Base commit SHA in shorter format (bca317) | | |
141-
| `base_commit_link` | Relative link for the base commit | | |
142-
| `base_ref` | Base branch name | | |
111+
| \***\*Output\*\*** | \***\*Description\*\*** | \***\*Default\*\*** | \***\*Required\*\*** |
112+
| -------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------- | -------------------- |
113+
| `total_lines_coverage_percent` | Total lines coverage percent (XX.XX%) with level indicator | undefined | undefined |
114+
| `total_branches_coverage_percent` | Total branches coverage percent (XX.XX%) with level indicator | undefined | undefined |
115+
| `total_statements_coverage_percent` | Total statements coverage percent (XX.XX%) with level indicator | undefined | undefined |
116+
| `total_functions_coverage_percent` | Total functions coverage percent (XX.XX%) with level indicator | undefined | undefined |
117+
| `total_lines_coverage_percent_raw` | Total lines coverage percent (XX.XX) without percent and level indicator | undefined | undefined |
118+
| `total_branches_coverage_percent_raw` | Total branches coverage percent (XX.XX) without percent and level indicator | undefined | undefined |
119+
| `total_statements_coverage_percent_raw` | Total statements coverage percent (XX.XX) without percent and level indicator | undefined | undefined |
120+
| `total_functions_coverage_percent_raw` | Total functions coverage percent (XX.XX) without percent and level indicator | undefined | undefined |
121+
| `base_total_lines_coverage_percent` | Base total lines coverage percent (XX.XX%) with level indicator | undefined | undefined |
122+
| `base_total_branches_coverage_percent` | Base total branches coverage percent (XX.XX%) with level indicator | undefined | undefined |
123+
| `base_total_statements_coverage_percent` | Base total statements coverage percent (XX.XX%) with level indicator | undefined | undefined |
124+
| `base_total_functions_coverage_percent` | Base total functions coverage percent (XX.XX%) with level indicator | undefined | undefined |
125+
| `total_lines_coverage_percent_diff` | Total lines coverage percent diff (+XX.XX%) | undefined | undefined |
126+
| `total_statements_coverage_percent_diff` | Total branches coverage percent diff (+XX.XX%) | undefined | undefined |
127+
| `total_functions_coverage_percent_diff` | Total statements coverage percent diff (+XX.XX%) | undefined | undefined |
128+
| `total_branches_coverage_percent_diff` | Total functions coverage percent diff (+XX.XX%) | undefined | undefined |
129+
| `total_lines_coverage_percent_diff_raw` | Total lines coverage percent diff (-XX.XX) without percent sign | undefined | undefined |
130+
| `total_statements_coverage_percent_diff_raw` | Total branches coverage percent diff (-XX.XX) without percent sign | undefined | undefined |
131+
| `total_functions_coverage_percent_diff_raw` | Total statements coverage percent diff (-XX.XX) without percent sign | undefined | undefined |
132+
| `total_branches_coverage_percent_diff_raw` | Total functions coverage percent diff (-XX.XX) without percent sign | undefined | undefined |
133+
| `files_coverage_table` | HTML table content containing the file path and corresponding coverage percent for all files | undefined | undefined |
134+
| `changed_files_coverage_table` | HTML table content containing the file path and corresponding coverage percent for files changed in the PR | undefined | undefined |
135+
| `comment_body` | The comment body in HTML format | undefined | undefined |
136+
| `commit_sha` | Last commit SHA (commit due to which this action was executed) | undefined | undefined |
137+
| `short_commit_sha` | Last commit SHA in shorter format (6ef01b) | undefined | undefined |
138+
| `commit_link` | Relative link for the last commit | undefined | undefined |
139+
| `base_commit_sha` | Base commit SHA | undefined | undefined |
140+
| `base_short_commit_sha` | Base commit SHA in shorter format (bca317) | undefined | undefined |
141+
| `base_commit_link` | Relative link for the base commit | undefined | undefined |
142+
| `base_ref` | Base branch name | undefined | undefined |
143143

144144
<!-- end outputs -->
145145
<!-- start [.github/ghdocs/examples/] -->

0 commit comments

Comments
 (0)