Skip to content

Commit 51dfb78

Browse files
committed
Add instructions for releasing
1 parent 7384c52 commit 51dfb78

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,25 @@ nuget.exe Pack nuget.package/NativeBinaries.nuspec -Version <version> -NoPackage
100100
Where `<version>` is the version from the MinVer tool or manually chosen version.
101101

102102

103+
## Releasing
104+
105+
Releases are triggered by pushing a git tag. The tag format is:
106+
107+
```
108+
<upstream-version>-octopus.<n>
109+
```
110+
111+
Where `<upstream-version>` is the version from the upstream libgit2sharp.nativebinaries repo (e.g., `2.0.312`) and `<n>` is an incrementing number starting at 1. The incrementing number resets to 1 when the upstream version changes.
112+
113+
For example, for upstream version `2.0.312`:
114+
115+
```
116+
git tag 2.0.312-octopus.1
117+
git push origin 2.0.312-octopus.1
118+
```
119+
120+
This triggers CI, which builds all native binaries, packs the NuGet package with the tag as its version, and pushes it to the configured feed.
121+
103122
## Notes on Visual Studio
104123

105124
Visual Studio 2019 is required to build the Windows native binaries, however you

0 commit comments

Comments
 (0)