Robert Kaussow
3578414c30
All checks were successful
continuous-integration/drone/push Build is passing
92 lines
2.7 KiB
Markdown
92 lines
2.7 KiB
Markdown
# [lhci](https://gitea.rknet.org/docker/lhci)
|
|
|
|
[](https://drone.rknet.org/docker/lhci)
|
|
[](https://hub.docker.com/r/xoxys/lhci)
|
|
[](https://gitea.rknet.org/docker/lhci/src/branch/master/LICENSE)
|
|
|
|
Simple wrapper for [lighthouse-ci](https://github.com/GoogleChrome/lighthouse-ci).
|
|
|
|
## Usage
|
|
|
|
There are two wrapper scripts around the lhci command you could use:
|
|
|
|
- `/usr/bin/lhci-official`: This will simply forward your command to the official binary at `/usr/local/bin/lhci`
|
|
- `/usr/bin/lhci`: This is a modified wrapper to post-process the created report file to prepare an upload.
|
|
|
|
The wrapper `/usr/bin/lhci` will do the following:
|
|
|
|
- create `DIST=$LHCI_BASE_DIR/$UPLOAD_OUTPUT_DIR/dist/`
|
|
- find all files flagged with `isRepresentativeRun` in the `manifest.json`
|
|
- copy those files to `$DIST`
|
|
|
|
To get it working you need to configure the `fileupload` in `.lighthouserc.yml`command line configuration will not work:
|
|
|
|
```Yaml
|
|
---
|
|
ci:
|
|
[...]
|
|
upload:
|
|
target: filesystem
|
|
# has to be a relative path to the .lighthouserc.yml location
|
|
outputDir: lhci_reports
|
|
```
|
|
|
|
What you will get is the following file structure which could be used as an upload source:
|
|
|
|
```Shell
|
|
lhci_reports/dist/
|
|
├── 9cf658e2-202007160745.html
|
|
├── f33fa4c4-202007160745.html
|
|
└── ffae8d3e-202007160745.html
|
|
|
|
# <FILENAME_HASH>-<DATETIME>.html
|
|
```
|
|
|
|
You will also get the target URLs in your CI output:
|
|
|
|
```Shell
|
|
/usr/bin/lhci autorun
|
|
|
|
[...]
|
|
|
|
All results processed!
|
|
|
|
Dumping 6 reports to disk at /drone/src/lhci_reports...
|
|
Done writing reports to disk.
|
|
|
|
Done running autorun.
|
|
|
|
Post-process report files...
|
|
Report for http://localhost:43901/ will be uploaded to https://example.com/9cf658e2-202007160745.html
|
|
Report for http://localhost:43901/404.html will be uploaded to https://example.com/ffae8d3e-202007160745.html
|
|
Report for http://localhost:43901/posts/ will be uploaded to https://example.com/f33fa4c4-202007160745.html
|
|
```
|
|
|
|
```Shell
|
|
docker run -v $(pwd)/public:/drone/src lhci autorun
|
|
|
|
# or pass arguments to lhci
|
|
docker run -v $(pwd)/public:/drone/src lhci autorun --upload.target=temporary-public-storage
|
|
```
|
|
|
|
## Environment variables
|
|
|
|
```Shell
|
|
LHCI_BASE_DIR="/drone/src"
|
|
LHCI_SERVER_URL="https://example.com/"
|
|
```
|
|
|
|
## Build
|
|
|
|
```Shell
|
|
docker build -t lhci:latest .
|
|
```
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License - see the [LICENSE](https://gitea.rknet.org/docker/lhci/src/branch/master/LICENSE) file for details.
|
|
|
|
## Maintainers and Contributors
|
|
|
|
[Robert Kaussow](https://gitea.rknet.org/xoxys)
|