Repository navigation
Releases: gagoar/pr-brief
Releases · gagoar/pr-brief
Release list
v0.3.0: chart labels, host-aware length, CI setup
What's new
Charts
- Input and Output boxes read
Input 1andOutput 1. - Function labels never show parentheses.
- A Legend line under each chart names the colours it uses.
Length per host
- GitHub accepts 65,536 characters in a description. Azure DevOps accepts 4,000. The gate takes the limit from the host and counts characters, not bytes.
gate --hostsets it by hand.
CI setup
/pr-brief ciasks which host you use and where the settings live, then writes the CI file.pr-brief init --workflowtakes--host github|azure-devopsand--config file|inline.- New Azure Pipelines file. It reads the PR with the job's own
System.AccessToken. No secret, no personal access token. It has not run in a live organisation yet. - The Action takes
styleandthemeinputs, used only when the base branch has no.pr-brief.json, and arefreshinput. - Optional:
pr-brief init --rewrite --auth <federation|bedrock|vertex|api-key>writes a workflow where the Claude Code GitHub Action rewrites the description, then the gate checks it. GitHub only. Each team chooses how the job signs in to Claude. Not tested on a live repository yet.
Docs
- Requirements table for the two plugins the default style needs (asd-ste100, iceberg).
- The gate page explains each rule, how to read a finding, what the gate reads, and the rewrite job.
Upgrading
- The gate now requires the
Input n/Output nbox labels and the Legend line under each chart. Descriptions written with 0.2.x need/pr-brief improvebefore the 0.3.0 gate accepts them. - Workflows on
gagoar/pr-brief@v0get the new version.
Binaries are attested. Check them against SHA256SUMS.
v0.2.0: diagram themes
Diagram themes
- Four built-in themes:
github-dark(default),github-light,dracula,alucard(Dracula's light theme). - Your own theme as a JSON file in beautiful-mermaid's format, with an optional
statusblock.pr-brief config set diagram.theme ./theme.json --scope repo. pr-brief diagramdraws a whole flow in the chosen theme. The gate recomputes the style and rejects anything the tool did not produce.- New:
pr-brief theme list | show | validate, and JSON Schemas for the settings, the theme file and the flow. - Looks follow beautiful-mermaid (MIT, Craft Docs). See
THIRD_PARTY_NOTICES.md.
Breaking
Descriptions written by v0.1.0 (six hand-copied colour lines, no theme= in the begin marker) fail the new gate. Run /pr-brief improve to draw them again.
Checked
Rendered on github.com (Mermaid 11.17.2) in light and dark mode. Azure DevOps is not verified for the init line, the invisible layout links, or per-edge styling.
Use the Action
- uses: actions/checkout@v4
- uses: gagoar/pr-brief@v0.2.0