ci-runner

Overview ¶

VaultRun CI Runner — GitHub webhook receiver that runs PR test suites in isolated VaultRun sandboxes and posts results back to the pull request.

Usage:

GITHUB_TOKEN=ghp_...               \
GITHUB_WEBHOOK_SECRET=your-secret  \
VAULTRUN_BASE_URL=http://vaultrun  \
VAULTRUN_API_KEY=vr_...            \
./ci-runner

Environment variables:

GITHUB_TOKEN            GitHub PAT with repo + write:discussion scopes (required)
GITHUB_WEBHOOK_SECRET   Secret configured in the GitHub webhook settings (required)
VAULTRUN_BASE_URL       Base URL of the VaultRun API (required)
VAULTRUN_API_KEY        API key for the VaultRun API (required)
CI_DOCKER_IMAGE         Docker image for the sandbox (default: ubuntu:22.04)
CI_TEST_COMMANDS        JSON array of command arrays to run after cloning,
                        e.g. '[["go","test","./..."],["go","vet","./..."]]'
                        (default: [["make","test"]])
PORT                    HTTP listen address (default: :8080)
SLACK_WEBHOOK_URL       Slack Incoming Webhook URL (optional)
TEAMS_WEBHOOK_URL       Microsoft Teams Workflows webhook URL (optional)
NOTIFY_ON_SUCCESS       Set to "false" to suppress success notifications
                        and only alert on failures (default: true)

Slack and Microsoft Teams notifications for VaultRun CI results.