Skip to content

CI/CD Pipelines

kreview uses four GitHub Actions workflows to automate testing, linting, documentation, and releases.

Pipeline Overview

flowchart TD
    classDef test fill:#10b981,stroke:#047857,color:#fff;
    classDef lint fill:#3b82f6,stroke:#1e40af,color:#fff;
    classDef docs fill:#8b5cf6,stroke:#5b21b6,color:#fff;
    classDef release fill:#f59e0b,stroke:#b45309,color:#fff;

    PR["Push / PR to\nmain or develop"] --> T["test.yml"]:::test
    PR --> L["lint.yml"]:::lint
    MAIN["Push to main"] --> D["docs.yml"]:::docs
    TAG["Push tag v*.*.*"] --> R["release.yml"]:::release
Use mouse to pan and zoom

Workflows

Trigger: Push or PR to main / develop

Step What it does
Setup Python 3.12 Caches pip dependencies
Install dependencies pip install -e .[test]
Run pytest pytest --cov=kreview --cov-report=xml
Test package build python -m build (dry-run, no publish)
Test Docker build Builds image with push: false

Why test the build?

By validating both the Python wheel and Docker image on every PR, we catch packaging issues before they reach the release pipeline.

Trigger: Push or PR to main / develop

Step Tool
Formatting black --check .
Linting ruff check .
Type checking mypy kreview

Trigger: Push to main only

Builds the MkDocs Material site and deploys it to GitHub Pages using mike for versioned documentation. The dev alias always points to the latest main build.

Trigger: Push of a v*.*.* tag

Step What it does
Build package python -m build
GitHub Release Uploads .whl + auto-generated release notes
Publish to PyPI Uses OIDC Trusted Publishing (no API tokens)
Build Docker image Multi-stage build with Quarto
Push to GHCR Tags: kreview:v*.*.* and kreview:latest
Deploy docs mike deploy --push --update-aliases $VERSION stable

OIDC Requirement

PyPI Trusted Publishing requires the repository to be registered as a Trusted Publisher on pypi.org. This is a one-time setup.

Required Permissions

Workflow Permission Purpose
release.yml id-token: write PyPI OIDC authentication
release.yml packages: write Push Docker images to GHCR
release.yml contents: write Create GitHub Releases
docs.yml contents: write Push to gh-pages branch