@action-badges/core
v0.3.1
Published
Create SVG badges with GitHub actions
Downloads
182
Readme
action-badges/core
Serverless badge generation with Github Actions
Action badges allows you to create custom badges using github actions and host them in your own github repo.
Unlike centralized services like shields.io and badgen.net, action badges can be used to:
- Generate badges using content in private repositories without hosting and maintaining your own instance of shields or badgen
- Make badges that need private tokens or secrets to generate the content
- Make badges that are slow to compute or rely on data that is not available from a HTTP API
- Generate badges without contacting any external services: compute is handled by github actions, badges are stored in github repo
There are two ways to use action-badges/core. It can be used directly as a Github Action in yaml workflows/composite actions or as an NPM library to create re-usable javascript actions.
https://github.com/action-badges/examples contains some examples showing how to generate action badges using a number of different methods.