Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
6843d89f
Commit
6843d89f
authored
May 17, 2021
by
Andy Soiron
Committed by
Amy Qualls
May 17, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Docs: Add smart commit examples to Jira DVCS page
parent
2c3038c8
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
25 additions
and
3 deletions
+25
-3
doc/integration/jira/dvcs.md
doc/integration/jira/dvcs.md
+25
-3
No files found.
doc/integration/jira/dvcs.md
View file @
6843d89f
...
@@ -18,7 +18,7 @@ are accessible.
...
@@ -18,7 +18,7 @@ are accessible.
-
**Jira Cloud**
: Your instance must be accessible through the internet.
-
**Jira Cloud**
: Your instance must be accessible through the internet.
-
**Jira Server**
: Your network must allow access to your instance.
-
**Jira Server**
: Your network must allow access to your instance.
## Smart
c
ommits
## Smart
C
ommits
When connecting GitLab with Jira with DVCS, you can process your Jira issues using
When connecting GitLab with Jira with DVCS, you can process your Jira issues using
special commands, called
special commands, called
...
@@ -31,12 +31,34 @@ in your commit messages. With Smart Commits, you can:
...
@@ -31,12 +31,34 @@ in your commit messages. With Smart Commits, you can:
Commands must be in the first line of the commit message. The
Commands must be in the first line of the commit message. The
[
Jira Software documentation
](
https://support.atlassian.com/jira-software-cloud/docs/process-issues-with-smart-commits/
)
[
Jira Software documentation
](
https://support.atlassian.com/jira-software-cloud/docs/process-issues-with-smart-commits/
)
contains more information about how
smart c
ommits work, and what commands are available
contains more information about how
Smart C
ommits work, and what commands are available
for your use.
for your use.
For
smart c
ommits to work, the committing user on GitLab must have a corresponding
For
Smart C
ommits to work, the committing user on GitLab must have a corresponding
user on Jira with the same email address or username.
user on Jira with the same email address or username.
### Smart Commit syntax
Smart Commits should follow the pattern of:
```
plaintext
<ISSUE_KEY> <ignored text> #<command> <optional command parameters>
```
Some examples:
-
Adding a comment to a Jira issue:
`KEY-123 fixes a bug #comment Bug is fixed.`
-
Recording time tracking:
`KEY-123 #time 2w 4d 10h 52m Tracking work time.`
-
Closing an issue:
`KEY-123 #close Closing issue`
A Smart Commit message must not span more than one line (no carriage returns) but
you can still perform multiple actions in a single commit:
-
Time tracking, commenting, and transitioning to
**Closed**
:
`KEY-123 #time 2d 5h #comment Task completed ahead of schedule #close`
.
-
Commenting, transitioning to
**In-progress**
, and time tracking:
`KEY-123 #comment started working on the issue #in-progress #time 12d 5h`
.
## Configure a GitLab application for DVCS
## Configure a GitLab application for DVCS
We recommend you create and use a
`jira`
user in GitLab, and use the account only
We recommend you create and use a
`jira`
user in GitLab, and use the account only
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment