https://github.com/emibcn/badge-action
Create a badge using GitHub Actions and GitHub Workflow CPU time (no 3rd parties servers)
https://github.com/emibcn/badge-action
3rd-parties-servers action badge badge-action badge-generator badgen github-actions github-workflow-cpu hacktoberfest javascipt nodejs svg-badge
Last synced: about 1 year ago
JSON representation
Create a badge using GitHub Actions and GitHub Workflow CPU time (no 3rd parties servers)
- Host: GitHub
- URL: https://github.com/emibcn/badge-action
- Owner: emibcn
- License: gpl-3.0
- Created: 2020-09-06T14:14:37.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-20T12:24:30.000Z (over 2 years ago)
- Last Synced: 2025-04-25T20:02:42.895Z (about 1 year ago)
- Topics: 3rd-parties-servers, action, badge, badge-action, badge-generator, badgen, github-actions, github-workflow-cpu, hacktoberfest, javascipt, nodejs, svg-badge
- Language: Dockerfile
- Homepage: https://github.com/marketplace/actions/badge-action
- Size: 237 KB
- Stars: 84
- Watchers: 4
- Forks: 27
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://deepsource.io/gh/emibcn/badge-action/?ref=repository-badge)
# Badge action
This action generates a SVG badge using GitHub Actions and GitHub Workflow CPU time (no 3rd parties servers). The badge is generated using the NPM package [gradient-badge](https://github.com/bokub/gradient-badge) and [Github Badge Action](https://www.npmjs.com/package/github-badge-action) to read and write the GitHub Actions inputs and outputs.
## Inputs
### `label`
**Required** The left label of the badge, usually static.
### `label-color`
**Required** Hex or named color for the label. Default: `555`
### `status`
**Required** The right status as the badge, usually based on results.
### `color`
**Required** An array (comma separated) with hex or named colors of the badge value background. More than one creates gradient background. Default: `blue`.
### `style`
**Required** Badge style: flat or classic. Default: `classic`
### `icon`
Use icon.
### `icon-width`
Set this if icon is not square. Default: `13`
### `scale`
Set badge scale. Default: `1`
### `path`
The file path to store the badge image file. Only output to `badge` action output if not defined.
## Outputs
### `badge`
The badge SVG contents.
## Example usage
```
uses: emibcn/badge-action@v2.0.2
with:
label: 'Test coverage'
status: '53.4%'
color: 'blue,555,daf'
path: '.github/badges/coverage.svg'
```
### Commit the changes to dedicated branch
Create the dedicated branch `badges` with (extracted from [StackOverflow](https://stackoverflow.com/a/11487993/2928168)):
```
git checkout master
git checkout --orphan badges
# Unstage all the files in your working tree.
git rm --cached $(git ls-files)
# Create a dedicated README file, so it's clear what's going on here
echo '# Badges branch' > README.md
git add README.md
git commit -m 'Add dedicated README'
git push origin badges
```
And then, [follow the example](https://github.com/emibcn/badge-action/blob/master/.github/workflows/test.yml#L44).
### Commit the changes to same branch
See a [workflow example](https://github.com/emibcn/badge-action/blob/master/.github/workflows/test.yml#L60).
Or another [more complex example](https://github.com/emibcn/pywisp/blob/master/.github/workflows/test.yml#L178).
Note: You will need to pull auto-generated commits with this technique, or your repo will mess up.