release-scope 0.3.0__tar.gz → 0.3.1__tar.gz

{release_scope-0.3.0 → release_scope-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: release-scope
-Version: 0.3.0
+Version: 0.3.1
 Summary: Collect what sits between production and the default branch across GitLab services: tags, MRs, Jira keys, failed jobs
 Keywords: release,gitlab,jira,deployments,merge-requests,ci,cli,python
 Author: Artur Shiriev
@@ -31,11 +31,24 @@ Project-URL: Issues, https://github.com/modern-python/release-scope/issues
 Project-URL: Changelog, https://github.com/modern-python/release-scope/releases
 Description-Content-Type: text/markdown
 
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)"  srcset="https://raw.githubusercontent.com/modern-python/.github/main/brand/projects/release-scope/lockup-dark.svg">
+    <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/modern-python/.github/main/brand/projects/release-scope/lockup-light.svg">
+    <img alt="release-scope" src="https://raw.githubusercontent.com/modern-python/.github/main/brand/projects/release-scope/lockup.png" width="420">
+  </picture>
+</p>
+
 [![PyPI version](https://img.shields.io/pypi/v/release-scope.svg)](https://pypi.org/project/release-scope/)
 [![Supported Python versions](https://img.shields.io/pypi/pyversions/release-scope.svg)](https://pypi.org/project/release-scope/)
+[![Downloads](https://static.pepy.tech/badge/release-scope/month)](https://pepy.tech/projects/release-scope)
 [![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen.svg)](https://github.com/modern-python/release-scope/actions/workflows/ci.yml)
 [![CI](https://github.com/modern-python/release-scope/actions/workflows/ci.yml/badge.svg)](https://github.com/modern-python/release-scope/actions/workflows/ci.yml)
 [![License](https://img.shields.io/github/license/modern-python/release-scope.svg)](https://github.com/modern-python/release-scope/blob/main/LICENSE)
+[![GitHub stars](https://img.shields.io/github/stars/modern-python/release-scope)](https://github.com/modern-python/release-scope/stargazers)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)
 
 `release-scope` collects what sits between production and the default branch across GitLab services: tags, MRs,
 Jira issues, failed jobs.
@@ -126,7 +139,8 @@ uvx release-scope collect --group team/backend --output report.json --cache cach
   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;
+The page opens with a table of the services that have pending changes or problems, with the ref each environment runs
+and a GitLab compare link from production to the newest pending tag (to the release tag in a `--jira` report);
 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
@@ -146,3 +160,20 @@ jobs of a finished pipeline keyed by its `updated_at`, so a retried job invalida
 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.
+
+## Agent skill
+
+[`skills/release-scope`](https://github.com/modern-python/release-scope/tree/main/skills/release-scope) is an agent
+skill that runs `release-scope` through `uvx` and answers release questions from the report. Ask your coding agent
+what in the current repository has not reached production, what a group will ship with the next tag, or whether a
+Jira issue is released and which services it touches. For the current repository the skill takes `--project` from
+the git remote. It keeps the report and cache outside the repository and never writes to GitLab or Jira.
+
+Install it with [skills](https://github.com/vercel-labs/skills):
+
+```sh
+npx skills add modern-python/release-scope
+```
+
+The agent reads the same environment variables as the CLI, so set them first as described under Configuration.
+The skill runs `release-scope>=0.3,<0.4`, the range whose flags and report schema it describes.

{release_scope-0.3.0 → release_scope-0.3.1}/README.md

@@ -1,8 +1,21 @@
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)"  srcset="https://raw.githubusercontent.com/modern-python/.github/main/brand/projects/release-scope/lockup-dark.svg">
+    <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/modern-python/.github/main/brand/projects/release-scope/lockup-light.svg">
+    <img alt="release-scope" src="https://raw.githubusercontent.com/modern-python/.github/main/brand/projects/release-scope/lockup.png" width="420">
+  </picture>
+</p>
+
 [![PyPI version](https://img.shields.io/pypi/v/release-scope.svg)](https://pypi.org/project/release-scope/)
 [![Supported Python versions](https://img.shields.io/pypi/pyversions/release-scope.svg)](https://pypi.org/project/release-scope/)
+[![Downloads](https://static.pepy.tech/badge/release-scope/month)](https://pepy.tech/projects/release-scope)
 [![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen.svg)](https://github.com/modern-python/release-scope/actions/workflows/ci.yml)
 [![CI](https://github.com/modern-python/release-scope/actions/workflows/ci.yml/badge.svg)](https://github.com/modern-python/release-scope/actions/workflows/ci.yml)
 [![License](https://img.shields.io/github/license/modern-python/release-scope.svg)](https://github.com/modern-python/release-scope/blob/main/LICENSE)
+[![GitHub stars](https://img.shields.io/github/stars/modern-python/release-scope)](https://github.com/modern-python/release-scope/stargazers)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)
 
 `release-scope` collects what sits between production and the default branch across GitLab services: tags, MRs,
 Jira issues, failed jobs.
@@ -93,7 +106,8 @@ uvx release-scope collect --group team/backend --output report.json --cache cach
   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;
+The page opens with a table of the services that have pending changes or problems, with the ref each environment runs
+and a GitLab compare link from production to the newest pending tag (to the release tag in a `--jira` report);
 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
@@ -113,3 +127,20 @@ jobs of a finished pipeline keyed by its `updated_at`, so a retried job invalida
 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.
+
+## Agent skill
+
+[`skills/release-scope`](https://github.com/modern-python/release-scope/tree/main/skills/release-scope) is an agent
+skill that runs `release-scope` through `uvx` and answers release questions from the report. Ask your coding agent
+what in the current repository has not reached production, what a group will ship with the next tag, or whether a
+Jira issue is released and which services it touches. For the current repository the skill takes `--project` from
+the git remote. It keeps the report and cache outside the repository and never writes to GitLab or Jira.
+
+Install it with [skills](https://github.com/vercel-labs/skills):
+
+```sh
+npx skills add modern-python/release-scope
+```
+
+The agent reads the same environment variables as the CLI, so set them first as described under Configuration.
+The skill runs `release-scope>=0.3,<0.4`, the range whose flags and report schema it describes.

{release_scope-0.3.0 → release_scope-0.3.1}/pyproject.toml

@@ -25,7 +25,7 @@ classifiers = [
     "Typing :: Typed",
     "Topic :: Software Development :: Build Tools",
 ]
-version = "0.3.0"
+version = "0.3.1"
 dependencies = [
     "typer>=0.13",
     "pydantic>=2; python_version < '3.12'",

{release_scope-0.3.0 → release_scope-0.3.1}/pyproject.toml.orig

@@ -17,7 +17,7 @@ classifiers = [
     "Typing :: Typed",
     "Topic :: Software Development :: Build Tools",
 ]
-version = "0.3.0"
+version = "0.3.1"
 dependencies = [
     "typer>=0.13",
     # The first release whose pydantic-core ships a wheel for each interpreter.

{release_scope-0.3.0 → release_scope-0.3.1}/release_scope/_gitlab.py

@@ -28,6 +28,7 @@ class Project(pydantic.BaseModel):
 
 class Deployable(pydantic.BaseModel):
     web_url: str | None = None
+    tag: bool = False
 
 
 class Deployment(pydantic.BaseModel):

{release_scope-0.3.0 → release_scope-0.3.1}/release_scope/_render.py

@@ -2,6 +2,7 @@ import collections.abc
 import datetime
 import html
 import typing
+from urllib.parse import quote
 
 from release_scope._report import (
     EnvironmentState,
@@ -131,11 +132,23 @@ def _not_done(service: Service, issues: dict[str, JiraIssue]) -> str:
     return f"{count} not done" if count else ""
 
 
-def _summary_row(service: Service, environments: list[str], jira: JiraState | None) -> list[str]:
+def _compare(service: Service, production: str) -> str:
+    start: typing.Final = _environment(service, production)
+    release: typing.Final = service.release
+    tag: typing.Final = release.tag if release else next((tag for row in service.rows for tag in row.tags), None)
+    if start is None or tag is None:
+        return ""
+    base, label = (start.ref, _cell(start.ref)) if start.tag else (start.sha, f"`{start.sha[:8]}`")
+    return _link(f"{label}...{_cell(tag.name)}", f"{service.project_url}/-/compare/{quote(base)}...{quote(tag.name)}")
+
+
+def _summary_row(service: Service, report: Report, environments: list[str]) -> list[str]:
+    jira: typing.Final = report.jira
     return [
         _link(_cell(service.project), service.project_url),
         *(_environment_ref(_environment(service, name)) for name in environments),
         _pending(service),
+        _compare(service, report.production_environment),
         *([_not_done(service, jira.issues)] if jira else []),
         _failure_counts(service),
     ]
@@ -301,10 +314,11 @@ def render_markdown(report: Report) -> str:
             "Service",
             *(_cell(name) for name in environments),
             "Pending",
+            "Compare",
             *(["Jira"] if jira else []),
             "Failed jobs",
         ]
-        lines.extend([*_table(header, (_summary_row(service, environments, jira) for service in attention)), ""])
+        lines.extend([*_table(header, (_summary_row(service, report, environments) for service in attention)), ""])
     else:
         lines.extend(["All services are up to date.", ""])
     if up_to_date:

{release_scope-0.3.0 → release_scope-0.3.1}/release_scope/_report.py

@@ -70,6 +70,7 @@ class EnvironmentState(pydantic.BaseModel):
     sha: str
     deployed_at: str
     deployment_url: str | None
+    tag: bool = False
 
 
 class Release(pydantic.BaseModel):

{release_scope-0.3.0 → release_scope-0.3.1}/release_scope/_use_case.py

@@ -51,6 +51,7 @@ def _environment_state(name: str, deployment: Deployment) -> EnvironmentState:
         sha=deployment.sha,
         deployed_at=deployment.created_at,
         deployment_url=deployment.deployable.web_url if deployment.deployable else None,
+        tag=deployment.deployable.tag if deployment.deployable else False,
     )