Jira integration - Add option to change comment template
Problem to solve
Jira integration is creating comments inside Jira. In the docs the template is like this:
USER mentioned this issue in RESOURCE_NAME of [PROJECT_NAME|LINK_TO_COMMENT]:
ENTITY_TITLE
I propose to have this template editable from Jira integration view so that users can change it for their specific needs. For example by including whole commit message and not just a commit title.
Intended users
- Sasha (Software Developer)
- Devon (DevOps Engineer)
- Delaney (Development Team Lead)
- Sidney (Systems Administrator)
Further details
There is an open MR !19004 (merged) which just adds option to include git commit title in the comment or not.
But this proposal would give users ability to modify it for their specific use case. Our company just switched from SVN to GIT hosted on self-hosted gitlab instance. Before we had to manually copy commit messages from SVN to jira, which was totally cumbersome. Now when we switched to gitlab, we have automatic comments, when we include jira ticket no. into the commit message. However we just have links and title. We would like to have whole commit message visible, so that our QA can look at the whole picture what was changed and why in all commits related to that jira ticket.
Proposal
I propose to add new text field in Jira Integration view, which would add user ability to change default comment template which are created on every commit into gitlab inside jira ticket which was mentioned in that commit. Also there are few variables that can be used inside this template and I propose to add new variable which would include whole commit message text.
Permissions and Security
I think only project administrators (maintainers) can change project integration settings. So for them.
Documentation
Docs will need to be updated, so that users know how to fill this new template.
Testing
I think there needs to be good validation on this new textbox, because when someone misplaces some variable it would show wrong text inside jira. There is a test button for saving this Jira integration view. Maybe this change would require to have separate test button and save button, so that users can test their new template.
What does success look like, and how can we measure that?
Change inside Jira Integration view will be visible and actionable.
What is the type of buyer?
Because Jira Integration is available in the free edition, I would add this to the free edition.