Skip to content

The bump PR's summary heads the GitHub Release page #161

Closed

Description

@JacobStephens2

Parent

#150

What to build

The published GitHub Release opens with the bump PR's summary, above GitHub's generated list of PRs and the install instructions.

The existing post-announce release-notes workflow is one of our own hooks, not generated by dist (ADR-0003). It calls script code in the repo that:

  • finds the PR whose merge commit is the tagged commit
  • takes the summary section from that PR's body

The workflow builds the Release body as that summary, then the generated notes, then dist's install instructions. It builds the body from the plan and the PR, never from the Release's current body, so a re-run doesn't repeat anything.

If the tagged commit has no such PR (say, a tag pushed by hand), or the PR has no summary section, the Release body is exactly what it is today.

The finding and extraction logic lives in script code rather than in workflow YAML, so the same black-box seam as the other tickets of #150 tests it.

Acceptance criteria

  • Given a tag whose commit is the merge of a bump PR with a summary section, the extraction returns that summary.
  • Given a tag with no bump PR, or a PR without a summary section, it returns nothing, and the workflow falls back to today's body.
  • The release-notes workflow puts the summary above the generated notes and the install instructions, and running it again gives the same body.
  • The fake gh can find the PR for a commit. The extraction is tested through the script, not the workflow.
  • The release workflow that dist generates is not edited.

Blocked by

Metadata

Metadata

Assignees

No one assigned

    Labels

    ready-for-agentFully specified, ready for an AFK agent

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions