Commons

Operations

We support currently 4 grammars:

  • MANU
  • REMY
  • BUGZILLA
  • ALL
all with the same operations. The operations are NOT case sensitive.
  • add: when you add a new feature or some code to your projet.
  • remove: when you remove a feature or some code from your projet.
  • update: when you update a feature or some code in your projet.
  • fix: when you fixe a feature or some code in your projet.

What about the issue id?

Well it is quite simple, each bug tracker is associated with a pattern. When an issue id is provided (which is optionnal) we use the pattern to link the entry to the tracker.

What about comments?

You can comment part of the SCM messages using /* my comments */.
For instance, 

Now /*from version 1.3*/ you can comment some part of the commit message
only this message will be added in the Change Log Report. 
Now you can comment some part of the commit message

Comments are not inclusive.
For instance 

Now /*from version 1.3 /*still hidden message but*/ (not hidden message) */ you can comment 
        some part of the commit message
this message will be added in the Change Log Report. 
Now (not hidden message) */ you can comment some part of the commit message

Look at RemoveCommentsTest unit test for further details.

Grammars

MANU

The MANU grammar uses the pattern:

@operation:${issueId};
So for example, to link to the bug MSCMCHGLOG-7 and you would have:

@update:MSCMCHGLOG-7;The documentation has been updated.

If you don't have a issue id but still want to add an entry you could use the following comment: 

@fix:;The url to the JIRA tracker has been fixed.

It's also possible to add several entries. You just have to add one entry by line as described in the following comment: 

@update:MSCMCHGLOG-7;The documentation has been updated.
@fix:;The url to the JIRA tracker has been fixed.

REMY

The REMY grammar uses the pattern: 

[operation:${issueId}]
So for example, to link to the bug MSCMCHGLOG-7 and you would have:

[update:MSCMCHGLOG-7]The documentation has been updated.

If you don't have a issue id but still want to add an entry you could use the following comment: 

[fix:]The url to the JIRA tracker has been fixed.

It's also possible to add several entries. You just have to add one entry by line as described in the following comment: 

[update:MSCMCHGLOG-7]The documentation has been updated.
[fix:]The url to the JIRA tracker has been fixed.

BUGZILLA

The BUGZILLA grammar implements Bugzilla's autolinkification feature, automatically recognizing bug references of the form:

bug 42: The documentation has been updated.

This grammar does not allow the plugin to distinguish between the various operations, so they will all be marked in the report as "fix".

ALL

The ALL grammar implements accept all comments and doesn't recognize bug references of the form:

The documentation has been updated.

This grammar does not allow the plugin to distinguish between the various operations, so they will all be marked in the report as "fix".