branch-out

Branch Out

A tool to accentuate the capabilities of Trunk.io's flaky test tools. When a test is detected as flaky, Trunk.io sends a webhook. From there, we can branch out to different services to customize the flaky test quarantine process.

See the design doc for a more detailed look at how it works.

Run

# See the help command for detailed instructions on how to run branch-out
branch-out --help

Configuration

Configuration is fetched in this priority order:

1. CLI Flags (e.g. --github-token <token-value>)
2. Env Vars
3. A .env file. See .env.example

Contributing

We use golangci-lint v2 for linting and formatting, and pre-commit for pre-commit and pre-push checks.

pre-commit install # Install our pre-commit scripts

See the Makefile for helpful commands for local development.

make lint                 # Lint and format code
make watch                # Watch repo and run tests when .go files are saved
make test                 # Run all tests
make test_race            # Run all tests with race detection
make test_short           # Run all `short` tests
make test_integration     # Only run Integration tests
make test_example_project # Run example tests in the example_project directory