The Merge Branches Comment Template allows an administrator to customize the contents of comments generated by Merge Branches.
The template has four sections for comments and three categories of template (placeholder) fields. When you add a template field into a comment section, the template will generate a Merge Branches comment with the actual value of the template field.
For example, if you place [ORIGIN_FOLDER] in the Changeset Header section, the resulting Merge Branches comment will contain the the repository path of the Origin Folder within Merge Branches (e.g. $/main/src/project.) If you wish to use any of the actual keywords within a comment, the keyword must be escaped with "\" (backslash). For example, \[ORIGIN_FOLDER] will expand to [ORIGIN_FOLDER].
In addition to the field templates, free-form text comments can be added in each of the sections. Also, on the Vault Standard Client side, a user can add comments at the end of a Merge Branches operation. Each Merge Branches Comment Template Designer section allows up to 4000 characters for comments.
Comment Template Designer sections include:
The Changeset Header section will expand General Fields. The default is: Merge Branches : Origin=[ORIGIN_FOLDER]
The Changeset Body will expand Changeset and General Fields. The default is: Version: [CS_VERSION] [CS_COMMENT]
The Changeset Footer will expand General Fields.
The Changeset Item Body will expand all fields. This section is a placeholder for text that will be placed in a specific Changeset Item's comment during a run of Merge Branches.
When this is checked, Merge Branches will add a step in which the user can modify the template before comments are generated. These template changes by the user are not saved for future merge branches operations. The "Display template at runtime" checkbox will allow an end user to review and make "non-savable" changes to the template from within Merge Branches. If this option is unchecked, users cannot review the template before comments are generated. The generated comments will contain the default data listed in the Changeset fields above.
Merge Branches templates for General Fields include:
The range of the Origin Folder's historical revision dates (e.g. Feb. 1, 2013 – Feb 28, 2013)
The repository path of the Origin Folder within Merge Branches (e.g. $/main/src/project)
The repository path of the Target Folder within Merge Branches (e.g. $/develop/src/project)
A list containing the range of the Origin Folder's historical revision users (e.g. user_a, user_b, and user_c)
A list containing the range of the Origin Folder's historical revision versions (e.g. 128-129)
Merge Branches templates for Changeset Fields include:
The comment of the changeset selected in Merge Branches which is used to generate a merge change (e.g. "Modified some files to fix bug")
The date of the changeset that Merge Branches used to generate a merge change (e.g. Feb 13, 2013)
The user who committed the changeset that Merge Branches used to generate a merge change (e.g. user_b)
The version of the folder of the changeset selected in Merge Branches Changeset Item Fields
Merge Branches templates for Changeset Item Fields include:
The changeset item's action that Merge Branches used to generate a merge change (ex: Checked In)
The changeset item's comment that Merge Branches used to generate a merge change (e.g. "Fixed pointer issue within fileops.cpp")
The changeset item's original path that Merge Branches used to generate a merge change (e.g. $/main/src/project/libs/fileops.cpp)
The changeset item's version that Merge Branches used to generate a merge changeset item (e.g. 27)
The changeset item's comment or if empty, the comment of the changeset that Merge Branches used to generate a merge change (e.g. "Fixed pointer issue within fileops.cpp", but would be "Modified some files to fix bug" if the actual Changeset Item was blank)
See Vault Standard Client Help for details on how templates are implemented within a Merge Branches operation.