# Release notes

Turns the pull requests merged since your last release into draft release notes for a person to edit.

Requires GitHub, through the AgentRun GitHub App.

## Install

```sh
npx @parcha/agentrun template install github:Parcha-ai/agentrun/packages/serve/templates/release-notes@860cae180df56af4d9a206ef2c997178da29fcf9 --trust
```

Or open `<your AgentRun address>/#/templates/install?src=github%3AParcha-ai%2Fagentrun%2Fpackages%2Fserve%2Ftemplates%2Frelease-notes%40860cae180df56af4d9a206ef2c997178da29fcf9`. Pinned to commit 860cae180df56af4d9a206ef2c997178da29fcf9.

## What it does

Turns the pull requests merged since the last release into user-facing release notes (what you can do now, fixed, upgrading, changes by pull request), leaves them as a draft issue for a person to edit, and never publishes.

- Skill `release-notes`: Write user-facing release notes from the pull requests merged between two releases of a GitHub repository. Find the range, read each merged PR (title, body, labels, change fragment), sort the user-facing changes into "What you can do now", "Fixed" and "Upgrading", list every PR once at the bottom, post the draft as one GitHub issue for a person to edit, and answer with the notes as JSON. Use for "release notes for v1.4.0", "notes since v1.3.0", "what merged this week", or a GitHub release or tag event.
- Rules: `STYLE.md`

## What starts it

- A GitHub release on your repository (published). Needs the GitHub App connected. At most 1 at once.
- By hand, any time: from the console, the API or the CLI.

## Inputs

Each run takes a plain message (`content`).

### Setup, filled in once at install

| Name | Type | Required | What it is |
| --- | --- | --- | --- |
| `owner` | string | yes | The GitHub account that owns the repository whose releases you write notes for, as GitHub spells it, like Parcha-ai. |
| `repo` | string | yes | The repository's name alone, without its owner, as GitHub spells it, like agentrun. |
| `groups` | string | no | The section names under 'What you can do now', in order, comma separated (for example: Install, Harnesses, Learning); empty: the agent picks a few from the changes. |
| `style` | string | no | One short line on tone (for example: plain and short, second person); empty: the skill's default. |
| `changes_dir` | string | no | The folder where the repo keeps one change fragment per pull request (for example: changes); empty: the repo has none. |

## What it needs

- Harness: pi
- Model: balanced tier, medium effort
- Tools: read
- GitHub tools (optional): list_releases, get_latest_release, get_release_by_tag, list_tags, get_tag, list_commits, get_commit, list_pull_requests, pull_request_read, get_file_contents, list_issues, get_label, issue_write. Reads releases, tags, commits and merged pull requests to find what changed, and opens one new draft issue with the notes. Every call is held to this one repository. It never publishes or edits anything.
- Computer: Wherever your AgentRun puts a new agent
- Keys: A model key
- Learning: on

## Sample output

No sample output ships with this template yet.

## Tested

9 eval cases: draft-not-publish, every-pr-accounted, issue-write-refused, late-arrival, learned-style, no-pr-numbers-on-top, other-repo, upgrade-line, user-facing-only.

## Source

- Package: https://github.com/Parcha-ai/agentrun/tree/860cae180df56af4d9a206ef2c997178da29fcf9/packages/serve/templates/release-notes
- Publisher: Parcha-ai (1210 stars, 95 forks)
- Author: Parcha Labs
- Version: 0.2.0
- License: Apache-2.0
- Category: Engineering
- Page: https://marketplace.agentrun.ai/templates/release-notes/
