mattboll / dashlord-actions

GitHub actions for DashLord

dashlord-actions

Basic GitHub actions used in dashlord workflows.

Actions

Action	Usage
init	read dashloard.yml
save	save a single url scan result for dashlord
report	build a report.json and website from latest scans
lhci	LightHouse collector action
declaration-a11y	verif mention accessibilité
declaration-rgpd	check mentions légales, CGU, et confidentialité
get-html	get raw HTML of any webpage
ecoindex	Compute webpage ecoscore with green-it
sonarcloud	Extract quality metrics from sonarcloud API
trivy	Run trivy docker images scanner

And many more !

How it works

DashLord use GitHub Actions to collect data from different tools and store the results in GIT.

Once all URLs have been scanned, the report action generates a report.json and a web report which are commited to GIT.

Usage

See dashlord template repo

Development

Start website

cd report/www
yarn
yarn start

Build a new report

This will add report.json, config.json, trends.json in report/www/src based on the content of DASHLORD_REPO_PATH :

DASHLORD_URLS=http://test1.com,http://test1.com  \ # optional
DASHLORD_REPO_PATH=/path/to/some/dashlord-repo \ #optional
node report/src # this will create fresh config.json, report.json and trends.json for the website

See also the report README

Add a new dashlord action

1. create a GitHub action that can produce some JSON in your scans/myaction.json
2. In report/src/generateUrlReport, import the minimum from your action JSON to serve it to the frontend via the generated report.json
3. In report/src/summary, add compute logic for your scanner score.
4. Build a new report.json, see above
5. Run yarn start in the report/www folder to start adding types from your action and UI for your component