Skip to content

jaywcjlove/generated-badges

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

85 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Using my app is also a way to support me:
Scap: Screenshot & Markup Edit Screen Test Deskmark Keyzer Vidwall Hub VidCrop Vidwall Mousio Hint Mousio Musicer Audioer FileSentinel FocusCursor Videoer KeyClicker DayBar Iconed Menuist Quick RSS Quick RSS Web Serve Copybook Generator DevTutor for SwiftUI RegexMate Time Passage Iconize Folder Textsound Saver Create Custom Symbols DevHub Resume Revise Palette Genius Symbol Scribe

Generated Badges

Buy me a coffee Follow On X Build & Deploy npm version

Create a badge using GitHub Actions and GitHub Workflow CPU time (no 3rd parties servers)

Install

$ npm i generated-badges -g

Command Help

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    <Color RGB> or <Color Name> (default: '555')
  --style         Badges style: flat, classic.
  --status, -s    Override default status text.
  --scale         Set badge scale (default: 1).
  --color, -c     <Color RGB> or <Color Name> (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

- 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:

blue badges cyan badges green badges yellow badges red badges pink badges purple badges grey badges black badges gradient badges

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: <svg xmlns.....

Related

Contributors

As always, thanks to our amazing contributors!

Made with github-action-contributors.

License

Licensed under the MIT License.

About

Create a badge using GitHub Actions and GitHub Workflow CPU time (no 3rd parties servers)

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Contributors