Hook for Pull Request

What kind of a hook can I implement to check for Pull Request, or when a pull request has been created in a repository ??

All I want to do is check the message in a pull request and reject the pull request if the pull request message does not contain a valid JIRA...



1 answer

Hi Ishan,

You can just add a normal atlassian-plugin.xml component by using PullRequestOpenRequestedEvent.

public void onPullRequestOpen(PullRequestOpenRequestedEvent event) {
    for(Changeset changeset : pullRequestService.getChangesets(event.getPullRequest().getToRef().getRepository().getId(), event.getPullRequest().getId(), new PageRequestImpl(0, 100)) {
        if (changeset.getAttributeValues("jira-key").isEmpty()) {
            event.cancel(i18nService.getKeyedText("your.plugin.i18n.warning", "Missing JIRA key in message '{0}'", changeset.getMessage());

That code isn't tested and may not even compile. Apologies it's not something we're really advertising which may explain the lack of documentation.

Just a question though - if the user tries to create the pull request and fails, do you normally advise users to amend their messages in git? That requires you don't mind your users using force push (or deleting/creating the branch again). What if they have multiple commits and the very first one is missing a JIRA key - are your users familiar/comfortable with 'git rebase -i'?

I definitely understand the requirement, but I worry that the distributed nature of Git will make this workflow hard to enforce in all cases. I'd love to understand how this kind of restriction works in your environement?



Very good point Adam.

You can also use the above event to restrict the PR based on title/description as well. I agree this is preferable to restricting by commit message, although as you say it doesn't mean that the PR will actually be linked to the JIRA issue.



Something that might work better with a Git workflow is checking the pull request description or title for JIRA keys, rather than actual commits. Those should be much easier to amend if they are missing a JIRA key.

That won't enforce any hard, back-end link between the pull request and the JIRA issue, but it ensures there's a link there at least in human-readable form. In 2.7+, issue keys in the description will also show as <a> tags that bring up issue information in a dialog.

Suggest an answer

Log in or Join to answer
Community showcase
Louis De Jaeger
Posted Thursday in Off-topic

Friday fun: your best joke

Hi all Lets make this Friday fun really fun and post one (or more) of your best jokes! The joke can be about an Atlassian product, or just a really fun joke you want to share! I’m not the best j...

175 views 12 3
Join discussion

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
Atlassian Team Tour

Join us on the Team Tour

We're bringing product updates and pro tips on teamwork to ten cities around the world.

Save your spot