diff --git a/CONTEXT.md b/CONTEXT.md index 9ca64ae..339a700 100644 --- a/CONTEXT.md +++ b/CONTEXT.md @@ -55,5 +55,9 @@ production. The rows above the newest row with a tag, or every row when none has one. Only a tag that does not exist yet can ship them. The next tag is the highest `X.Y.Z` tag with its minor version bumped. +**First deployment**: +For a row and an environment other than production, when the deploy job finished that first shipped the row or a +newer row to it. A later rollback does not undo it. + **Settled fact**: Data GitLab will not change for the same key, and so the only data the cache may hold. diff --git a/README.md b/README.md index ae3e103..735a30e 100644 --- a/README.md +++ b/README.md @@ -22,8 +22,10 @@ Jira issues, failed jobs. For every service it reads the latest successful production deployment, walks the default branch down to that commit, or down to its first commit when the service was never deployed to production, and writes a static site with -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, +one JSON report: a row per merge request or direct commit, newest first. A row has 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. It +also has its first deployment to each environment other than production: when the first deploy job that shipped the +row, or a newer row, finished. 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. @@ -105,6 +107,7 @@ comes from one more request for the highest versions. One row, trimmed: "commits": [{"sha": "c3...", "title": "Merge branch 'feature/SHOP-12'"}], "jira_keys": [{"key": "SHOP-12", "url": "https://jira.example.com/browse/SHOP-12"}], "environments": ["preview"], + "first_deployed_at": {"preview": "2026-09-22T00:00:00Z"}, "main_pipeline": {"id": 103, "status": "failed", "failed_jobs": [{"kind": "job", "name": "lint", "allow_failure": false}]} } ``` @@ -118,7 +121,8 @@ installed package and change only with it, so the page always matches the report Switches at the top pick the language, English or Russian, and the theme: as in the system, light, or dark. The page starts in the browser's language and remembers both choices in the browser. The copied lists and release post follow the language, and so do warnings and errors from `collect`; texts from GitLab and Jira, such as titles, statuses and -Jira's own error details, stay as written. +Jira's own error details, stay as written. Times show in the browser's time zone; hovering one shows the value +as the report holds it. **Services** lists every service with a production deployment or with rows, and every service that failed to collect, as one line: what production runs, the picked tag, how many merge requests or commits and Jira tasks it ships, the @@ -128,7 +132,8 @@ range holds no tag, so more untagged rows may lie below it. The failed jobs are the main pipeline of its commit; failures in other rows show only when the line is opened. Opening a line shows the service's environments, warnings, a link to create the next tag on the head when rows have no tag yet, merge requests that are not merged yet, and its rows with -tags and their pipelines, merge requests or commits, Jira keys with their status, environments, and failed jobs; rows +tags and their pipelines, merge requests or commits, Jira keys with their status, environments with the time each +first ran the row, and failed jobs; rows out of scope are dimmed. Links, including the GitLab settings pages that warnings and errors point to, open in a new tab. Each tag has a **pick** button: picking it highlights the rows it ships and closes the line again. A `--jira` report starts with each service's release tag picked. Services with neither a production deployment nor rows are left @@ -163,7 +168,7 @@ release-report: rules: - if: $CI_PIPELINE_SOURCE == "schedule" script: - - uvx --from 'release-scope>=0.7,<0.8' release-scope collect --group team/backend --output public || [ $? -eq 1 ] + - uvx --from 'release-scope>=0.8,<0.9' release-scope collect --group team/backend --output public || [ $? -eq 1 ] pages: true ``` @@ -202,4 +207,4 @@ 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.7,<0.8`, the range whose flags and report schema it describes. +The skill runs `release-scope>=0.8,<0.9`, the range whose flags and report schema it describes. diff --git a/release_scope/_gitlab.py b/release_scope/_gitlab.py index 5ffcd8a..db58aa4 100644 --- a/release_scope/_gitlab.py +++ b/release_scope/_gitlab.py @@ -29,15 +29,22 @@ class Project(pydantic.BaseModel): class Deployable(pydantic.BaseModel): web_url: str | None = None tag: bool = False + finished_at: dt.datetime | None = None class Deployment(pydantic.BaseModel): id: int ref: str sha: str - created_at: str + created_at: dt.datetime deployable: Deployable | None = None + @property + def finished_at(self) -> dt.datetime: + if self.deployable and self.deployable.finished_at: + return self.deployable.finished_at + return self.created_at + class TagCommit(pydantic.BaseModel): id: str @@ -213,6 +220,21 @@ def latest_deployment(self, project_id: int, environment: str) -> Deployment | N ) return deployments.root[0] if deployments.root else None + def list_successful_deployments( + self, project_id: int, environment: str, *, finished_after: dt.datetime + ) -> tuple[list[Deployment], bool]: + return self._pages( + f"{_API}/projects/{project_id}/deployments", + { + "environment": environment, + "status": "success", + "order_by": "finished_at", + "finished_after": finished_after.isoformat(), + }, + _Deployments, + resource="deployments", + ) + def list_tags(self, project_id: int) -> tuple[list[Tag], bool]: return self._pages(f"{_API}/projects/{project_id}/repository/tags", {}, _Tags, resource="repository") diff --git a/release_scope/_messages.py b/release_scope/_messages.py index 6e59be4..c509942 100644 --- a/release_scope/_messages.py +++ b/release_scope/_messages.py @@ -98,6 +98,14 @@ def tags_truncated() -> Message: return Message(code=MessageCode.TAGS_TRUNCATED, text="Tag list was truncated; some tags may be missing from rows.") +def deployments_truncated(environment: str) -> Message: + return Message( + code=MessageCode.DEPLOYMENTS_TRUNCATED, + params={"environment": environment}, + text=f"Deployment history of {environment} was truncated; newer rows may miss when they reached it.", + ) + + def merged_elsewhere(iid: int, target_branch: str, default_branch: str) -> Message: return Message( code=MessageCode.MERGED_ELSEWHERE, diff --git a/release_scope/_report.py b/release_scope/_report.py index 0874e31..a637d4a 100644 --- a/release_scope/_report.py +++ b/release_scope/_report.py @@ -5,7 +5,7 @@ import pydantic -SCHEMA_VERSION: typing.Final = 5 +SCHEMA_VERSION: typing.Final = 6 class MessageCode(enum.StrEnum): @@ -15,6 +15,7 @@ class MessageCode(enum.StrEnum): NO_PRODUCTION = "no_production" COMMITS_TRUNCATED = "commits_truncated" TAGS_TRUNCATED = "tags_truncated" + DEPLOYMENTS_TRUNCATED = "deployments_truncated" MERGED_ELSEWHERE = "merged_elsewhere" GITLAB_UNREACHABLE = "gitlab_unreachable" GITLAB_STATUS = "gitlab_status" @@ -83,6 +84,7 @@ class Row(pydantic.BaseModel): commits: list[CommitRef] jira_keys: list[JiraKeyRef] environments: list[str] + first_deployed_at: dict[str, dt.datetime] = pydantic.Field(default_factory=dict) main_pipeline: PipelineState | None linked: bool = False in_scope: bool = True @@ -92,7 +94,7 @@ class EnvironmentState(pydantic.BaseModel): name: str ref: str sha: str - deployed_at: str + deployed_at: dt.datetime deployment_url: str | None tag: bool = False @@ -157,7 +159,7 @@ class JiraState(pydantic.BaseModel): class Report(pydantic.BaseModel): - schema_version: typing.Literal[5] = SCHEMA_VERSION + schema_version: typing.Literal[6] = SCHEMA_VERSION collected_at: dt.datetime production_environment: str services: list[Service] diff --git a/release_scope/_rows.py b/release_scope/_rows.py index 17447e0..205b936 100644 --- a/release_scope/_rows.py +++ b/release_scope/_rows.py @@ -1,7 +1,9 @@ import collections.abc import dataclasses +import datetime as dt +import typing -from release_scope._gitlab import Commit, MergeRequest +from release_scope._gitlab import Commit, Deployment, MergeRequest @dataclasses.dataclass(slots=True, kw_only=True) @@ -35,3 +37,20 @@ def group_rows( row = rows.setdefault(key, RowDraft(commits=[], merge_requests=list(merge_requests))) row.commits.append(commit) return list(rows.values()) + + +def first_deployed( + drafts: collections.abc.Sequence[RowDraft], + deployments: collections.abc.Mapping[str, collections.abc.Iterable[Deployment]], +) -> list[dict[str, dt.datetime]]: + positions: typing.Final = {commit.id: index for index, draft in enumerate(drafts) for commit in draft.commits} + earliest: typing.Final[list[dict[str, dt.datetime]]] = [{} for _ in drafts] + for environment, items in deployments.items(): + for deployment in items: + if deployment.sha not in positions: + continue + for times in earliest[positions[deployment.sha] :]: + current = times.get(environment) + if current is None or deployment.finished_at < current: + times[environment] = deployment.finished_at + return earliest diff --git a/release_scope/_static/index.html b/release_scope/_static/index.html index 57eb2ab..a47e91f 100644 --- a/release_scope/_static/index.html +++ b/release_scope/_static/index.html @@ -102,7 +102,7 @@

- +

@@ -206,7 +206,15 @@

- + + +