Welcome to brassy’s documentation!

brassy (Build Release Assembler for Sane Software with YAML) builds release notes from small, per-change YAML files instead of one shared changelog. Each contributor adds a YAML note describing their change – title, description, files touched, and an optional related issue – alongside their pull request, so there is no single changelog file for everyone to merge-conflict over. When it’s time to cut a release, brassy reads every note and renders them into a single formatted RST document.

Install it with:

pip install brassy

Then see Using Brassy to get started, or Release Notes Checker to enforce that every pull request adds a release note.

Indices and tables

GitHub Repository