Skip to main content

Automating release notes

Updated over 2 months ago

Automate Your Release Notes with Solo

Keeping your customers in the loop about new features, improvements, and bug fixes is a fantastic way to build trust and excitement. Release notes are the perfect tool for this, but creating them can be time-consuming. With Solo, you can automate the entire process, turning complex code changes into clear, easy-to-understand updates for your audience.


How Solo Generates Release Notes

Solo takes the manual work out of writing release notes by intelligently analyzing your product's development activity.

  1. Connects to Your Code: Solo links directly to your company's code repositories.

  2. Analyzes Changes: When a release note is created, Solo reviews all the code changes that occurred between the specified start and end dates.

  3. Writes Human-Friendly Updates: Using the information from the code changes, Solo automatically generates a summary of what's new. It's designed to be understood by everyone, not just engineers.

You can also customize the voice and template of your release notes in your account settings to ensure they always match your company's brand and style.


Schedule Automated Release Notes

Set up a schedule once, and let Solo handle the rest. You can have fresh release notes generated automatically without lifting a finger.

To set up a schedule:

  1. Navigate to the Release Notes section.

  2. Open the release notes schedule settings.

  3. Choose a Start Date for when you want your first automated release note to be created.

  4. Select a Frequency from the following options:

    • Weekly

    • Every two weeks

    • Every three weeks

    • Monthly

Once saved, Solo will automatically create a new release note for you based on your chosen schedule.


Create a Manual Release Note

Need to create a release note outside of your regular schedule? You can do so at any time.

  1. From the Release Notes page, select the option to create a new release note.

  2. You can specify a start date. If you don't, the system will automatically use the end date of your most recent release note as the start date.

  3. After creating the note, you can generate its content. If you don't generate it manually, Solo will automatically generate it for you.

Did this answer your question?