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

Require commit messages contain a specific amount of alpha characters

In an effort to encourage helpful commit messages, I'm interested in the best approach to require a specific amount of alpha characters for each commit message.

 

I appreciate the responses - thanks.

1 answer

1 accepted

1 vote
Answer accepted

This is possible with the following custom pre-receive hook in ScriptRunner for Bitbucket Server.

You need to configure it by going to: Admin → Script Pre Hooks -> Custom script hook 

It will also display the commit ids that do not have a message with at least 10 alpha characters.

If you need alphanumeric you can replace the regex with /[A-Za-z0-9]/

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 refChanges = refChanges as Collection<RefChange>
def repository = repository as Repository
def hookResponse = hookResponse as HookResponse

def commits = refChanges.getCommits(repository)

def offendingCommits = commits.findAll { commit ->
    if (! commit.message) {
        return true
    }

	def regex = /[A-Za-z]/
    def alphaCharactersCount = (commit.message =~ regex).count

    alphaCharactersCount < 10
}

if (offendingCommits) {
    def msg = new StringBuilder()
    msg << "The following commits should have a message containing at least 10 characters:\n"

    offendingCommits.each { commit ->
        msg << commit.displayId
    }

    hookResponse.out().write(BitbucketCannedScriptUtils.wrapHookResponse(msg))

    return false
}

return true

Suggest an answer

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

Bitbucket Server 7.0 is here!

Hello Community, I’m Anton Genkin, a product manager on the Bitbucket Server and Data Center team and am excited to share that Bitbucket Server 7.0 is now available! It's a platform release, one th...

1,136 views 6 5
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