Skip to content

ci: a release checklist in the release PR, ticked from the release-check results #201

Open

Description

@groupsky

Why

The owner decides on a release from the release PR. Today the PR shows only the changelog, and the checks are elsewhere. The PR should show one checklist: what was checked, for which commit, with links to the evidence.

What to build

  1. A fixed checklist in the release PR body through release-please's pull-request-footer (release-please-config.json), between markers, one box per check of ci: a release-check workflow, run on demand on the release PR: update path, configs, audit log, mixed versions, stress, changelog, timing report #199 (1-8), one line for the timing report (ci: a release-check workflow, run on demand on the release PR: update path, configs, audit log, mixed versions, stress, changelog, timing report #199 item 9, not a box), the draft gate (ci: check the draft release's files before publishing (checksums, attestation, version, clean install) #200, after the merge), and "Owner: release approved".
  2. A workflow (workflow_run after release-check.yml, and after release-please updates the PR) that rewrites only the marked block: each box is ticked when the check passed for the PR's current head commit, with a link to the run. A new head commit unticks every box. It re-reads the body before it writes, and changes nothing outside the markers.
  3. A commit status release-ready on the head commit: success only when every box of ci: a release-check workflow, run on demand on the release PR: update path, configs, audit log, mixed versions, stress, changelog, timing report #199 is ticked for that commit.

The workflow never checks out or runs code from the PR. Ticking a box does not release anything: the merge stays a separate step.

Done when

  • The footer shows in the release PR.
  • The workflow ticks and unticks the boxes from the check results, with links, and sets release-ready; a test covers a new head commit unticking everything.
  • docs/releasing.md describes the checklist.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions