https://github.com/andreasabel/git-bug-regression-chart
Plotting open regressions by version from git-bug and github data
https://github.com/andreasabel/git-bug-regression-chart
Last synced: about 2 months ago
JSON representation
Plotting open regressions by version from git-bug and github data
- Host: GitHub
- URL: https://github.com/andreasabel/git-bug-regression-chart
- Owner: andreasabel
- Created: 2026-04-28T08:39:03.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2026-04-28T09:36:18.000Z (about 2 months ago)
- Last Synced: 2026-04-28T11:29:57.892Z (about 2 months ago)
- Language: Python
- Size: 62.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# regression-chart
`regression-chart` extracts regression information from the local `git-bug` bridge data in `.git/git-bug`, augments closed issues with their GitHub milestone metadata, and writes machine-readable summaries plus human-readable reports.
The implementation is a standalone Python 3 script that uses only the standard library plus the external `git bug` and optional `gh` CLIs.
## How it works
1. It runs `git bug bug --format json` in the target repository and selects issues labeled `regression in VER`.
2. It reads the bridged GitHub issue URL for each selected issue and extracts the GitHub issue number.
3. For closed issues, it queries the GitHub GraphQL API for the closing milestone.
4. It queries the GitHub REST API for milestone close dates.
5. It computes:
- regressions grouped by introduced version
- how many regressions each milestone closes, grouped by introduced version
- how many regressions are still open at each milestone, grouped by introduced version
6. It renders the aggregated data as JSON, a markdown table, and two SVG charts.
## Example
Regressions for Agda 2.3.0 - 2.9.0.
## Running the tool
From the repository root:
```bash
cd src/release-tools/regression-chart
python3 main.py --repo-root /Users/abela/agda --out-dir /tmp/regression-chart
```
Or, when already in the repository root:
```bash
python3 ./src/release-tools/regression-chart/main.py --repo-root . --out-dir ./tmp/regression-chart
```
There is also a small wrapper script:
```bash
./src/release-tools/regression-chart/run.sh --repo-root . --out-dir ./tmp/regression-chart
```
To regenerate only the charts from previously computed JSON data:
```bash
python3 ./src/release-tools/regression-chart/main.py --out-dir ./tmp/regression-chart --chart-only
```
## Parameters
The tool accepts the following flags:
| Flag | Default | Description |
|---|---|---|
| `--repo-root` | `.` | Path to the Git repository root that contains `.git/git-bug`. The tool runs `git bug` there. This flag is ignored in `--chart-only` mode. |
| `--out-dir` | `.` | Directory in which generated files are written. The directory is created if needed. In `--chart-only` mode, this directory must already contain `regressions-open-by-milestone.json`. |
| `--owner` | `agda` | GitHub owner used for milestone lookups and milestone close-date lookups. This flag is only used in full generation mode. |
| `--repo` | `agda` | GitHub repository name used for milestone lookups and milestone close-date lookups. This flag is only used in full generation mode. |
| `--chart-only` | `false` | Regenerate `regressions-open-by-version.svg` and `regressions-open-by-date.svg` from `regressions-open-by-milestone.json` without recomputing issue or milestone data. |
## Authentication
GitHub authentication is needed in full generation mode because closed issues are enriched with milestone data from the GitHub GraphQL API and milestone close dates are read from the GitHub REST API.
No GitHub authentication is needed in `--chart-only` mode.
The tool looks for authentication in this order:
1. `GITHUB_TOKEN`
2. `GH_TOKEN`
3. `gh auth token`
So either set a token environment variable or make sure `gh auth login` has already been run.
The local `git-bug` data itself does not need extra authentication, but the repository must have `git bug` installed and usable.
## Output
The tool writes six files into `--out-dir` in full generation mode:
| File | Description |
|---|---|
| `regressions-by-version.json` | For each introduced version, the list of regression issues. Closed issues include their closing milestone when it is a version milestone. If a closed issue has no usable version milestone, it is listed under `unclassified_closed_regressions`. |
| `regressions-closed-by-milestone.json` | For each milestone, a map from introduced version to the number of regressions closed in that milestone. The `milestones` list stores milestone objects with both the version and the GitHub close date. |
| `regressions-open-by-milestone.json` | For each milestone, a map from introduced version to the number of regressions still open at that milestone. The `milestones` list stores milestone objects with both the version and the GitHub close date. |
| `regressions-open-by-version.md` | A markdown table of the open-regression matrix. |
| `regressions-open-by-version.svg` | A stacked bar chart of open regressions per milestone, with milestones uniformly spaced on the x-axis. The legend on the right is reversed so the latest version is on top. |
| `regressions-open-by-date.svg` | A stacked bar chart of open regressions per milestone, with each bar placed at the date on which the milestone was closed and the x-axis labeled by years. |
In `--chart-only` mode, only `regressions-open-by-version.svg` and `regressions-open-by-date.svg` are rewritten.
## Milestone metadata in JSON
The milestone-based JSON files now use milestone objects of the form:
```json
{
"version": "2.6.4",
"closed_on": "2024-04-07"
}
```
`closed_on` is an ISO date string when the milestone is closed and `null` when GitHub reports no close date.
## Chart colors
The chart uses the following palette, quoted exactly as requested:
> generated by https://gka.github.io/palettes/#/25\|d\|488f31,ffe692\|ffe692,de425b\|1\|1
```python
['#488f31', '#599639', '#699e41', '#78a549', '#87ac51', '#96b459', '#a5bb61', '#b4c269', '#c3c971', '#d2d079', '#e1d881', '#f0df8a', '#ffe692', '#fed98d', '#fccd89', '#fac084', '#f8b47f', '#f5a77b', '#f39a76', '#f08d71', '#ed7f6d', '#e97268', '#e66364', '#e2535f', '#de425b']
```
## Notes about the data
- Some issues in the bridged data currently carry more than one `regression in VER` label. The tool records all such labels in JSON and uses the earliest listed version as the introduced version for counting.
- Some closed issues may lack a usable version milestone on GitHub. Those issues are reported in `regressions-by-version.json` but excluded from milestone-based aggregates.
- Milestones without a GitHub close date remain present in the JSON milestone list, but they are omitted from the date-positioned chart because there is no date at which to place their bars.