Skip to content

Release Notes Overview

Release notes are generated from the Git history, relying on Git branch names containing valid ticket numbers.

Example

feature/PPT-25-make-useless-feature

feature/#142-make-useless-feature

Release notes are then built by looking at all the merge commits between the currently checked out version and the first tag matching a given pattern.

The recommended approach is to create a new tag at the start of each sprint / release version to drive the release notes.

Example

%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showCommitLabel': false, 'mainBranchName': 'develop'}} }%%
    gitGraph
       commit
       commit
       branch feature-PPT-25
       commit
       checkout develop
       merge feature-PPT-25
       commit
       commit tag: "start-changelog-v1.0"
       commit
       branch feature-PPT-26
       commit
       checkout develop
       merge feature-PPT-26
       branch feature-PPT-27
       commit
       checkout develop
       merge feature-PPT-27
       commit type: HIGHLIGHT

Only the following will be included in release notes:

  • PPT-26
  • PPT-27

An alternative approach would be to always use the last release tag, but this is less flexible if multiple streams of work are ongoing.

Back to top