Automate release notes generation with Rovo
5 min
By the end of this lesson, you’ll be able to:
- Use Rovo to automatically generate structured, accurate release notes
- Simplify release documentation and communication
- Save time and reduce manual effort in your release process
Automate and customize release notes with Rovo
👉 Our scenario: A software development team is preparing to release a new version of their application, version 3.0.
To increase efficiency, Pearl, the release manager, decides to use Rovo, specifically the release notes drafter agent. This saves time by eliminating manual documentation tasks and ensuring that every release is accompanied by clear, consistent, and accurate updates. With Rovo, teams can quickly communicate changes to stakeholders, reduce human error, and maintain a reliable record of product evolution with minimal effort.
Rovo's release notes drafter agent provides a practical solution for teams looking to simplify and enhance their release note generation process.
Generate release notes with Rovo
Pearl, the release manager, has to generate the release notes for version 3.0 of the software application, summarizing key updates, improvements, and significant changes. These notes are vital for informing users and stakeholders about the new version's enhancements to functionality and user experience.
👇Click the boxes below to learn how to generate release notes with Rovo.
Automate the release notes generation
To streamline the process of generating release notes, Pearl implements an automation that triggers the release notes drafter agent each time a version is released in the Platform development project. The resulting notes are then published on a Confluence page, which is distributed to stakeholders to ensure they receive timely updates.
To set up the automation:
- Pearl creates a new rule in the Automation section in the Platform development project.
- She chooses the trigger Version Released.
- She selects the action Use Rovo Agent and sets the agent to Release Notes Drafter.
- She adds the prompt: Generate release notes for this released version.
- She chooses the action Publish a new page in Confluence and sets the space to Platform development.
- She sets the parent page to the Release Notes page in the Platform development space.
- For the page title, she uses the version name followed by Release Notes: {{version.name}} Release Notes
- In the body of the page, she includes the output from the Release Notes Drafter Agent: {{AgentResponse}}.
- She turns on the automation rule and adds a descriptive name.
- After saving the rule, she tests it by releasing a version in the Platform development project to ensure that the automation works as expected and the page is created with the correct title and content.
👇 Here’s how the automation rule will look.
Best practices for using Rovo to generate release notes
The following best practices will help ensure Rovo generates accurate, comprehensive release notes:
- Close all relevant Jira work items: This step ensures that all work items associated with the release are properly finalized and documented. By closing these work items, you can confirm that no outstanding tasks will affect the release notes.
- Merge pull requests that are intended for the release: This is critical as it consolidates all changes and updates into the main codebase. This action not only facilitates a smoother release but also ensures that all new features and fixes are included in the final product.
- Tag work items and pull requests with the release version: This is vital for easy filtering and tracking. By associating each work item and pull request with the specific release version, you create a clear reference point that simplifies the process of generating release notes.
By adhering to these steps, you can ensure that Rovo produces accurate and effective release notes that reflect the work completed in each release cycle.