How to Enforce Naming Standards for Commit Message?

 

5 answers

1 accepted

2 votes
Accepted answer

You can do this with ScriptRunner for Bitbucket Server by going to Admin -> Script Pre Hooks -> Protect git refs and configure it like in the screenshot below:

Screen Shot 2017-01-05 at 12.00.36.png

The condition is:

def commits = refChanges.getCommits(repository)

def regex = "[A-Z]{2,9}-\\d+\\s[A-Za-z]+.*"

commits*.message.any { message ->
   	!(message  ==~ /${regex}/)
}

Note that this won't work if you configure it from the repository settings menu for Script Pre Hooks due to security issues we limit what you can use in the condition.

You can change the error message to what you like.

If you require to set the error message dynamically you can use something like the following under Admin -> Script Pre Hooks -> Custom script hook:

import com.atlassian.bitbucket.hook.HookResponse
import com.atlassian.bitbucket.repository.RefChange
import com.atlassian.bitbucket.repository.Repository
import com.onresolve.scriptrunner.canned.bitbucket.util.BitbucketCannedScriptUtils

def repository = repository as Repository
def refChanges = refChanges as Collection<RefChange>
def hookResponse = hookResponse as HookResponse

def msg = new StringBuilder()

def commits = refChanges.getCommits(repository)

def regex = "[A-Z]{2,9}-\\d+\\s[A-Za-z]+.*"

commits*.message.each { message ->
    if (!(message  ==~ /${regex}/)) {
        msg << "$message does not match $regex"
    }
}

if (msg) {
    hookResponse.out().write BitbucketCannedScriptUtils.wrapHookResponse(msg)
    // block push as commits don't match regex
    return false
}

// allow push
return true

Note that we are working on SRBITB-7 which in a few weeks when we release will allow you to dynamically set the error message in the first script also without you requiring to write all the code in the second example.

Let us know how you get on with this.

I know this is an older question, but we just started looking into doing this. We use Bitbucket Server for viewing and merging pull requests, but our commits and pushes are done via git bash. Will this solution work? Or does it only work if all git work is done via Bitbucket?

-&gt is not working for me in script in script-runner prehook

Like 1 person likes this
0 votes

Could you tell us what naming standard you want the commit message to match and I will put an example together for you?

You'll likely get a faster response if you tag your question with: com.onresolve.stash.groovy.groovyrunner in the future. I've just done this for you.

I use this add-on:

https://marketplace.atlassian.com/plugins/com.isroot.stash.plugin.yacc/server/overview

You can use regex or it validates against a JQL query, or both.

Apologies I automatically assumed you were talking about ScriptRunner for Bitbucket Server as that has something similar. Maybe mention that plugin in the question tags and you'll be more likely to get an answer from the right people.

Good morning, I was responding to Trent Daily, he's the OP.

We are attempting to use scriptrunner to get this completed.  What we are looking for is:
1. Comment should start with 
2. apha numeric upper case - min 2 char (for example for CM)
3. hyphen Mandatory
4. Number (0-9) - Atleast 1 digit
5. No spaces around hyphen.
6. Space required after jira story number. And atleast 1 word comment afterward.

ex. CM-1234 Adding pom changes

0 votes

@Trent Dailey thanks for confirming. I have provided a solution for you.

Suggest an answer

Log in or Sign up to answer
Community showcase
Published Nov 06, 2018 in Bitbucket

Upgrade Best Practices

Hello! My name is Mark Askew and I am a Premier Support Engineer for products Bitbucket Server/Data Center, Fisheye & Crucible. Today, I want to bring the discussion that Jennifer, Matt, and ...

1,932 views 7 10
Read article

Atlassian User Groups

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

Find a group

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

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you