Release notes
Draft customer-facing release notes from merged pull requests.
Release notes get written late, in engineer language, or not at all. When a release is tagged, Hops reads the merged pull requests and drafts notes a customer can follow.
How it runs: Triggered. An automation runs when a new release tag is created in GitHub, and you can also ask Hops directly.
What it does
- Reads everything since the last tag. Hops lists the merged pull requests in GitHub and the tickets linked in Linear or Jira.
- Groups into New, Improved and Fixed. Each line is written for a customer, not an engineer.
- Skips internal changes. Refactors, CI and dependency bumps are left out.
- Links every line to its source. Each line points to its pull request so reviewers can check it.
- Flags gaps. Pull requests with no description or ticket are listed for a human to confirm.
Ask Hops
Copy a prompt into any chat with Hops, or mention @Hops in a Space.
Draft release notes for the v4.12 tag of the Acme web app.Write release notes for everything merged since the last tag in northwind/api.Which pull requests in this release are customer-facing, and which are internal?Turn the v4.12 notes into a shorter version for the changelog page.List pull requests in this release with no description or linked ticket.Example reply:
Release notes for v4.12, drafted from 23 merged pull requests:
- New: bulk export for reports (#2841).
- Improved: search results load about twice as fast (#2830).
- Fixed: invoice PDFs no longer cut off long line items (#2819).
- 9 internal changes skipped. 2 pull requests need a description.
What you get
- A post when the tag is created. The draft notes appear in the Space chat or your Slack channel.
- A saved Doc. Each release is saved as its own Doc in Docs in the Space, so past notes stay searchable.
- Answers on demand. Ask Hops to shorten, reformat or redraft the notes any time.
Connections needed
Connect these apps. Each card opens Connections in the app.
Set it up
Connect your apps
Connect GitHub, Linear or Jira, and Slack in Connections.
See Connections.
Create the Space
Create a product-eng Space and pin your release-notes style guide in Space context.
See Spaces and Space context.
Add the skill
Give Hops these instructions:
Plain textYou write release notes. Read merged PRs since the last tag. Group into New, Improved, Fixed. Write each line for a customer, not an engineer. Skip internal changes. Link each line to its PR.See Build a skill.
Trigger it
Create an automation that runs when a new release tag is created in GitHub. It posts the draft to the Space and saves it as a Doc in Docs.
See Automation.