Documentation

Buildpathio Documentation

Everything you need to integrate dependency graph analysis and pre-push risk scoring into your engineering workflow.

Quickstart Get from install to your first risk score in 4 minutes. Dependency Graph How the live service graph is built from your codebase. Risk Scoring Understand the scoring algorithm and configure thresholds. API Reference REST endpoints, auth, and request/response schemas.

What Buildpathio does

Buildpathio integrates at the CI layer and builds a live directed graph of your microservice dependencies. When a pull request is opened, Buildpathio computes a risk score based on which services are transitively affected by the changes in that PR — and surfaces that score as a GitHub check, Slack notification, or CLI output before any code review begins.

How it works in 60 seconds

  1. Install the Buildpathio GitHub App on your repository
  2. Add a buildpath.yaml config file to your repo root
  3. Push a branch or open a PR — Buildpathio scans automatically
  4. See the risk score in the PR check within ~2 minutes

Installation requirements

Buildpathio works with repositories that:

  • Use GitHub, GitLab, or Bitbucket for version control
  • Have services in Node.js, Python, Go, Java, or Ruby (additional language support in progress)
  • Run CI via GitHub Actions, Jenkins, CircleCI, or any CI that supports webhooks

No changes to your existing CI pipeline are required to get the basic PR check working. Advanced features (CLI blocking, custom thresholds) require a buildpath.yaml config.