[ACCEPTED]-How do you generate release notes?-continuous-integration

Accepted answer
Score: 21

Generally this sort of thing is done by 4 issue tracking software. You track every 3 new feature, every bugfix and every enhancement, assign 2 them to a release and then generate release 1 notes from the descriptions.

Score: 8

If you are using maven, there is a the maven changes plugin for 3 this purpose and producing this report could 2 thus be easily automated in an continuous 1 integration process.

Score: 4

If you use JIRA (which I'd suggest any way), it can auto-generate the release notes for you. The built-in format is rather 5 simplistic, but works well in many cases. The 4 content is customizable to a point, albeit 3 this is not the ultimate word in terms of 2 flexibility.

If you look for better release 1 notes from JIRA, try the PDF View Plugin. It:

  • more than just a raw "completed issues" list (ex: installation and upgrade instructions, legal details, executed tests, changed files)
  • more control over what is included (excluding certain statuses, resolutions, issue types, etc.)
  • allows distributing your Release Notes document in email (PDF format) or printed on paper

Disclaimer: I'm a a developer of this commercial JIRA add-on.

enter image description here

Score: 2

I am wrestling with the same problems. In 35 our development we use svn/jira and we have 34 a custom tool that will attempt to build 33 and sanity test changes before they are 32 committed - and the develop enters the jira 31 number as part of that process (it validates 30 the number). This jira number is then included 29 in the SVN commit

From then we generate a 28 release note between two points in svn and 27 from the comments on each commit can build 26 a list of issues that have been committed 25 and populate the release note.

The problem 24 with this is that 1. issues in the release 23 note need to be entered as code changes. Issues 22 fixed without a code change are not included. 2. If 21 a developer is half way through a fix it 20 will appear in the release notes when may 19 it should not.

I want to find a solution 18 with minimal manual overhead where we can 17 take any build from our CI system and turn 16 it into a release.

I am considering adapting 15 the process so that the release note generate 14 will fail if a issue is not closed - but 13 feel the developers will complain that they 12 might be half way though an issue when we 11 want to make a release.

The other option 10 is to only include completed issues in the 9 release note. However the problem with that 8 is that if a developer make a fix in release 7 A but did not close the issue at the time 6 A was release - and then made no code changes 5 and closed the issue after A was released 4 how do I now automatically include this 3 issue in the release notes (May be I could 2 search all jiras closed between release 1 A and B....)

Thank you for reading

Score: 1

In my company we use bugzilla. We use the 13 milestone to tag a bug with a specific release 12 number. Then we generate an xml report 11 for all the bugs with a specific milestone 10 and we use a small script to generate the 9 release notes out of it.

This is something 8 that can be easily generalized to any bug 7 tracking software, in general.

I guess it 6 could also be tied to comments in the commit 5 messages on your version control system. A 4 query could be made to list all comments 3 on the commits on verson control and then 2 filter for all of the comments with a specific 1 tag.

Score: 1

Assuming the developers are not privateers 17 and are part of a team that gets assignments 16 and does them, a list of what was done and 15 should be part of UAT is the defacto release 14 note. Lists of file changes and the like 13 are irrelevant and can be trivially extracted 12 from source control.

Since it is painfully 11 hard to enforce a policy of developers checking 10 in code with issue numbers in it, I don't 9 bother. I ask about it at the code review. I 8 also keep a list of what we are working 7 on. The stuff that is done-done gets added 6 to the log right before the mvn release:prepare 5 commands are run. I then walk it over to 4 the QA and UAT.

This is not likely to scale 3 to hundreds of issues per week. In those 2 cases, a more robust system is likely to 1 be preferable.

Score: 0

You could use a tool like doxygen to do 4 this, but it's kind of tedious to comment 3 the way doxygen expects. I usually get 2 these by hand.

Not sure, but wouldn't something 1 like FogBugz also do this?

Score: 0

For those working with .NET and TFS, you 21 could use TfsChangeLog to automatically generate your 20 release notes.

TFS ChangeLog allows Team 19 Foundation Server (TFS) users to extract 18 information related to Changesets and associated 17 WorkItems into XML format that is transformed 16 into HTML. TFSChangeLog automatically 15 produces Change Log / Release Notes based 14 on selected changeset range.

TFS holds file 13 version history via registered changesets 12 and associated WorkItems. This exact information 11 will be used for generating release notes. Configuration 10 / Release manager can either use system 9 data fields or custom fields for the purpose 8 of generating release notes contents. Powerful 7 XSLT 2.0 support for transforming data from 6 raw XML format is provided out of the box 5 which certainly opens up possibility to 4 generate data in various formats. Support 3 for XSLT 2.0 makes it very easy to apply 2 filtering conditions for transformations 1 output as required by the users.

Score: 0

I faced a similar problem recently and enhanced 4 an existing maven plugin to do this.

If you 3 use Git for source control and build your 2 project using Maven, then this may be a 1 good solution: https://github.com/pankajtandon/maven-git-commit-id-plugin#releasenotes

More Related questions