xhoaluu / GitToolBox

GitToolBox IntelliJ plugin

GitToolBox - plugin for Jetbrains IDEs

Repository status notice

Since 29 May 2021 plugin development continues in private repository. This repository serves as an archive but also public issue tracker and online manual.

Plugin is in development since 2014 and this codebase represents significant investment of my free time. Over the years there were only a few contributions so decision to close-source the plugin will not impact pace of development.

Description

Plugin for family of Jetbrains IDEs that expands build-in Git Integration.

Features

For list of features see the manual

Change notes

For list of change notes see changenotes

Jetbrains plugin repository

Plugin repository page

EAP builds

Add https://plugins.jetbrains.com/plugins/eap/7499 in Settings > Plugins > Browse repositories... > Manage repositories... to receive early access builds.

Architecture decisions record

Record of decisions is here.

Building & running

Releases

Release current -SNAPSHOT

gradle clean release

Upgrade to next minor version

gradle clean releaseMinorVersion

Upgrade to next major version

gradle clean releaseMajorVersion

Release and publish

Append -Ppublish=true and include publishPlugin task. For example

gradle clean release publishPlugin -Ppublish=true

Useful build commands

Full verification of build

gradle clean check integrationTest

Quick verification of build

gradle clean check

Generate code coverage report

gradle clean codeCoverage

Build to install with Install from disk

gradle buildPlugin

Update gradle version

./gradlew wrapper --gradle-version 6.8.1 --distribution-type BIN

Useful run commands

Run with previous sandbox contents

gradle runIde

Run with fresh sandbox

gradle clean runIde

Run plugin verifier

./gradlew runPluginVerifier -x buildSearchableOptions

Debugging

To debug the plugin execute Gradle run configuration with runIde task using IDE Debug action.

Logging

Plugin can log additional diagnostic information to help with issues investigation. All categories can be used in any combination.

Debug logging

Add following line to Help > Debug Log Settings...

#zielu.gittoolbox

Performance metrics

Metrics are exposed via JMX beans under zielu.gittoolbox domain.

Icons attribution:

Git Logo by Jason Long is licensed under the Creative Commons Attribution 3.0 Unported License

Some icons by Yusuke Kamiyamane. Licensed under a Creative Commons Attribution 3.0 License