Skip to content

gocov documentation

Start here if you are new: Getting started takes a fresh instance from docker compose up to the first coverage upload.

Contents

Page Covers
Features What gocov does, surface by surface, and how the architecture extends
Getting started Quick start, onboarding, workspace settings, hosted mode
Sign-in Enabling web UI sign-in with Bitbucket, GitHub and/or GitLab; the access model
Forge connections GitHub App, Bitbucket and GitLab one-click connect — setup and behavior
Uploading from CI Bitbucket Pipelines, GitHub Actions, GitLab CI, prebuilt binaries, other ecosystems
Coverage gate Minimum/diff/drop rules and making them block merges
Parts Combining multiple reports per commit from separate CI jobs
API & badge The upload API and the SVG badge
Configuration Every environment variable
Development Building, testing, health checks

Conventions

Throughout these docs, forge means the code host (Bitbucket Cloud, GitHub or GitLab) and workspace means the namespace gocov tracks — a Bitbucket workspace, a GitHub org or user, or a GitLab group, subgroup (by full path) or user namespace.