Skip to content

Commit 0c95503

Browse files
committed
Set branding icon
Signed-off-by: An Cao <kcj.pop.com@gmail.com>
1 parent c248ee1 commit 0c95503

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,23 +36,25 @@ jobs:
3636
+ # This needs to be run after a test job so coverage file will be available.
3737
+ - uses: kcjpop/coverage-comments@v2
3838
+ with:
39+
+ github-token: ${{ secrets.GITHUB_TOKEN }}
3940
+ coverage-file: './coverage/clover.xml'
4041
```
4142

4243
## Configurations
4344

4445
| Parameter | Description | Mandatory | Default value |
4546
| --------------------- | ------------------------------------------------------------------------- | --------- | --------------------- |
47+
| `github-token` | | Yes | `${{ github.token }}` |
4648
| `coverage-file` | Path to `lcov.info` or `clover.xml` file | Yes | |
4749
| `working-directory` | Set working directory if project is not in root folder | No | `'./'` |
4850
| `delete-old-comments` | Keep only one coverage comment, to avoid spamming a PR with outdated info | No | `true` |
49-
| `github-token` | | No | `${{ github.token }}` |
5051

5152
### Example: `lcov.info` is in a different folder
5253

5354
```yaml
5455
- uses: kcjpop/coverage-comments@v2
5556
with:
57+
github-token: ${{ secrets.GITHUB_TOKEN }}
5658
coverage-file: 'front/coverage/lcov.info'
5759
```
5860

action.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
name: 'Code coverage comments'
2-
description: 'Comment code coverage from lcov.info file in commits or PRs'
2+
description: 'Comment code coverage from `lcov.info` or `clover.xml` file in commits or PRs'
3+
branding:
4+
icon: message-square
5+
color: yellow
36
inputs:
47
github-token:
58
description: Github token
@@ -9,6 +12,10 @@ inputs:
912
description: 'Path to `lcov.info` or `clover.xml` file. It has to include the filename so we can determine how to parse the coverage result.'
1013
required: true
1114
default: './coverage/clover.xml'
15+
working-directory:
16+
description: Set working directory if project is not in root folder
17+
required: false
18+
default: './'
1219
delete-old-comments:
1320
description: 'Set to `true` to delete old coverage comments.'
1421
required: false

0 commit comments

Comments
 (0)