Handling Issues
On this page:
- Introduction
- Example
- Enabling navigation from commit messages to issues
- Enabling navigation from commit messages to issues related to them
- Navigating from a commit message to an issues
- Navigating from a commit message to the related issues
Introduction
With PhpStorm, you can connect your check-in comments with the bug tracker or any issues data base and navigate from committed changes to the issues related to these changes.
To enable this navigation, you need to specify a so called issue navigation pattern, which means:
- Figure out an issue ID pattern, that is, a format according to which you will reference issues in commit messages, and define this issue pattern using a regular expression.
- Define the link to the referenced issue by combining the URL address of your tracking system and a regular expression to identify the issue ID.
Example
Enabling navigation from commit messages to issues
To enable navigating from commit messages to issues related to them
- Press Ctrl+Alt+S or choose (for Windows and Linux) or (for macOS) on the main menu, and then go to .
- On the Issue Navigation page that opens, configure a list of issue navigation patterns by setting correspondence between issue patterns in commit messages and URL addresses of referenced issues.
- If you are using JIRA or our bug tracking system YouTrack, click the Add JIRA pattern or Add YouTrack Pattern respectively, and type the URL to the installation of bug tracking system in question.
PhpStorm adds the regular expression that defines such pattern automatically. - For other issue tracking systems, click the Add button to create a new entry or select an existing entry and click the Edit button. In the Add Issue Navigation Link dialog box that opens, specify the following:
- The regular expression that defines the issue pattern in a commit message.
- The replacement expression that defines the URL to access the corresponding referenced issue.
- To remove an issue navigation pattern, select it in the list and click Remove .
- If you are using JIRA or our bug tracking system YouTrack, click the Add JIRA pattern or Add YouTrack Pattern respectively, and type the URL to the installation of bug tracking system in question.
Navigating from a commit message to an issues
To navigate from a commit message to the related issues
- Open one of the following views:
- Local Changes, Incoming, or Log tab of the Version Control tool window.
- History tab of the Version Control tool window.
- Changes Browser.
- Find the commit of interest and click the hyperlink to the related issue.
Last modified: 28 November 2017