Skip to content

anatolykopyl/auto-commit-message-plugin

Repository files navigation

Auto commit message Plugin for IntelliJ

This plugin assumes that your branch name is a Jira task ID.

It adds a button to create a conventional commit message automatically using the branch name and connecting to the Jira api.

The commit message is using the Selectel conventional commit flavour:

type(component_from_Jira): subject TASK_ID

For example:

feat(common): Did some stuff TASK-123

Configure the plugin in Settings > Tools > Auto Commit Message.

Installation

  1. Obtain the plugin zip file (either from a known source, or by following the steps in Release)

  2. From a Jetbrains IDE, go to Settings -> Plugins

  3. Click the options button Install-local-plugin-button

  4. Navigate to the folder containing the plugin zip file

  5. Select the zip file, and press "Open"

  6. Press "save" to install the plugin

Release

  • Ensure the project is set up properly and runs in development.
  • Run the buildPlugin gradle task
    • From IntelliJ IDEA, open the Gradle tool window, navigate to Tasks -> intellij -> double click on buildPlugin
  • The zip file will be generated in build/distributions

Original Work

This plugin is based off the Git Commit Template With Jira Id plugin.