When a release/* branch opens a PR into main, aggregate every merged PR and commit in the release, categorize the changes, and write user-facing release notes into the PR body.
- Identifier
release-pr-description- Version
- 1.0.0
- Steps
- 3
- Triggers
- 1
- release
- pull-request
- notes
- automated
When it runs
pull_request.opened- Settle delay
- 10s after the event
Only when all hold
- pullRequest.headBranch starts with release/
- pullRequest.baseBranch in main, master
- actor.username not contains [bot]
The pipeline
The graph below is the one the workflow opens with in the builder — same steps, same layout, drawn on the same canvas. The run playing through it is a simulation; the branches and conditions are real.
- 01Release PR Opened
triggerThe event that starts the run.
- 02Clone Repository
git.cloneShallow-clones the repository at the right ref.
- 03Write Release Notes
agent.runOne agent works the task with its toolkit.
The agent
Release Notes Writer
- Base type
- Tech Writer
- Temperature
- 0.3
- Max iterations
- 35
- Tools
- 9
Git provider · 4
read_pull_requestRead Pull Request · readlist_pull_requestsList Pull Requests · readget_pull_request_diffGet Pull Request Diff · readupdate_pull_requestUpdate Pull Request · write
Filesystem · 2
read_fileRead File · readlist_dirList Directory · read
Terminal · 1
run_terminal_cmdRun Terminal Command · write
Code search · 1
code_searchCode Search · read
Status · 1
update_statusUpdate Status · write
Related playbooks
Release Notes
Generates clean, categorized release notes from merged PRs when a release publishes.
Changelog Generator
Classifies each merge to the default branch and adds a changelog entry.
Implement Documentation from Issue
Turns docs-labeled issues into documentation PRs written in the repository’s existing style.