[CASSANDRA-18126] Add to the IntelliJ Git Window issue navigation links to Cassandra's Jira

• Type: Task
• Status: Resolved
• Priority: Normal
• Resolution: Fixed
• Fix Version/s: 3.0.29, 3.11.15, 4.0.8, 4.1.1, 5.0-alpha1, 5.0
• Component/s: Build
• Change Category: Code Clarity
• Complexity: Low Hanging Fruit
• Platform: All

Source Control Link

https://github.com/apache/cassandra/commit/877d6e6e956ffa387a7d4ec1c7f0ca8ccb23f33e

Test and Documentation Plan

Run ant generate-idea-files from the command line in the Cassandra project.

• Assignee: Maxim Muzafarov
• Reporter: Maxim Muzafarov

Authors

Maxim Muzafarov

Reviewers

Aleksey Yeschenko, David Capwell, Stefan Miklosovic

• Created: 19/Dec/22 23:21
• Updated: 12/Sep/23 13:02
• Resolved: 10/Jan/23 08:30

Description

It is possible to navigate from the IntelliJ IDEA Git window to a corresponding Cassandra issue, the Apache Jira if mentioned in the git message. The example in the attachments shows how CASSANDRA-* letters are turned on in the commit message to an appropriate Cassandra Jira link.

We should update the IntelliJ IDEA configuration and make this behaviour a default for the ant generate-idea-files process.

To achieve this manually you can update your .idea/vcs.xml file in the Cassandra project with the following:

<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="VcsDirectoryMappings">
<mapping directory="$PROJECT_DIR$" vcs="Git" />
</component>
<component name="IssueNavigationConfiguration">
<option name="links">
<list>
<IssueNavigationLink>
<option name="issueRegexp" value="CASSANDRA-(\d+)" />
<option name="linkRegexp"value="https://issues.apache.org/jira/browse/CASSANDRA-$1"/>
</IssueNavigationLink>
</list>
</option>
</component>
</project>

Issue Links

• links to: GitHub PullRequest: 2059