Skip to main content

Fix Issues via Commit Message

Reference an issue in a fixing commit message to connect it with commits, pull requests, and builds. This tutorial uses two issues in the same project and a job named release.

Check the detection settings​

Open Administration > Issue Settings > Commit Message Fix Settings as an administrator. Fix Detection contains the prefix/suffix patterns used to recognize issue references on each line of a commit message. Fix Suggestion is guidance for coding agents; it does not change the detection patterns.

Commit message fix settings

With the default detection patterns, these messages identify fixed issues:

fix issue #100
close #100
resolve issue #200: Add Kubernetes support
fix issue path/to/project#300: An issue in another project

A separate footer is also supported:

Document installation

Fixes #1

The default patterns also recognize a parenthesized issue reference at the end of a line, including these conventional commit examples:

feat: Some feature description (#100)
fix: Some bug description (#100)
chore: Some minor change description (#100)
feat(api): API feature description (#100)

Use the actual issue number from your project. Use path/to/project#100 for an issue in another project, or PROJECTKEY-100 when that project has a key.

Follow a fix through a pull request and build​

  1. Create two issues in your project. Run the release job on the default branch before making the fixes to establish a baseline build.

  2. Create a feature branch. Commit the first fix with Fixes #1 in its message and the second with fix(docs): Add troubleshooting guide (#2), substituting your issue numbers. Push the branch to OneDev.

  3. Open a pull request from the feature branch to the default branch. On each issue, check the Pull Requests section and Fixing Commits tab.

    Issue with its fixing commit and pull request

  4. Merge the pull request and run the release job again on the updated default branch. The issue's Fixing Builds tab provides the corresponding build references.

Issue state changes depend on Administration > Issue Settings > State Transitions. With the default workflow, opening this pull request moves its fixed issues to In Review, and merging it moves them to Closed. Custom workflows may behave differently.

In the issue list, find issues fixed between the baseline and updated builds:

fixed between build "#1" and build "#2"

Replace the build numbers with yours. In this example, both issues are returned.

Issues fixed between builds

In the pull request list, find pull requests containing the fixing commit for an issue:

includes issue "#1"

Pull requests including an issue

In the build list, find builds of the release job fixing that issue:

"Job" is "release" and fixed issue "#1"

Release builds fixing an issue

Enter a query in the corresponding list's query box and press Enter. Press Escape to dismiss suggestions if they cover the results.