History | Log In     View a printable version of the current page.  
Issue Details (XML | Word | Printable)

Key: IDEABKL-5215
Type: New Feature New Feature
Status: Open Open
Priority: Normal Normal
Assignee: Unassigned
Reporter: Mike Hogan
Votes: 0
Watchers: 2
Available Workflow Actions

Mark as Stalled
Operations

If you were logged in you would be able to see more operations.
IDEA: Backlog

Allow different sections in commit messages so decent release notes can be generates

Created: 29 Aug 07 12:31   Updated: 13 Feb 08 14:10
Component/s: Version Control Integration
Affects Version/s: None
Fix Version/s: None

Original Estimate: Unknown Remaining Estimate: Unknown Time Spent: Unknown

Build: 7


 Description  « Hide
Hi,

I would like to able to specify an arbitrary number of "sections" for my commit messages, and have a text box appear for each section. When the commit actually happens to the VCS, the text from each of the text boxes is concatenated, but bounded by xml tags that name the section. If not xml tags, then maybe the name of the section bracket by [ and ].

Here is the use case i have in mind.

I am checking in some code. Some of the changes i have made change the api of the code. so i want to communicate that change to the rest of the developers. So I type the following text into the "developers" text box:

"It is now possible to locate resources on the classpath by prefixing the resource name with the string classpath:"

The changes I have made also affect the user experience, so the documentation writers and business analysts need to know about that. So I type the following text into the "user experience" box:

"Failed login attempts are now counted, and three failed attempts in a row cause the account to be locked".

The changes i have made also affect the way the app needs to be deployed, so I write the following text into the "deployment" text area:

"The app needs a cert in jks format available on the classpath in a file names cert.jks".

When the commit happens, the commit message text is:

[developers]It is now possible to locate resources on the classpath by prefixing the resource name with the string classpath:[/developers]
[user experience]Failed login attempts are now counted, and three failed attempts in a row cause the account to be locked[/user experience]
[deployment]The app needs a cert in jks format available on the classpath in a file names cert.jks[/deployment]

Now I can write scripts to trawl the commit messages between two revisions and compile notes for the developers, doc writers/business analysts and system admin people.

This is just one possible use of a means to section commit messages of course



 All   Comments   Work Log   Change History      Sort Order:
Dmitry Jemerov - 29 Aug 07 13:22
This workflow looks very much specific to your organization, and I don't think that supporting it as a general IDEA feature is a good idea. You can write a third-party plugin that would integrate with the checkin dialog and provide necessary UI and commit message formatting.

Mike Hogan - 29 Aug 07 13:35
That workflow is just an example and is in actual fact entirely fictional. I was just trying to illustrate the requirement by way of example

Dmitry Jemerov - 29 Aug 07 13:39
Nevertheless, I haven't heard of any project that divides commit messages into sections in a similar way.

Arik Kfir - 13 Feb 08 14:10
There is, however, a related use-case that is quite common in Eclipse, and IMO pretty useful; in Eclipse, you can specify a different commit-message per-file (in the same change-set), and Eclipse concatenates them into a single message.

I can envision a two radio-buttons in the commit window saying "Global commit message" vs. "Per-file commit messages"