From c53aad315f89e0eaa44ab680d0b79f38c4590083 Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Mon, 25 Jan 2016 22:17:41 +0100 Subject: Add proper screenshot and comment on the output [ci skip] --- doc/project_services/img/jira_issue_closed.png | Bin 0 -> 92601 bytes doc/project_services/img/jira_issues_workflow.png | Bin 104791 -> 105237 bytes doc/project_services/jira.md | 19 ++++++++++++++----- 3 files changed, 14 insertions(+), 5 deletions(-) create mode 100644 doc/project_services/img/jira_issue_closed.png diff --git a/doc/project_services/img/jira_issue_closed.png b/doc/project_services/img/jira_issue_closed.png new file mode 100644 index 00000000000..cabec1ae137 Binary files /dev/null and b/doc/project_services/img/jira_issue_closed.png differ diff --git a/doc/project_services/img/jira_issues_workflow.png b/doc/project_services/img/jira_issues_workflow.png index 51a1bc10210..28e17be3a84 100644 Binary files a/doc/project_services/img/jira_issues_workflow.png and b/doc/project_services/img/jira_issues_workflow.png differ diff --git a/doc/project_services/jira.md b/doc/project_services/jira.md index 2ade54aeaf8..b82e4857814 100644 --- a/doc/project_services/jira.md +++ b/doc/project_services/jira.md @@ -167,9 +167,10 @@ Where: ### Closing JIRA issues JIRA issues can be closed directly from GitLab by using trigger words in -commits and merge requests. When a commit, which contains the trigger word -followed by the JIRA issue ID in the commit message, is pushed, GitLab will -add a comment in the mentioned JIRA issue and immediately close it. +commits and merge requests. When a commit which contains the trigger word +followed by the JIRA issue ID in the commit message is pushed, GitLab will +add a comment in the mentioned JIRA issue and immediately close it (provided +the transition ID was set up correctly). There are currently three trigger words, and you can use either one to achieve the same goal: @@ -187,7 +188,7 @@ in GitLab. The workflow would be something like this: 1. Create a new branch 1. Fix the bug -1. Commit the changes and push back to GitLab +1. Commit the changes and push branch to GitLab 1. Open a new merge request and reference the JIRA issue including one of the trigger words, e.g.: `Fixes GITLAB-1`, in the description 1. Submit the merge request @@ -207,9 +208,17 @@ issue look like. Once this merge request is merged, the JIRA issue will be automatically closed with a link to the commit that resolved the issue. -![The GitLab integration user leaves a comment on JIRA](img/jira_service_close_issue.png) +![The GitLab integration user leaves a comment on JIRA](img/jira_issue_closed.png) --- +You can see from the above image that there are four references to GitLab: + +- The first is from a comment in a specific commit +- The second one is from the JIRA issue reference in the merge request + description +- The third is from the actual commit that solved the issue +- And the fourth one is from the commit that the merge request created + [services-templates]: ../project_services/services_templates.md "Services templates documentation" [JIRA Core]: https://www.atlassian.com/software/jira/core "The JIRA Core website" -- cgit v1.2.1