release-scope 0.3.0

release-scope collects what sits between production and the default branch across GitLab services: tags, MRs, Jira issues, failed jobs.

For every service it reads the latest successful production deployment, walks the default branch down to that commit, and writes one JSON report: a row per merge request or direct commit, newest first, with the tags that point into it, the environments running it, the Jira keys its MR mentions, and the failed jobs of its main-branch and tag pipelines. With a Jira token, it also reads the summary and status of every key in one batched search, and the GitLab merge requests and commits linked to each issue. GitLab's Jira integration adds those links to the issue's Web links whenever a commit or MR mentions it; a link counts only if it starts with RELEASE_SCOPE_GITLAB__ENDPOINT. The projects they point to are the issue's related services.

Quickstart

export RELEASE_SCOPE_GITLAB__ENDPOINT=https://gitlab.example.com
export RELEASE_SCOPE_GITLAB__TOKEN=glpat-...          # read_api scope
export RELEASE_SCOPE_ENVIRONMENTS='["prod", "preview"]'
export RELEASE_SCOPE_PRODUCTION_ENVIRONMENT=prod

uvx release-scope collect --group team/backend --output report.json --cache cache.json

--group and --project are repeatable and can be mixed. The command exits 1 when any service failed to collect; the report is still written and names the error on that service. A service GitLab denies access to fails alone, and its error lists the project settings and member page to check. A project with CI/CD or Environments disabled is reported with a warning and no rows, without querying it. Only a rejected token, or a group or project passed on the command line that the token cannot see, stops the run. A failed Jira search is recorded in the report and also exits 1; the GitLab part is still written.

Jira issues

--jira scopes the report to Jira issues instead of groups or projects, and needs the Jira settings:

uvx release-scope collect --jira SHOP-140 --jira SHOP-141 --output report.json --cache cache.json

It reads the issues and their GitLab links, then collects every project they link to. In each project the rows run from the production baseline up to the latest linked change, so they show everything that ships with the issues. The service records the release state: pending with the nearest tag at or above that change (or none, when a new tag is needed), in_production when every linked merge request is already deployed, not_merged when only open merge requests link to it, or not_found. Open merge requests and merges into other branches are listed either way. --jira is repeatable and cannot be combined with --group or --project; an issue Jira does not return exits 1.

Configuration

Every setting is an environment variable; nothing about a GitLab or Jira instance is built in.

Report

The report is versioned by schema_version; the models live in release_scope/_report.py. Top-level jira is null without a Jira token; otherwise it holds issues by key (summary, status, status category, issue type, linked GitLab changes), the missing keys Jira did not return, and an error if a Jira request failed. One row, trimmed:

{
  "kind": "merge_request",
  "tags": [{"name": "1.2.0", "url": "...", "pipeline": {"id": 201, "status": "success", "failed_jobs": []}}],
  "merge_requests": [{"iid": 12, "title": "SHOP-12 new endpoint", "url": "..."}],
  "commits": [{"sha": "c3...", "title": "Merge branch 'feature/SHOP-12'"}],
  "jira_keys": [{"key": "SHOP-12", "url": "https://jira.example.com/browse/SHOP-12"}],
  "environments": ["preview"],
  "main_pipeline": {"id": 103, "status": "failed", "failed_jobs": [{"kind": "job", "name": "lint", "allow_failure": false}]}
}

Page

render turns a report into a Markdown page for a GitLab wiki, without calling GitLab:

uvx release-scope collect --group team/backend --output report.json --cache cache.json; \
  uvx release-scope render report.json --output report.md

The page opens with a table of the services that have pending changes or problems, with the ref each environment runs; services already up to date collapse into one expandable table. Each service with changes then has a collapsible table of its rows: the tag linked to its pipeline, the merge requests or direct commit, Jira keys with summary and status, the other services its Jira issues link to, where the change is deployed, and the failed jobs of its main-branch and tag pipelines. With Jira issues, the summary table also counts the issues per service whose status is not done. A --jira report names its issues at the top, shows the tag to release per service, and marks the rows linked to the issues.

Chain the two commands with ;, not &&: collect exits 1 when a service failed, which is exactly when the page should show it. Alert on the exit code of collect, not on whether to render. render fails only when it cannot read the report or write the page.

Cache

--cache names a JSON file that is read if present and rewritten atomically after the run. It holds only facts that do not change once settled: which merge requests a commit belongs to, a merged merge request, and the failed jobs of a finished pipeline keyed by its updated_at, so a retried job invalidates the entry. Within each project the run collected, entries it did not use are dropped; other projects keep theirs, so one cache file serves both group and --jira runs. A missing, corrupt, or older-schema cache is ignored with a warning; the cache only saves requests and never changes the report.