https://github.com/jaywcjlove/generated-badges
Create a badge using GitHub Actions and GitHub Workflow CPU time (no 3rd parties servers)
https://github.com/jaywcjlove/generated-badges
badges generator github-actions nodejs
Last synced: 2 months ago
JSON representation
Create a badge using GitHub Actions and GitHub Workflow CPU time (no 3rd parties servers)
- Host: GitHub
- URL: https://github.com/jaywcjlove/generated-badges
- Owner: jaywcjlove
- License: mit
- Created: 2022-02-21T02:07:21.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-15T19:23:52.000Z (6 months ago)
- Last Synced: 2025-04-30T14:23:48.306Z (3 months ago)
- Topics: badges, generator, github-actions, nodejs
- Language: JavaScript
- Homepage: https://jaywcjlove.github.io/generated-badges
- Size: 608 KB
- Stars: 19
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Generated Badges
===
[](https://jaywcjlove.github.io/#/sponsor)
[](https://github.com/jaywcjlove/generated-badges/actions/workflows/ci.yml)
[](https://www.npmjs.com/package/generated-badges)
Create a badge using GitHub Actions and GitHub Workflow CPU time (no 3rd parties servers)
## Install
```shell
$ npm i generated-badges -g
```
## Command Help
```bash
Usage: generated-badges [options] [--help|h]
Options:
--version, -v Show version number.
--help, -h Displays help information.
--output, -o Output svg image path.
--label, -l The left label of the badge, usually static.
--labelColor or (default: '555')
--style Badges style: flat, classic.
--status, -s Override default status text.
--scale Set badge scale (default: 1).
--color, -c or (default: 'blue').'
--gradient, -g Adding a gradient to a badge.'
Example:
generated-badges --output coverage/badges.svg
generated-badges --style classic
generated-badges --color red
generated-badges --gradient c05cff --gradient fa5b37
```
## Github Actions
```yml
- run: mkdir -p build
- name: Generate Badges
uses: jaywcjlove/generated-badges@main
with:
label: color
status: cyan
output: build/cyan.svg
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: xxxxxxx
publish_dir: ./build
```
Available color names:
### Input Parameters
- `label` - The left label of the badge, usually static. (default `:label`)
- `status` - The right status as the badge, usually based on results. (default `:status`)
- `style` - Badges style: `flat`, `classic`. (default `classic`)
- `color` - An array (comma separated) with hex or named colors of the badge value background. (default `blue`)
- `labelColor` - Hex or named color for the label. (default `555`)
- `output` - Output image path. (default `BADGES.svg`)
- `scale` - Set badge scale. (default `1`)
- `gradient` - Adding a gradient to a badge. (example `c05cff,fa5b37`)
### Output Parameters
- `svg` svg image string: `
Made with [github-action-contributors](https://github.com/jaywcjlove/github-action-contributors).
## License
Licensed under the MIT License.