Skip to main content

bough is a tool to determine which uv workspace packages need rebuilding based on git changes

Project description

Bough

bough is a tool to determine which uv workspace packages need building or testing based on git changes.

Problem

When using uv workspaces, it's often unclear which packages are affected by a given change. This leads to either rebuilding everything (wasteful) or missing necessary rebuilds (broken deployments).

Solution

Analyze dependencies and git diffs to identify affected packages, then build only what's needed.

Usage

bough

# Custom base commit
bough --base main analyze

# Display dependency graph
bough graph

# Output GitHub Actions matrix format
bough --format github-matrix analyze

Examples

my-app/
├── pyproject.toml
├── packages/
│   ├── auth/          # library (no deps)
│   ├── database/      # library (no deps)
│   └── shared/        # library (depends on: database)
└── apps/
    ├── api/           # buildable (depends on: auth, database, shared)
    └── web/           # buildable (depends on: shared)

Graph

The bough graph command shows the dependency relationships between packages:

🚀 Buildable Packages:
==================================================
📦 api (apps/api)
   └─ depends on: auth, database, shared

📦 web (apps/web)
   └─ depends on: shared

📚 Library Packages:
==================================================
📖 auth (packages/auth)
   ├─ depends on: (none)
   └─ depended on by: api

📖 database (packages/database)
   ├─ depends on: (none)
   └─ depended on by: api, shared, web

📖 shared (packages/shared)
   ├─ depends on: database
   └─ depended on by: api, web

Analyze

The bough analyze command shows what packages should be built based on what files have changed.

GitHub Matrix (for parallel CI jobs):

{
  "include": [
    {"package": "api", "directory": "apps/api"},
    {"package": "web", "directory": "apps/web"}
  ]
}

Text (default):

Packages to rebuild:
  api (apps/api)
  web (apps/web)

Changed files:
  packages/database/models.py

Configuration

.bough.yml:

# Packages that produce build artifacts (default: ["apps/*"])
buildable:
  - "apps/*"

# Files that never trigger rebuilds
ignore:
  - "*.md"
  - "docs/**"

GitHub Actions Integration

See GitHub Actions Integration Guide for examples of using Bough in CI/CD pipelines.

How It Works

  1. Find all workspace members from pyproject.toml
  2. Build dependency graph from tool.uv.sources
  3. Detect changed files with git diff
  4. Apply change detection rules:
    • File changed inside package → package directly affected
    • File changed at workspace root → all packages affected
  5. Calculate transitive impacts (if A depends on B and B changes, A is affected)
  6. Filter to only buildable packages
  7. Output build list

If packages/database/models.py changes:

  • database is directly affected
  • shared is affected (depends on database)
  • api is affected (depends on database and shared)
  • web is affected (depends on shared)
  • Output shows only api and web (they're buildable)

Non-Goals

This tool is intentionally simple:

  • Not a build system (like Bazel or Buck)
  • Not a task runner
  • Not multi-language aware
  • Not trying to optimize build order or parallelization
  • Not caching build artifacts

Prior Art

Roadmap

  • setup a release workflow to pypi
  • provide an option that outputs all affected packages, not just buildable ones (useful for selectively running tests)
  • handle working tree changes
  • add a contributing guide
  • check in a sample configuration file and document the defaults better
  • improve or remove the github actions examples

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bough-0.2.2.tar.gz (37.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bough-0.2.2-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

Details for the file bough-0.2.2.tar.gz.

File metadata

  • Download URL: bough-0.2.2.tar.gz
  • Upload date:
  • Size: 37.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.7

File hashes

Hashes for bough-0.2.2.tar.gz
Algorithm Hash digest
SHA256 ad9134d4a747b6ebe52f76a8412d00176565f12ecd52bee1eea9bd961a388036
MD5 fa4d2589dd6c29eea5702b847411a667
BLAKE2b-256 788f0af29372d4875ac1f125563bc3a2057ef7a89eefef6ef23dc2f886fd9b4b

See more details on using hashes here.

File details

Details for the file bough-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: bough-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 10.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.7

File hashes

Hashes for bough-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 07146f027f9b2b3cc978e8d1364f6b41e245c3b914fb0f9d0be6858ce93220a1
MD5 c6ec75954a2cd6f3a96cfc784b1eef47
BLAKE2b-256 fb453b5c8ad717198483c609d03c18765f989b6b687a647954b471762e7aed94

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page