Forcing Bitbucket pushes to have Jira issue number using custom groovy Script

Question

Hi Jamie Echlin

We would like to require our users to enter jira issue number when they commit before they push the local repository in bitbucket. I looked at the Atlassian JAVADOC API and I found these packages (https://developer.atlassian.co..., https://developer.atlassian.co... to use. Also I found this groovy from Scriptrunner website which is similar what we want. 
import com.atlassian.bitbucket.hook.HookResponse 
import com.atlassian.bitbucket.repository.RefChange
import com.atlassian.bitbucket.repository.Repository

Repository repository = repository

Collection<refchange> refChanges = refChanges
HookResponse hookResponse = hookResponse

if (repository.name == "test") {
hookResponse.out().print("You cannot commit at the moment to any repository named 'test'
")
return false
}
return true

Could you please tell me how I can modify this in order to require users to enter jira issue number when they want push to bitbucket?
Thanks

adammarkham · Answer

Jonny is right here that you either need to use the built in pre-receive hook with an application link setup for JIRA or you need to use a regex to check the commit message contains a JIRA issue key. There is no other way. The following script checks that the commit message starts with a JIRA issue key: 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 def hookResponse = hookResponse as HookResponse def commits = refChanges.getCommits(repository) def commitsWithoutJiraKey = commits.findAll { commit -> def regex = "[A-Z]{2,9}-\d+.*" !(commit.message ==~ /${regex}/) } if (repository.name == "rep_1" && commitsWithoutJiraKey) { def msg = new StringBuilder() msg << "Following commits have no JIRA key in their message! " commitsWithoutJiraKey.each { commit -> msg << "$commit.displayId " } hookResponse.out().print(BitbucketCannedScriptUtils.wrapHookResponse(msg)) return false } return true You should add this as a custom pre-receive hook.

Jonny Carter_3nm6du · Answer

There are ways.

On the simpler side, you could plausibly just use a regular expression to validate that the commit message matches to a JIRA issue in some way.

If you actually want to pull information from the JIRA instance for your commit hook, you're going to have to use some other means of communication between the two, such as REST calls. Otherwise, how would Bitbucket get info about the JIRA instance? That's very likely going to be more complicated than creating the application link, and debatably worth it. I think I'd just hard-code a regex and have done if it were me.

Ehsan khaligh · Answer

@Jonny Carter

Is there a way to do with custom groovy Script that does not required to link Bitbucket link to JIRA?