Comment templates
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
History
With comment templates, create and reuse text for any text area in:
- Merge requests, including diffs.
- Issues, including design management comments.
- Epics.
- Work items.
Comment templates can be small, like approving a merge request and unassigning yourself from it, or large, like chunks of boilerplate text you use frequently:
Use comment templates in a text area
To include the text of a comment template in your comment:
- In the editor toolbar for your comment, select Comment templates ( ).
- Select your desired comment template.
Create comment templates
You can create comment templates for your own use, or to share with all members of a group.
To create a comment template for your own use:
- On the left sidebar, select your avatar.
- From the dropdown list, select Preferences.
- On the left sidebar, select Comment templates ( ).
- Select Add new.
- Provide a Name for your comment template.
- Enter the Content of your reply. You can use any formatting you use in other GitLab text areas.
- Select Save, and the page reloads with your comment template shown.
For a group
- Tier: Premium, Ultimate
To create a comment template shared with all members of a group:
- In the editor toolbar for a comment, select Comment templates ( ), then select Manage group comment templates.
- Select Add new.
- Provide a Name for your comment template.
- Enter the Content of your reply. You can use any formatting you use in other GitLab text areas.
- Select Save, and the page reloads with your comment template shown.
For a project
- Tier: Premium, Ultimate
To create a comment template shared with all members of a project:
- In the editor toolbar for a comment, select Comment templates ( ), then select Manage project comment templates.
- Select Add new.
- Provide a Name for your comment template.
- Enter the Content of your reply. You can use any formatting you use in other GitLab text areas.
- Select Save, and the page reloads with your comment template shown.
View comment templates
To see existing comment templates:
- On the left sidebar, select your avatar.
- From the dropdown list, select Preferences.
- On the left sidebar, select Comment templates ( ).
- Scroll to Comment templates.
For a group
- Tier: Premium, Ultimate
- In the editor toolbar for a comment, select Comment templates ( ).
- Select Manage group comment templates.
For a project
- Tier: Premium, Ultimate
- In the editor toolbar for a comment, select Comment templates ( ).
- Select Manage project comment templates.
Edit or delete comment templates
To edit or delete an existing comment template:
- On the left sidebar, select your avatar.
- From the dropdown list, select Preferences.
- On the left sidebar, select Comment templates ( ).
- Scroll to Comment templates, and identify the comment template you want to edit.
- To edit, select Edit ( ).
- To delete, select Delete ( ), then select Delete again on the dialog.
For a group
- Tier: Premium, Ultimate
- In the editor toolbar for a comment, select Comment templates ( ), then select Manage group comment templates.
- To edit, select Edit ( ).
- To delete, select Delete ( ), then select Delete again on the dialog.
For a project
- Tier: Premium, Ultimate
- In the editor toolbar for a comment, select Comment templates ( ), then select Manage project comment templates.
- To edit, select Edit ( ).
- To delete, select Delete ( ), then select Delete again on the dialog.