> ## Documentation Index
> Fetch the complete documentation index at: https://hopsdocs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

<Info>
  **How it runs:** Triggered. An automation runs when a new release tag is created in GitHub, and you can also ask Hops directly.
</Info>

## 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.

<Frame>
  <img src="https://mintcdn.com/hopsdocs/E03FYifT87c9QmFJ/images/use-cases/pe-release-notes.gif?s=a0b6a015deefa5d27f8b7785b1538797" alt="GitHub connection, Hops drafted release notes from 23 merged pull requests" width="1440" height="810" data-path="images/use-cases/pe-release-notes.gif" />
</Frame>

## Ask Hops

Copy a prompt into any chat with Hops, or mention `@Hops` in a Space.

```text theme={null}
Draft release notes for the v4.12 tag of the Acme web app.
```

```text theme={null}
Write release notes for everything merged since the last tag in northwind/api.
```

```text theme={null}
Which pull requests in this release are customer-facing, and which are internal?
```

```text theme={null}
Turn the v4.12 notes into a shorter version for the changelog page.
```

```text theme={null}
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.

<CardGroup cols={3}>
  <Card title="GitHub" icon="github" href="https://app.hops.ai/my-hops/connections">
    Release tags and merged pull requests.
  </Card>

  <Card title="Linear" icon="plug" href="https://app.hops.ai/my-hops/connections">
    Tickets linked to each change (or Jira).
  </Card>

  <Card title="Jira" icon="jira" href="https://app.hops.ai/my-hops/connections">
    Tickets linked to each change (or Linear).
  </Card>

  <Card title="Slack" icon="slack" href="https://app.hops.ai/my-hops/connections">
    Where the draft is posted for review.
  </Card>
</CardGroup>

## Set it up

<Steps>
  <Step title="Connect your apps">
    Connect GitHub, Linear or Jira, and Slack in **Connections**.

    See [Connections](/docs/connections/overview).
  </Step>

  <Step title="Create the Space">
    Create a **product-eng** Space and pin your release-notes style guide in Space context.

    See [Spaces](/docs/spaces/overview) and [Space context](/docs/spaces/space-context).
  </Step>

  <Step title="Add the skill">
    Give Hops these instructions:

    ```text theme={null}
    You 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](/docs/agents/build-a-skill).
  </Step>

  <Step title="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](/docs/spaces/automation).
  </Step>
</Steps>


## Related topics

- [Product & Engineering](/teams/product-engineering.md)
- [Explore use cases](/use-cases/overview.md)
- [Build a skill](/agents/build-a-skill.md)
- [Skills](/agents/skills.md)
- [Ship announcements](/teams/product-engineering/use-cases/ship-announcements.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.