Skip to content

CI/CD

Better Reports includes a GitHub Actions workflow for automated testing and Docker image publishing.

Workflow

.github/workflows/ci.yml

The CI pipeline runs on every push and pull request to the main branch:

Jobs

  1. Lint — Runs oxlint on backend and frontend code
  2. Test — Runs vitest for unit and integration tests
  3. Build UI — Builds the React frontend with Vite
  4. Build Docker — Builds and pushes the Docker image to GitHub Container Registry

Docker Image

The workflow builds a multi-architecture Docker image (linux/amd64, linux/arm64) and pushes it to ghcr.io/dlampatricio/better-reports.

Using the Docker Image

bash
docker pull ghcr.io/dlampatricio/better-reports:latest

Setting Up Your Own CI

To use the CI pipeline in your fork:

  1. Enable GitHub Actions in your repository
  2. The Docker push step requires a GITHUB_TOKEN with packages:write permission (automatically provided for GitHub Actions)
  3. Update the image name in the workflow file to match your registry

Design and Dev by David Lam