Skip to content

Generate release notes from completed tickets

Turn a set of completed tickets into a clear release note for your users. Docs Agent reads each ticket’s title, description, and comments, then rewrites the work in plain language, without copying internal shorthand from the tickets. It groups the work into sections such as Features and Bug Fixes, then opens a pull request you can review before publishing.

To produce release notes on a schedule instead, see Automate release notes.

You need:

  • An EkLine account with Docs Agent enabled.
  • At least one repository connected to EkLine.
  • A connected ticket source. Docs Agent generates release notes from Linear or Jira. Connect one under Settings > Integrations (see Integrations).
  • The ticket identifiers you want to include, such as ENG-100 through ENG-110, or a milestone or release name the agent can look up.
  1. Sign in to the EkLine app and click New session in the sidebar. If the composer shows Docs and Marketing, select Docs.

  2. In the chat panel, describe the release. Name the tickets, the output sections, and the audience:

    Generate release notes for v2.1 from Linear tickets ENG-100
    through ENG-110. Group them under Features, Improvements, and
    Bug Fixes. Write for end users, one sentence per item.
  3. Wait while the agent reads each ticket and drafts the release note in the editor panel.

  4. Review the draft. Ask the agent to refine anything that reads inaccurately, for example Move the rate-limiting change under Improvements or Rewrite the SSO item without internal jargon.

The Docs Agent chat panel with a release-notes prompt that names a ticket range and the output sections

Tell the agent how to group and order entries so the release note matches your existing format.

Generate release notes for the tickets in the "1.4" milestone.
Group them under Features, Improvements, and Bug Fixes. Within
each group, list the most impactful change first.

Before you publish, confirm the draft is accurate and complete.

  1. Enable View All Changes in the toolbar to see a diff of what the agent wrote.

  2. Check that every ticket you named appears, and that no internal-only tickets slipped in.

  3. Confirm version numbers, dates, and section headings match your convention.

When the draft is ready:

  1. Click Raise PR in the toolbar. The chat box fills with Open a pull request for and your repository’s name.

  2. Edit the prompt if you want to add instructions, then press Enter.

  3. The agent opens the pull request and replies in the chat with a link so you can finish the review on GitHub.

To add a late-arriving ticket after the PR is open, ask the agent for the change, then click Update PR to push it to the same branch.

To generate release notes on a schedule instead of on demand, turn on the Release Notes Generator template in Automations. It drafts structured release notes from tickets and GitHub activity since the release notes were last updated, and delivers them as a pull request, a Slack message, or both.

ProblemCauseFix
The agent can’t find a ticketThe ticket source isn’t connected, or the identifier is wrongConnect Linear or Jira under Settings > Integrations, then confirm the ticket key and project.
Entries read like internal commit messagesThe prompt didn’t set an audienceAdd "Write for end users" and ask the agent to rewrite items in plain language.
A ticket is missing from the draftIt fell outside the range or milestone you namedName the ticket explicitly, or widen the range: "Also include ENG-118".
Sections are in the wrong orderThe default grouping doesn’t match your formatSpecify the sections and their order in the prompt, or point the agent at an existing changelog file to match.

Built on Potluck Docs, our open source template.