https://github.com/cinderblock/github-action-standalone-stats
GitHub Action that publishes coverage, tests results, and other stats to gh-pages for self-contained pretty charts and badges
https://github.com/cinderblock/github-action-standalone-stats
Last synced: about 1 month ago
JSON representation
GitHub Action that publishes coverage, tests results, and other stats to gh-pages for self-contained pretty charts and badges
- Host: GitHub
- URL: https://github.com/cinderblock/github-action-standalone-stats
- Owner: cinderblock
- License: mit
- Created: 2020-01-04T23:44:14.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T04:52:36.000Z (over 3 years ago)
- Last Synced: 2024-03-14T16:44:16.625Z (over 2 years ago)
- Language: TypeScript
- Size: 2.56 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Normally, we're restricted to simple badges like this:
[](https://github.com/cinderblock/github-action-standalone-stats/actions?query=branch%3Amaster)
_(GitHub Action Badge)_
But with Standalone Stats...
[](https://cinderblock.github.io/github-action-standalone-stats)
## Standalone Stats
Standalone Stats is a tool that helps you generate pretty build reports for your GitHub Actions.
It supports a bunch of reporters, like:
- Test Reports:
- [jest-stare](https://cinderblock.github.io/github-action-standalone-stats/jest-stare)
- [jest-html-reporters](https://cinderblock.github.io/github-action-standalone-stats/jest-html-reporter.html)
- [allure](https://cinderblock.github.io/github-action-standalone-stats/allure-report)
- Coverage Report:
- [lcov](https://cinderblock.github.io/github-action-standalone-stats/coverage/lcov-report)
## How It Works
Inspired by tools like [coveralls.io](https://coveralls.io), this tool takes raw coverage report files (`lcov` format) and generates pretty graphs to show coverage over time.
However, instead of relying on a 3rd party service to generated and host these static reports, we generate them ourselves and use github-pages to host the various generated static html files.
It is critical, for generating reports, to have the raw historical data for each execution.
We use an extra branch on the repo (or, optionally, a separate repo) to store this historical data and use it to generate new reports on push.
We also use another extra branch to store the generated reports, which GitHub Pages will host.
Git has the code.
Git has the database.
Git has the publication.
## Usage
# ⚠️⚠️ WORK IN PROGRESS ⚠️⚠️
## Not yet ready for use
In your GitHub Actions, add a config like this:
```yml
jobs:
self-test-and-generate-stats:
runs-on: ubuntu-latest # Anything should work
steps:
- name: Checkout your code
uses: actions/checkout@v1
- name: Setup your code
run: npm install
- name: Run your tests that generate reports
id: tests
run: npm test
- name: Generate Standalone Stats
# Run even if tests failed
if: success() || steps.tests.result == 'failure'
id: generateStats
uses: cinderblock/github-action-standalone-stats@v1
# This step will copy coverage reports (and others) to the specified historical branch
# and use them all to generate some updated pretty charts
with:
stats-branch: build-stats
stats-repo: '' # Current
# Output directory for the generated reports
pages-dir: public/action-stats
# Publish to gh-pages
- name: Publish to gh-pages
# Run even if other steps failed, as long as generateStats succeeded
if: success() || steps.generateStats.result == 'success'
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: public
```
Add this to your README
```md
[](https://.github.io//action-stats)
```
## Development
Install the dependencies
```bash
npm install
```
Build the typescript (automatic with `npm install`)
```bash
npm run build
```
Run the tests :heavy_check_mark:
```bash
npm test
PASS ./main.js
✓ throws invalid number (3ms)
✓ wait 500 ms (504ms)
✓ test runs (95ms)
...
```