# GitToolBox

**Repository Path**: shp330/GitToolBox

## Basic Information

- **Project Name**: GitToolBox
- **Description**: GitToolBox IntelliJ plugin
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2021-11-28
- **Last Updated**: 2023-03-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

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](https://github.com/zielu/GitToolBox/wiki/Manual)

## Change notes
For list of change notes see [changenotes](./GitToolBox/change-notes.html)

## Jetbrains plugin repository
[Plugin repository page](https://plugins.jetbrains.com/plugin/7499-gittoolbox)

### 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](https://github.com/zielu/GitToolBox/wiki/ADR).

## Building & running

### Releases

#### Release current `-SNAPSHOT`
```shell script
gradle clean release
```
#### Upgrade to next minor version
```shell script
gradle clean releaseMinorVersion
```
#### Upgrade to next major version
```shell script
gradle clean releaseMajorVersion
```

#### Release and publish
Append ```-Ppublish=true``` and include ```publishPlugin``` task.
For example
```shell script
gradle clean release publishPlugin -Ppublish=true
```

### Useful build commands
Full verification of build
```shell script
gradle clean check integrationTest
```
Quick verification of build
```shell script
gradle clean check
```
Generate code coverage report
```shell script
gradle clean codeCoverage
```
Build to install with Install from disk
```shell script
gradle buildPlugin
```

#### Update gradle version
```shell script
./gradlew wrapper --gradle-version 6.8.1 --distribution-type BIN
```

### Useful run commands
Run with previous sandbox contents
```shell script
gradle runIde
```
Run with fresh sandbox
```shell script
gradle clean runIde
```
Run plugin verifier
```shell script
./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](https://git-scm.com/downloads/logos) by [Jason Long](https://twitter.com/jasonlong) is licensed under the [Creative Commons Attribution 3.0 Unported License](https://creativecommons.org/licenses/by/3.0/)

Some icons by [Yusuke Kamiyamane](http://p.yusukekamiyamane.com). Licensed under a [Creative Commons Attribution 3.0 License](http://creativecommons.org/licenses/by/3.0/)