|
1 |
| -# GitExtensions Plugin Template |
2 |
| -An example/empty repository for building a GitExtensions plugin that can be installed using [GitExtensions.PluginManager](https://github.com/gitextensions/gitextensions.pluginmanager). |
3 |
| - |
4 |
| -The package is going to be published on [NuGet.org](https://www.nuget.org/packages/GitExtensions.PluginTemplate) feed. |
5 |
| - |
6 |
| -## Files to keep an eye on |
7 |
| - - [Plugin.cs](src/GitExtensions.PluginTemplate/Plugin.cs) |
8 |
| - - [GitExtensions.PluginTemplate.csproj](src/GitExtensions.PluginTemplate/GitExtensions.PluginTemplate.csproj) |
9 |
| - - [GitExtensions.PluginTemplate.nuspec](src/GitExtensions.PluginTemplate/GitExtensions.PluginTemplate.nuspec) |
10 |
| - |
11 |
| -### Nuspec |
12 |
| - - Place all content under lib folder. Custom nested folders are supported and path is preserved. |
13 |
| - - Add dependency on "virtual" package GitExtensions.Extensibility and target version `[3.0,3.1)` *. |
14 |
| - - Real package dependencies are not supported, so everything should be packed with the plugin. |
15 |
| - - Keep in mind that sharing common libraries can be cumbersome as these must match across all plugins and also Git Extensions itself. So my current recommendation is not to do so. |
16 |
| - |
17 |
| -_* This is just my own eperience. Git Extensions follow SemVer, but it's public plugin API is not so rich that sometimes you need to kind a hack it using APIs that are not ment to be public. For these reasons its better to check compatibility with every single feature update._ |
18 |
| - |
19 |
| -### Csproj |
20 |
| - |
21 |
| - - I'm using powershell script to download a selected version of Git Extensions from GitHub releases. This script runs before every build and checks if Git Extensions binaries are donwloaded. |
22 |
| - - CSproj references selected binaries from the downloaded Git Extensions. |
23 |
| - - After build a newly created binaries of the plugin is copied to Git Extensions plugins directory. |
24 |
| - - F5 is setup to start downloaded `GitExtensions.exe` for easy debugging. |
25 |
| - |
26 |
| - ### Plugin.cs |
27 |
| - - Nothing special, but ordinary Git Extensions plugin :-) |
28 |
| - |
29 |
| -## Icons |
30 |
| - |
31 |
| -Some icons by Yusuke [Kamiyamane](http://p.yusukekamiyamane.com). |
| 1 | + |
| 2 | +# GitExtensions.GerritPlugin |
| 3 | + |
| 4 | +GitExtensions.GerritPlugin is a plugin for GitExtensions to work with a [Gerrit](https://www.gerritcodereview.com/) as Git server. |
| 5 | + |
| 6 | +## Features |
| 7 | + |
| 8 | +* Gerrit hook installation |
| 9 | +* Patchset publish |
| 10 | +* Patchset download |
| 11 | + |
| 12 | +## Usage |
| 13 | + |
| 14 | +The cloned repository requires a `.gitreview` file, which is in use for the plugin to identify the gerrit server. |
| 15 | +This file must be located in root foilder of the repository. |
| 16 | +Get more information about this file [here](https://docs.openstack.org/infra/git-review/installation.html#gitreview-file-format) |
| 17 | + |
| 18 | +## GitExtensions Plugin Template infomration |
| 19 | + |
| 20 | +The [GitExtensions Plugin Template](https://github.com/gitextensions/gitextensions.plugintemplate) gives additional information about the pluign development. |
0 commit comments