Feature #8689

Consider building the changelog from changes files provided by the merged branches

Added by intrigeri about 5 years ago. Updated 6 months ago.

Target version:
Start date:
Due date:
% Done:


Feature Branch:
Type of work:
Affected tool:


... just like they do it for Tor. This would make the release process shorter by pushing to branch submitters the responsibility to write good changelog entries. It would also be needed to go further on the continuous integration path (releasing stuff automatically).

If we go this way, we could even request two different pieces of text:

  • a changelog snippet
  • a release notes snippet, if the changes warrant being mentioned there

=> our doc writers could review and improve the release notes incrementally during a dev cycle, instead of doing it in one go at release time (which is a blocking synchronization point right now).

The relationship between this and the process of writing the release notes was discussed on One should re-read this discussion before starting work on this ticket, but IIRC the summary is that the release notes draft, once automatically assembled from the snippets at RC time, can be published on a blueprint that anyone can help improve (even if they're not at ease with Git).

Prior art

We're not the first ones to have this kind of problems and consider this sort of solutions:


#1 Updated by sajolida about 5 years ago

If we go this way, then the section "Documentation is not optional" should be adapted to make explain the additional requirements.

#2 Updated by sajolida over 4 years ago

  • Assignee set to bertagaz

#3 Updated by sajolida over 4 years ago

  • Target version changed from Sustainability_M1 to 2016

#4 Updated by anonym about 4 years ago

If implemented, for bugfixes we should mandate that the changelog entry includes "bugfix on $version_that_introduced_the_bug" when relevant.

#5 Updated by intrigeri about 4 years ago provides a workflow and tools to handle that.

#6 Updated by Dr_Whax over 3 years ago

  • Assignee deleted (bertagaz)
  • Priority changed from Normal to Elevated
  • Target version deleted (2016)

#7 Updated by intrigeri over 3 years ago

  • Description updated (diff)

#8 Updated by intrigeri 7 months ago

  • Category deleted (Continuous Integration)

#9 Updated by intrigeri 6 months ago

  • Description updated (diff)

Also available in: Atom PDF