PyCharm Help

Issue Navigation

File | Settings | Version Control | Issue Navigation


Use this dialog to create a list of the so-called issue navigation patterns. An issue navigation pattern maps an issue ID pattern in commit messages with the URL addresses of the referenced issues. This enables you to navigate from committed changes to issues related to these changes. As soon as PyCharm encounters a match to the issue ID pattern in a commit message, the match is displayed as a link in the Version Control tool window. If you mention several issues, all of them will be displayed as links. Clicking such link opens the matching issue in the default browser.

ItemDescription
IssueThis read-only field shows the issue pattern.
LinkThis read-only field shows the link to navigate from the issue pattern in the current row to the issue in the bug tracking system.
add Click this button to create a new issue navigation pattern and link. The Add Issue Navigation Link dialog box opens where you can specify:
  • A regular expression to define the issue ID.
  • A regular expression to define the navigation link to the issue.
add-pattern-jira Click this button to create a new JIRA pattern. The Create JIRA Issue Navigation Pattern dialog box is opened where you can specify the URL to your JIRA installation. The regular expression that defines the pattern is added automatically.
add-pattern-youtrack Click this button to create a new pattern for YouTrack. In the dialog box that opens, specify the URL to your YouTrack installation. The regular expression that defines the pattern is added automatically.
edit1 Click this button to update the selected issue navigation link.
delete Click this button to remove the selected issue navigation link from the list.

Example

The example below shows how PyCharm applies the abovementioned rules to detect a reference to an issue in a commit message and compose a link to it in the issue tracking system.

Issue ID pattern The regular expression that defines the format in which issues are referenced in commit messages.

[A-Z]+\-\d+
This regular expressions matches all character strings that consist of two substrings separated by an n-dash character:
  1. Substring 1: An unlimited number of upper case alphabetic characters.
  2. Substring 2: An unlimited number of digital characters.

Issue link pattern A combination of the URL address of your issue tracking system and a regular expression that identifies issues in it.

http://mytracker/issue/$0
Here $0 indicates a back reference to the entire match. This means that as soon as PyCharm detects a match in a commit message, it is added to the URL address of the tracker as is.

Matching issue ID PyCharm detects the following reference to an issue in the commit message of interest:

MYPROJECT-110

Composed issue link In accordance with the above issue navigation pattern, the detected matching reference is added to the URL of the tracker as is, so the link to the referenced issue is composed as follows:

http://mytracker/issue/MYPROJECT-110

See Also

Last modified: 15 May 2015