1.0.6 • Published 2 years ago
@gh-stats/reporter v1.0.6
gh-stats reporter package
free lightweight github actions analytics
Install
npm i @gh-stats/reporter
Usage
Node.js action
Add reportAction()
call to your action code.
const { reportAction } = require('@gh-stats/reporter');
reportAction();
Run action
Add reportAction()
call to your action yml.
bash <(curl -s https://gh-stats.app/actions/bash/v1)
you can always validate our script via SHA-512 sum that we are publishing at https://api.gh-stats.app/actions/bash/v1.sha512
How does it work?
This library simply reports usage of your workflow and stores it in database.
You can view your action stats at https://api.gh-stats.app/actions/{user}/{action-repository}.
Badge
After reporting, add a badge to your README.md
![example](https://shields.gh-stats.app/badge?action=allegro-actions/verify-monitoring)
You can use any shields.io api query parameters:
![example](https://shields.gh-stats.app/badge?action=allegro-actions/verify-monitoring&color=yellow&style=flat)