Skip to main content
Skip table of contents

Issue-Key check example

All of the following error messages are displayed when a pull request is created and can also appear in combination.


Issue Key check in commits

Configuration

mustCommitEach.png

Possible results

Commands

Expected results

BASH
git checkout -b feature/TEST-1
git commit -m 'Added new feature'
git commit -m 'Added new feature TEST-1'

(error) Can not be merged

→ Not every commit message contains an valid Issue-Key

BASH
git checkout -b feature/TEST-1
git commit -m 'Added new feature TEST-1 TEST-100'
git commit -m 'Added new feature TEST-2'

(error) Can not be merged

→ The Issue-Key ‘TEST-1000’ is invalid

BASH
git checkout -b feature/TEST-3
git commit -m 'Added new feature TEST-1'
git commit -m 'Added new feature TEST-2'

(error) Can not be merged

→ The Issue-Keys found in the commit messages do not match the Issue-Key inside the branch name

BASH
git checkout -b feature/TEST-1
git commit -m 'Added new feature TEST-1'
git commit -m 'Added new feature TEST-2'

(tick) Can be merged

Configuration

mustCommitOne.png

Possible results

Commands

Expected results

BASH
git checkout -b feature/TEST-1
git commit -m 'Added new feature'
git commit -m 'Added new feature TEST-1'

(tick) Can be merged

BASH
git checkout -b feature/TEST-1
git commit -m 'Added new feature TEST-1 TEST-100'
git commit -m 'Added new feature TEST-2'

(error) Can not be merged

→ The Issue-Key ‘TEST-1000’ is invalid

BASH
git checkout -b feature/TEST-3
git commit -m 'Added new feature TEST-1'
git commit -m 'Added new feature TEST-2'

(error) Can not be merged

→ The Issue-Keys found in the commit messages do not match the Issue-Key inside the branch name

BASH
git checkout -b feature/TEST-1
git commit -m 'Added new feature TEST-1'
git commit -m 'Added new feature TEST-2'

(tick) Can be merged


Issue Key check in branch

Configuration

mustBranch.png

Possible results

Commands

Expected results

BASH
git checkout -b feature/new-feature

(error) Can not be merged

→ Branch name doesn’t contain any Issue-Key

BASH
git checkout -b feature/TEST-1

(tick) Can be merged


Issue Key check in Pull-Request

Configuration

mustPrTitle.png

Possible results

Pull-Request Title

Expected results

Add user authentication feature

(error) Can not be merged

→ Pull-Request title doesn’t contain any Issue-Key

[TEST-300] Add user authentication feature

(tick) Can be merged

Configuration

mustPrDesc.png

Possible results

Pull-Request Description

Expected results

Add user authentication feature

(error) Can not be merged

→ Pull-Request description doesn’t contain any Issue-Key

[TEST-300] Add user authentication feature

(tick) Can be merged

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.