Create
cancel
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in
Deleted user
Level
0 / 0 points
Next:
badges earned

Your Points Tracker
Challenges
Leaderboard
  • Global
  • Feed

Badge for your thoughts?

You're enrolled in our new beta rewards program. Join our group to get the inside scoop and share your feedback.

Join group
Recognition
Give the gift of kudos
You have 0 kudos available to give
Who do you want to recognize?
Why do you want to recognize them?
Kudos
Great job appreciating your peers!
Check back soon to give more kudos.

Past Kudos Given
No kudos given
You haven't given any kudos yet. Share the love above and you'll see it here.

It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

automatically append JIRA issue ID into commit message

I wonder whether it is possibel to automatically append the JIRA issue ID to every commit message automatically?

All our branch names include the issue id with the issue type name.

Is there a way to automatically append it to a commit message when commiting?

We are using script runner, maybe there is a way to do it with it?

 

3 answers

2 votes

By the time the commit is created with the original commit message, it gets its hash. If you changed the commit message afterward (even programatically), that'd result in a new hash which could eventually break things.

So, I'd suggest you'd rather require committers to enter the issue key in the commit message (a'priori).

But this kind of thing get forgotten, it has to be done automatically.

Maybe via a commit pre hook? Any idea how to do this?

What version control system are you using?

Bitbucket with git

Now that I know the environment, I added a new answer.

You can use the git prepare-commit-msg hook. It's a script that get executed before you write the commit message. I've written such a script. It works for branches named such as "feature/ABC-123-description" and will add "ABC-123" to the commit message. And the developer has all the liability to modify the commit message afterwards. You can set up such a hook at repository level or globally on a machine. That means you must set up the script on every developer machine though. 

#!/bin/bash

# get current branch
branchName=`git rev-parse --abbrev-ref HEAD`

# search jira issue id in a pattern such a "feature/ABC-123-description"
jiraId=$(echo $branchName | sed -nr 's,[a-z]+/([A-Z]+-[0-9]+)-.+,\1,p')

# only prepare commit message if pattern matched and jiraId was found
if [[ ! -z $jiraId ]]; then
# $1 is the name of the file containing the commit message
sed -i.bak -e "1s/^/\n\n$jiraId\n/" $1
fi

Like # people like this

Thank you so much, Adrien!

 

Just a small improvement.

Since the project code may have numbers, I used `[A-Z0-9]` instead of `[A-Z]` to match the project code.

 

jiraId=$(echo $branchName | sed -nr 's,[a-z]+/([A-Z0-9]+-[0-9]+)-.+,\1,p')
0 votes

Commit Policy is an add-on for Bitbucket that enforces this via a custom hook.

See the full documentation here.

does it enforce that the user to insert the issue ID in the commit message?

Or does it automatically append the issue ID into the commit?

The later is prefered.

Any chance to re-upload it? it's 404 :( 

I created a precommit hook that automatically prepends jira ticket id to your commits, if your branch has the ticket info. Works fine so far.

 

https://github.com/milin/giticket

Suggest an answer

Log in or Sign up to answer
TAGS
Community showcase
Published in Bitbucket

Calling any interview participants for Bitbucket Data Center

Hi everyone,  We are looking to learn more about development teams’ workflows and pain points, especially around DevOps, integrations, administration, scale, security, and the related challeng...

505 views 6 4
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you