Skip to content

Commit 8040ab0

Browse files
authored
Update Readme (#16)
1 parent c25d49c commit 8040ab0

File tree

4 files changed

+24
-32
lines changed

4 files changed

+24
-32
lines changed

Directory.Build.props

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
<FileVersion>0.0.0.1</FileVersion>
1212
<InformationalVersion>0.0.0.1</InformationalVersion>
1313
<PackageVersion>0.0.0.1</PackageVersion>
14+
<PackageTags>GitExtensions</PackageTags>
1415
</PropertyGroup>
1516

1617
<PropertyGroup>

README.md

+20-31
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,20 @@
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.

contributors.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -112,4 +112,5 @@ YYYY/MM/DD, github id, Full name, email
112112
2019/12/25, dfev77, Florin Daneliuc, [email protected]
113113
2020/01/02, c3er, Christian Dreier, flipper.x3r(at)googlemail.com
114114
2020/01/04, MarkJ74, Mark Jackson, markj74(at)outlook.com
115-
2020/01/07, asherber, Aaron Sherber, aaron(at)sherber.com
115+
2020/01/07, asherber, Aaron Sherber, aaron(at)sherber.com
116+
2021/01/17, thimmy687, Ricardo Krause, [email protected]

src/GitExtensions.GerritPlugin/GitExtensions.GerritPlugin.nuspec

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
<version>$version$</version>
66
<authors>$authors$</authors>
77
<description>$description$</description>
8+
<license type="file">LICENSE.md</license>
89
<projectUrl>$projectUrl$</projectUrl>
910
<tags>$tags$</tags>
1011
<dependencies>

0 commit comments

Comments
 (0)