User Guide 5.7.x

A push or merge can be done only, if at least one commit of a push contains valid issue key reference

A push or merge can be done only, if all commits of a push contains a valid issue key reference

A push or merge can be done only, if all issue keys in a commit message are valid

Escaped issue keys, will not be evaluated

A branch can only be created, merged, pushed is the name contains a valid issue key. 

A push or merge can be done only, if the related issue is in the configured status. The status can be configured via regular expression.

The name of a new branch, will be checked. If a new branch do not match the naming convention, the push will be blocked. The naming convention can be configured via regular expression.

A push with more than one commit will be blocked. A push is only allowed, if branches contains exact one commit. If the branch contains more than one commit, the commits need to be squashed.

A push can be done only, if the push contains no merge commit. This will enforce, that merges will be done via Stash only. If a merge has been done with a different tool (e.g. SourceTree/SmartGit or simple in console) the resulting merge commit will be blocked.

A push or merge can be done only, if the related issue matchs a given JIRA JQL expression.

Force a rebase of the source branch before a integration merge can be done. If a rebase is possible and makes sense, the merge is not allowed without rebasing the branch first. In result this check enforces the "The Rebase Option" in the following tutorial: https://www.atlassian.com/git/tutorials/merging-vs-rebasing/conceptual-overview

A push or merge can be done only, if all commits match a specified syntax. This syntax can be configured based on regular expression.

If this option is enabled, the related text field should contain a regular expression, which will define the syntax of the commit messages.

If the option is set, and the following regular expression is given,

^\[([A-Z]+)-(\d+)\](.|\n)+

