Skip to main content

Generate AI release notes for a production release

How to create shareable release notes before or after deployment.

Written by Jacob Joshua

Gearset can use AI to draft release notes for a production release, before or after you deploy it. The notes are built from the release’s pull requests and linked tickets, and explain what each change means for end users, not just which pull requests went out.

You can use them to tell stakeholders what’s coming or what’s just shipped, for example in Slack, Teams, or email.

Before you start

Release notes need two AI settings turned on under Team access:

  • AI features for Salesforce metadata

  • AI features for external services

If either is off, Gearset prompts you to turn it on when you open release notes.

These apply to your whole team, so only a Gearset team owner can turn them on. You can enable them under Feature access.

Generate release notes

  1. Open the production release in Pipelines.

  2. Select Generate release notes.

  3. Wait while Gearset generates the notes and displays its progress.

  4. Review the notes, then select Copy to copy them as Markdown. Edit them as needed before sharing.

    You can also generate release notes from the Features tab.

What do the notes use?

Gearset drafts the notes from:

  • The title and description of each pull request in the release

  • The title and description of each linked ticket in Jira, Azure DevOps, or Linear

Important to know

  • Notes aren’t saved to release or deployment history, so copy them to keep them.

  • If you close the window, you can reopen the notes for five minutes. After that, generate them again.

  • Each generation can produce different wording.

  • Review the notes for accuracy before sharing.

Did this answer your question?