Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat—add icon support #24

Merged
merged 4 commits into from
Mar 7, 2023
Merged

Feat—add icon support #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
36b94db
Add support for coverage types
DisasterMan78 Mar 3, 2023
b8b7820
Update README
DisasterMan78 Mar 3, 2023
a8ba21b
Improve tests
DisasterMan78 Mar 6, 2023
b281a35
Feature - add SVG icon support
DisasterMan78 Mar 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ coverage-badges-cli

Create coverage badges from coverage reports. Using GitHub Actions and GitHub Workflow CPU time (no 3rd parties servers).

Don't worry about the [coverage.io](https://coveralls.io/) service is down.
Don't worry about the [coverage.io](https://coveralls.io/) service is down.

## Install

Expand Down Expand Up @@ -52,7 +52,9 @@ You can add `![Coverage](./coverage/badges.svg)` to your README.md after the bad
- `source` - The path of the target file "coverage-summary.json".
- `output` - Output image path.
- `label` - The left label of the badge, usually static (default `coverage`).
- `style` - Badges style: `flat`, `classic` (default `classic`).
- `style` - Badges style: `flat`, `classic` (default `classic`).
- `type` - Coverage report type: `lines`, `statements`, `functions`, `branches` (default `statements`)
- `icon` - Path to icon file

```yml
- name: Create Coverage Badges
Expand Down Expand Up @@ -117,12 +119,16 @@ Options:
--output, -o Output directory.
--source, -s The path of the target file "coverage-summary.json".
--style Badges style: flat, flat-square.
--type Coverage type: lines, statements, functions, branches.
--icon Path to icon file

Example:

npm coverage-badges-cli --output coverage/badges.svg
npm coverage-badges-cli --style plastic
npm coverage-badges-cli --source coverage/coverage-summary.json
npm coverage-badges-cli --type lines
npm coverage-badges-cli --icon my-icon.svg
```

## Development
Expand Down
Loading