Skip to content

Commit 4e4bd86

Browse files
arturcicarturcic
committed
#2872 - added README.md file to nuget package
1 parent 19ec4da commit 4e4bd86

File tree

8 files changed

+70
-15
lines changed

8 files changed

+70
-15
lines changed

‎README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,14 +52,10 @@ from The Noun Project.
5252
[semver]: http://semver.org
5353
[gitter]: https://gitter.im/GitTools/GitVersion?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
5454
[gitter-badge]: https://badges.gitter.im/Join+Chat.svg
55-
[appveyor]: https://ci.appveyor.com/project/GitTools/gitversion/branch/main
56-
[appveyor-badge]: https://ci.appveyor.com/api/projects/status/sxje0wht0cscmn7w/branch/main?svg=true
5755
[azure-pipeline]: https://dev.azure.com/GitTools/GitVersion/_build/latest?definitionId=1
5856
[azure-pipeline-badge]: https://dev.azure.com/GitTools/GitVersion/_apis/build/status/GitTools.GitVersion
5957
[github-actions]: https://github.com/GitTools/GitVersion/actions
6058
[github-actions-badge]: https://github.com/GitTools/GitVersion/workflows/Build/badge.svg
61-
[travis]: https://travis-ci.org/GitTools/GitVersion
62-
[travis-badge]: https://travis-ci.org/GitTools/GitVersion.svg?branch=main
6359
[codecov]: https://codecov.io/gh/GitTools/GitVersion
6460
[codecov-badge]: https://codecov.io/gh/GitTools/GitVersion/branch/main/graph/badge.svg
6561
[docs]: https://gitversion.net/docs/

‎build/build/Startup.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ public void Configure(IServiceCollection services)
1313

1414
services.UseWorkingDirectory(Extensions.GetRootDirectory());
1515

16+
services.UseTool(new Uri("nuget:?package=NuGet.CommandLine&version=5.11.0"));
1617
services.UseTool(new Uri("dotnet:?package=Codecov.Tool&version=1.13.0"));
1718
services.UseTool(new Uri("dotnet:?package=GitVersion.Tool&version=5.6.11"));
1819
}

‎build/build/Tasks/Package/PackageNuget.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ private static void PackageUsingNuspec(BuildContextBase context)
5858
Files = context.GetFiles(artifactPath + "/**/*.*")
5959
.Select(file => new NuSpecContent { Source = file.FullPath, Target = file.FullPath.Replace(artifactPath, "") })
6060
.Concat(context.GetFiles("docs/**/package_icon.png").Select(file => new NuSpecContent { Source = file.FullPath, Target = "package_icon.png" }))
61+
.Concat(context.GetFiles("build/nuspec/README.md").Select(file => new NuSpecContent { Source = file.FullPath, Target = "README.md" }))
6162
.ToArray()
6263
};
6364

‎build/build/Tasks/Package/PackagePrepare.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ private static DirectoryPath PackPrepareNative(BuildContext context, string runt
5959
Configuration = context.MsBuildConfiguration,
6060
OutputDirectory = outputPath,
6161
MSBuildSettings = context.MsBuildSettings,
62-
ArgumentCustomization = arg => arg.Append("/p:PublishSingleFile=true"),
62+
ArgumentCustomization = arg => arg.Append("/p:PublishSingleFile=true --self-contained"),
6363
};
6464

6565
context.DotNetCorePublish("./src/GitVersion.App/GitVersion.App.csproj", settings);

‎build/nuspec/GitVersion.CommandLine.nuspec

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,6 @@
1616
<tags>Git Versioning GitVersion GitFlowVersion GitFlow GitHubFlow SemVer</tags>
1717
<developmentDependency>true</developmentDependency>
1818
<releaseNotes>https://github.com/GitTools/GitVersion/releases</releaseNotes>
19+
<readme>README.md</readme>
1920
</metadata>
2021
</package>