then each commit message must start with a issue key, which is in brackets. Additionally after the key there must be a further description (e.g. "[TEST-1] further text" will be accepted. Only "[TEST-1]" as commit message will not be accepted. Also "TEST-1 and some further text" will not be accepted, because of the missing brackets. If the commit message do not match, the push or merge is blocked.

If this option is enabled, the related text field should contain a regular expression, which will define the valid status of issue key references.

If the option is set, and the following regular expression is given,

Reviewed|Integration Request

then a merge or a push can be done only, if the issue status is "Reviewed" or "Integration Request". (Of course also a more complex regular expression is possible.)

To Do|Aufgabe

If this option is enabled, the related text field should contain a valid JIRA JQL expression. A commit will be accepted only, if all issue key references will match the given JQL

If the option is set, and the following JQL is given,

(assignee=benni and fixVersion is not EMPTY)

then a given issue reference will be checked with this JQL. So a merge or push is only possible, if the assignee is the user "benni" and the fix version is set to any version.

(assignee=$currentUser)

You can also use the keyword "$currentUser", which will be replaced with the user wich will execute the merge or push. So the JQL ensure that the merge/push can only be done by the assignee of the issue.

• You can configure where to search for issue keys. Respect issue keys only in branches, only in commits or in branches and commits.

• In addition you can add an escape character to ignore specific issues 

• If the format of your issue keys are not the default, you can adjust the regular expression to search issue keys in branches and commit messages

If you want to mention another issue key in your commit message that is related to your change but should not be validated in relation to your work, then you can escape this issue key

TEST-2 my change has a relation to !TEST-1

If this options are set, a issue key must exist. Additionally the issue key must reference a valid issue in JIRA.

There are 5 possibilities to check issue-keys

Regarding the issue key in branch name you can explicitly disable some branches (e.g development or master). This exception is only valid for the push hook.

This is a push example, but the behavior regarding the merge hook is the same. (e.g. TEST-10000 does not exist)

git checkout -b my-branch/something
git commit -m 'TEST-1 TEST-10000 this is a example'
git push

git checkout -b my-branch/something
git commit -m 'TEST-1 TEST-10000 This is a example'
git commit -m 'This is a example'
git push

git checkout -b my-branch/TEST-1
git commit -m 'This is a example'
git push

git checkout -b my-branch/something
git commit -m 'TEST-1 This is a example'
git commit -m 'This is a example'
git push

git checkout -b my-branch/TEST-2
git commit -m 'TEST-1 This is a example'
git commit -m 'This is a example'
git push

You can specify how application links should behave. You can specify where issues will be searched

If selected, only configured project links will be used for validation

If the Bitbucket project is connected to one or more Jira projects via Application Link, then select this option. This will result in searching for matching issues only in the connected projects.

If selected, not all application links needs to be reachable/accessible

By default, all project links that have been configured must also be accessible. If not, then the validation fails. Set this option if a valid application link is sufficient.

If this option is enabled, the related text field should contain a valid list of user group. If the user which will do the merge/push is in the given group, then the checks will not be evaluated.

This is a push example, but the behavior regarding the merge hook is the same.

If the option is set, and the group admin is configured. Additionally there are several commits which would block a push or merge (e.g. no issue key reference is available), then the behaviour is:

git commit -m 'this is a example'
git push

git commit -m 'this is a example'
git push

Based on a keyword in a commit message you can skip the all checks for this commit. The keyword can be configured via regular expression. As soon the regular expression match, the commit will not be validated

Via this options you can enable/disable the check based on PR source and/or target branch. If the option for source/target branch is enabled, then the check will be executed only, if the branch name will match the related regular expression. 

Example 1: Do not check hotfix branches

• Enable the source branch check

• Add the following regular expression

  ^(?!.*(hotfix\\/.*)).*

  As result all branches beginning with "hotfix/" will not be checked. The target branch doesn't matter.

Example 2: Do only check pull requests going into release branches

• Enable the target branch check

• Add the following regular expression

  release/.*

  As result all branches beginning which should be integrated into a branch starting with "release/" will be checked. The source branch doesn't matter. All other PRs will be ignored.

If this option is enabled a merge can only be done only, if in the master are no newer commits. If there are newer commits, which are not in the source branch, the source branch must be rebased on to the top of the target branch. This will create a clean branch-merge picture and will resolve merge conflicts in a early stage.

The merge check strategy can be checked:

In this example, the issue TEST-1 is valid and TEST-1000 is invalid (e.g. TEST-10000 does not exist)

Example 1: Both options are selected 

• If enabled, all configured checks will be evaluated for the merge message AND

• If selected, only the merge commit will be checked. All other commits will be ignored 

git checkout -b my-branch/something
git commit -m 'TEST-10000 this is a example'
git push
git checkout master
git merge my-branch/something -m "TEST-1 my commit message"

Example 2: Only merge message check is enabled

• If enabled, all configured checks will be evaluated for the merge message

git checkout -b my-branch/something
git commit -m 'TEST-1 this is a example'
git push
git checkout master
git merge my-branch/something -m "TEST-10000 my commit message"

If this option is enabled, the related text field should contain a regular expression, which will define the branches. If the branch will match the regular expression, the merge/push will be checked. If the branch will not match, the checks will be skipped.

If the option is set, and the following regular expression is given,

master|develop

then the checks will be validate only if:

• you will push commits in the master or develop branch

• you will merge pull requests in the master or develop branch

If you will push or merge change-sets in a branch with a other name, then the checks will not be evaluated and the merge/push is always allowed.

If enabled force pushes will not be checked

If this option is enabled a push can be done only, if the push contains only one commit. If there are more commits, the push will be rejected. After squashing the commits to one commit the push is allowed again.

If this option is not enabled a push can be done only, if in the push contains no merge commit. This ensures that commits can be done via Bitbucket only. But of course there can be exceptions. Therefore you can allow merge commits, but only if there is a special keyword given.

Example: skip keyword = "merge-skip-fantasy"

"branch x"    ----- A 
                     \
                      \
"branch y"  --- FA -- merge --> push

If this option is enabled, the related text field should contain a regular expression, which will define the syntax/naming of all new branches. This check will only be executed, if a new branches will be created via a push from a client. The creation of a branch via Bitbucket do not execute this check.

If the option is set, and the following regular expression is given,

branches\\/[bug|feature]+\\/.*

then each new branch needs to match this regular expression.

The online change options allow you to specify whether the hooks should also check the configured changes when the changes are made via the Bitbucket web interface