https://github.com/anatolykopyl/auto-commit-message-plugin

A plugin for IntelliJ IDEA for automatically generating a commit message.
https://github.com/anatolykopyl/auto-commit-message-plugin

git intellij-plugin productivity

Last synced: about 2 months ago
JSON representation

A plugin for IntelliJ IDEA for automatically generating a commit message.

• Host: GitHub
• URL: https://github.com/anatolykopyl/auto-commit-message-plugin
• Owner: anatolykopyl
• License: apache-2.0
• Created: 2023-09-22T18:39:09.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-09-25T07:27:44.000Z (over 2 years ago)
• Last Synced: 2025-03-25T04:29:59.278Z (over 1 year ago)
• Topics: git, intellij-plugin, productivity
• Language: Kotlin
• Homepage: https://plugins.jetbrains.com/plugin/22770-auto-commit-message
• Size: 983 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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](#release))

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

3. Click the options button

![Install-local-plugin-button](static/install-local-plugin-button.png)

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](https://bitbucket.org/crm-uk/commit-template-with-jira-id) plugin.