Merge pull request 'Bump forgejo-release to v2' (#1) from actions-update into main

Reviewed-on: https://forgejo.neshweb.net///CI-Docker-Images/unlighthouse/pulls/1

.forgejo/workflows/build_release.yml

@@ -19,7 +19,7 @@ jobs:
         uses: docker/build-push-action@v5
         with:
           push: true
-          tags: forgejo.neshweb.net/firq/unlighthouse-docker:${{ github.ref_name }}, forgejo.neshweb.net/firq/unlighthouse-docker:latest
+          tags: forgejo.neshweb.net/ci-docker-images/unlighthouse:${{ github.ref_name }}, forgejo.neshweb.net/ci-docker-images/unlighthouse:latest
 
   release:
     needs: [build]
@@ -27,7 +27,7 @@ jobs:
     runs-on: docker
     steps:
       - name: Release New Version
-        uses: actions/forgejo-release@v1
+        uses: actions/forgejo-release@v2
         with:
           direction: upload
           url: https://forgejo.neshweb.net

.gitignore

@@ -0,0 +1 @@
+.vscode/*

Dockerfile

@@ -1,12 +1,15 @@
-FROM node:20.10.0-bookworm
+FROM node:20.14.0-bookworm
+
+LABEL authorname="firq"
+LABEL description="unlighthouse container for ci-based lighthouse testing"
 WORKDIR /unlighthouse
 
 # renovate: datasource=repology depName=debian_12/chromium versioning=loose
-ENV CHROMIUM_VERSION="120.0.6099.109-1~deb12u1"
+ENV CHROMIUM_VERSION="126.0.6478.114-1~deb12u1"
 ENV NODE_ENV='production'
 
 # Update path so executable can be run globally
 ENV PATH="/unlighthouse/node_modules/.bin:${PATH}"
 
 RUN apt-get update && apt-get -y install --no-install-recommends chromium=${CHROMIUM_VERSION} procps && rm -rf /var/lib/apt/lists/*
-RUN npm install @unlighthouse/cli puppeteer
+RUN npm install @unlighthouse/cli@0.13.1 puppeteer

README.md

@@ -1,3 +1,30 @@
-# Docker image to run lighthouse, but without non-privileged user
+# unlighthouse Docker Image
 
-Uses the full node:20-bookwork image instead of slim due to issues with GitLab lighthouse Docker
+Image based on `node:20.10.0-bookworm` with `chromium` and `unlighthouse` preinstalled.
+
+It can be used for benchmarking a given site with lighthouse and to generate corresponding reports with ease.
+
+## Usage
+
+The unlighthouse cli can be used by running the command `unlighthouse` inside the container
+
+```shell
+unlighthouse-ci --site "https://preview.firq.dev/"
+```
+
+It is recommended to provide a `unlighthouse.config.ts` to reduce the amount of CLI arguments needed.
+
+An example config can be found here:
+
+```typescript
+export default {
+    puppeteerOptions: {
+        args: ["--no-sandbox", "--disable-setuid-sandbox"],
+    },
+    ci: {
+        budget: 90,
+        buildStatic: true
+    },
+    outputPath: "unlighthouse-reports",
+}
+```