w32blaster / revizor

Revizor - the code review tool.
http://revizor.reviews
GNU General Public License v2.0
5 stars 1 forks source link

Add "Release notes" functionality #1

Open w32blaster opened 10 years ago

w32blaster commented 10 years ago

Problem

Every team uses any broadband messages to notify users about new features in a project. Usually it is a simple email message containing the list of new features added to a product. But this kind of notes are done for users, customers and other non-technical people and it is often bad idea to include some code-specific information to these emails.

Solution

There should be any page, that would allow to generate release notes for developers. Many release masters put tags to a Control Version System to mark commits where the release was taken. The "Release Notes" page should retrieve the list of all the tags in Git/Mercurial and user could select one tag for a release. The "Release Notes" will generate a nice looking view page wish all the tasks and links to the code reviews that would be easy to navigate change sets.

Preliminary workflow

  1. User specifies the tag name
  2. "Release Notes" retrieves all the commits between this tag and previous one (could be also specified)
  3. "Release Notes" scans all the commit messages and extracts a issue tracker tickets
  4. "Release Notes" builds the list of all the collected issue task. Next to each item it places two links: to the code review page and to the issue ticket
  5. Each list item could be expandable: when you click to "+" sign, under the line it prints the sub-list of all the commit messages related to specified issue.