PhpStorm
 
2023.2
Shortcuts: Windows
Get PhpStorm
You are viewing the documentation for an earlier version of PhpStorm.
  1. Reference
  2. Settings
  3. Version Control
  4. Issue Navigation

Issue Navigation

Last modified: 23 October 2023

File | Settings | Version Control | Issue Navigation for Windows and Linux

PhpStorm | Settings | Version Control | Issue Navigation for macOS

CtrlAlt0S the Settings icon

In this page, you can maintain a list of 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 PhpStorm 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 Alt09. If you mention several issues, all of them will be displayed as links. Clicking such link opens the matching issue in the default browser.

Item

Description

Issue

This read-only field shows the issue pattern.

Link

This 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

Adds a new issue navigation pattern. In the dialog that opens, specify the following:

  • A regular expression to match the issue ID.

  • A regular expression to define the navigation link to the issue.

Add Issue Navigation Link dialog

tip

For more information about using special characters in regular expressions, refer to Regular Expressions Syntax Reference.

the Add icon

Click this button to create a new JIRA pattern. The Create JIRA Issue Navigation Pattern dialog is opened where you can specify the URL to your JIRA installation. The regular expression that defines the pattern is added automatically.

the Add icon

Click this button to create a new pattern for YouTrack. In the dialog that opens, specify the URL to your YouTrack installation. The regular expression that defines the pattern is added automatically.

Edit

Click this button to update the selected issue navigation link.

Remove

Click this button to remove the selected issue navigation link from the list.

Example

The example below shows how PhpStorm applies the mentioned 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

A regular expression that defines the format for issue references in commit messages.

[A-Z]+\-\d+

This regular expression 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

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 PhpStorm detects a match in a commit message, it is added to the URL address of the tracker as is.

Matching issue ID

PhpStorm 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

Procedures

Reference