I want to showcase the project I have been working on for the last weeks.
GitHub and Gitea/Forgejo allow you to upload files and directories created during a continuous integration run (Artifacts). These can be downloaded as zip
files. However there is no simple way to view individual files of an artifact.
That's why I developed a small web application that allows you to view the artifacts of any CI run in your web browser. This allows you to quickly look at test reports or preview your web projects.
I am hosting a public instance with support for GitHub and Codeberg under https://av.thetadev.de/.
Features
- ๐ฆ Quickly view CI artifacts in your browser without messing with zip files
- ๐ File listing for directories without index page
- ๐ Every artifact has a unique subdomain to support pages with absolute paths
- ๐ Full SPA support with
200.html and 404.html fallback pages
- ๐๏ธ Viewer for Markdown, syntax-highlighted code and JUnit test reports
- ๐ต Greasemonkey userscript to automatically add a "View artifact" button to
GitHub/Gitea/Forgejo
- ๐ฆ Fast and efficient, only extracts files from zip archive if the client does not support gzip
- ๐ Automatically creates pull request comments with links to all build artifacts
Examples
Here are some artifacts to try:
SveltePress documentation site: https://cb--thetadev--artifactview--28-2.av.thetadev.de/
A bunch of test files: https://cb--thetadev--artifactview--28-1.av.thetadev.de/
Artifactview's own test report: https://cb--thetadev--artifactview--65-1.av.thetadev.de/junit.xml?viewer=1
Automatically created pull request comment: https://codeberg.org/ThetaDev/artifactview/pulls/2
This is really cool and something I've been missing since we kind of got forced off our original CI platform (they changed their free tier and it would have been financially prohibitive) and moved to GH runners.
Is there a limit to the size? I notice that your example instance (and the default value) of file size is set to 100MB, is there a maximum size if you were to self host it or is it technically unlimited? Our CI artifacts tend to be around 700-800MB.
Technically unlimited, but you obviously need to have enough storage to cache the zip files (and RAM to cache the file index). My server is very small, so I needed to set the limit low.
Does GitHub support range requests for artifacts? With that you could read the file index without downloading and caching the entire zip
It does (they of course use their Azure Blob storage under the hood). Forgejo however does not (even though it supports it for releases and packages and Golang has this in their standard library).
I'll keep the idea in mind.
Totally understand the limits on your server, I know why you would have it set that way hence why I was wondering about the limits if self hosting. Definitely going to have a play with this.