‎build/nuspec/README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
![GitVersion – From git log to SemVer in no time][banner]
2+
3+
Versioning when using Git, solved. GitVersion looks at your git history and
4+
works out the [Semantic Version][semver] of the commit being built.
5+
6+
[![Gitter][gitter-badge]][gitter]
7+
8+
| Artifact | Stable | |
9+
| :------------------------- | :----------------------------------------------------------------- | - |
10+
| **GitVersion.Tool** | [![NuGet][gvgt-badge]][gvgt] |
11+
| **GitVersion.CommandLine** | [![NuGet][gvcl-badge]][gvcl] |
12+
| **GitVersion.MsBuild** | [![NuGet][gvt-badge]][gvt] | Known as [GitVersionTask] before v5.6.0 |
13+
14+
## Compatibility
15+
16+
GitVersion works on Windows, Linux, and Mac.
17+
18+
## Quick Links
19+
20+
* [Documentation][docs]
21+
* [Contributing][contribute]
22+
* [Why GitVersion][why]
23+
* [Usage][usage]
24+
* [How it works][how]
25+
* [FAQ][faq]
26+
* [Who is using GitVersion][who]
27+
28+
## GitVersion in action!
29+
30+
![README][gv-in-action]
31+
32+
You are seeing:
33+
34+
* Pull requests being built as pre-release builds
35+
* A branch called `release-1.0.0` producing beta v1 packages
36+
37+
## Icon
38+
39+
<a href="https://thenounproject.com/term/tree/13389/" target="_blank">Tree</a>
40+
designed by <a href="http://thenounproject.com/david.chapman" target="_blank">David Chapman</a>
41+
from The Noun Project.
42+
43+
[semver]: http://semver.org
44+
[gitter]: https://gitter.im/GitTools/GitVersion?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
45+
[gitter-badge]: https://badges.gitter.im/Join+Chat.svg
46+
[docs]: https://gitversion.net/docs/
47+
[gh-rel]: https://github.com/GitTools/GitVersion/releases/latest
48+
[gh-rel-badge]: https://img.shields.io/github/release/gittools/gitversion.svg?logo=github
49+
[gvt]: https://www.nuget.org/packages/GitVersion.MsBuild
50+
[gvt-badge]: https://img.shields.io/nuget/v/GitVersion.MsBuild.svg?logo=nuget
51+
[gitversiontask]: https://www.nuget.org/packages/GitVersionTask/
52+
[gvcl]: https://www.nuget.org/packages/GitVersion.CommandLine
53+
[gvcl-badge]: https://img.shields.io/nuget/v/GitVersion.CommandLine.svg?logo=nuget
54+
[gvgt]: https://www.nuget.org/packages/GitVersion.Tool
55+
[gvgt-badge]: https://img.shields.io/nuget/v/GitVersion.Tool.svg?logo=nuget
56+
[contribute]: https://github.com/GitTools/GitVersion/blob/main/CONTRIBUTING.md
57+
[why]: https://gitversion.net/docs/learn/why
58+
[usage]: https://gitversion.net/docs/usage
59+
[how]: https://gitversion.net/docs/learn/how-it-works
60+
[faq]: https://gitversion.net/docs/learn/faq
61+
[who]: https://gitversion.net/docs/learn/who
62+
[gv-in-action]: https://raw.github.com/GitTools/GitVersion/master/docs/input/docs/img/README.png
63+
[banner]: https://github.com/GitTools/graphics/raw/master/GitVersion/banner-1280x640.png

‎src/Directory.Build.props

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
<PackageTags>Git;Versioning;GitVersion;GitFlowVersion;GitFlow;GitHubFlow;SemVer</PackageTags>
1111
<PackageLicenseExpression>MIT</PackageLicenseExpression>
1212
<PackageIcon>package_icon.png</PackageIcon>
13+
<PackageReadmeFile>README.md</PackageReadmeFile>
1314
<PackageReleaseNotes>https://github.com/GitTools/GitVersion/releases</PackageReleaseNotes>
1415

1516
<RepositoryUrl>https://github.com/GitTools/GitVersion</RepositoryUrl>
@@ -76,10 +77,8 @@
7677
</ItemGroup>
7778

7879
<ItemGroup>
79-
<None Include="../../docs/input/docs/img/package_icon.png">
80-
<Pack>true</Pack>
81-
<PackagePath>/</PackagePath>
82-
</None>
80+
<None Include="../../docs/input/docs/img/package_icon.png" Pack="true" PackagePath="/"/>
81+
<None Include="../../build/nuspec/README.md" Pack="true" PackagePath="/"/>
8382
</ItemGroup>
8483

8584
<ItemGroup Condition=" '$(TargetFramework)' == 'net48' ">

‎src/NuGet.Config

Lines changed: 0 additions & 6 deletions
This file was deleted.

0 commit comments

Comments
 (0)