GitTools#2872 - added README.md file to nuget package

arturcic · Oct 9, 2021 · 7ecfe20 · 7ecfe20
1 parent 19ec4da
commit 7ecfe20
Show file tree

Hide file tree

Showing 6 changed files with 68 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -52,14 +52,10 @@ from The Noun Project.
 [semver]:                          http://semver.org
 [gitter]:                          https://gitter.im/GitTools/GitVersion?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
 [gitter-badge]:                    https://badges.gitter.im/Join+Chat.svg
-[appveyor]:                        https://ci.appveyor.com/project/GitTools/gitversion/branch/main
-[appveyor-badge]:                  https://ci.appveyor.com/api/projects/status/sxje0wht0cscmn7w/branch/main?svg=true
 [azure-pipeline]:                  https://dev.azure.com/GitTools/GitVersion/_build/latest?definitionId=1
 [azure-pipeline-badge]:            https://dev.azure.com/GitTools/GitVersion/_apis/build/status/GitTools.GitVersion
 [github-actions]:                  https://github.com/GitTools/GitVersion/actions
 [github-actions-badge]:            https://github.com/GitTools/GitVersion/workflows/Build/badge.svg
-[travis]:                          https://travis-ci.org/GitTools/GitVersion
-[travis-badge]:                    https://travis-ci.org/GitTools/GitVersion.svg?branch=main
 [codecov]:                         https://codecov.io/gh/GitTools/GitVersion
 [codecov-badge]:                   https://codecov.io/gh/GitTools/GitVersion/branch/main/graph/badge.svg
 [docs]:                            https://gitversion.net/docs/

diff --git a/build/build/Tasks/Package/PackageNuget.cs b/build/build/Tasks/Package/PackageNuget.cs
@@ -58,6 +58,7 @@ private static void PackageUsingNuspec(BuildContextBase context)
             Files = context.GetFiles(artifactPath + "/**/*.*")
                 .Select(file => new NuSpecContent { Source = file.FullPath, Target = file.FullPath.Replace(artifactPath, "") })
                 .Concat(context.GetFiles("docs/**/package_icon.png").Select(file => new NuSpecContent { Source = file.FullPath, Target = "package_icon.png" }))
+                .Concat(context.GetFiles("build/nuspec/README.md").Select(file => new NuSpecContent { Source = file.FullPath, Target = "README.md" }))
                 .ToArray()
         };
 

diff --git a/build/nuspec/GitVersion.CommandLine.nuspec b/build/nuspec/GitVersion.CommandLine.nuspec
@@ -16,5 +16,6 @@
     <tags>Git Versioning GitVersion GitFlowVersion GitFlow GitHubFlow SemVer</tags>
     <developmentDependency>true</developmentDependency>
     <releaseNotes>https://github.com/GitTools/GitVersion/releases</releaseNotes>
+    <readme>README.md</readme>
   </metadata>
 </package>
diff --git a/build/nuspec/README.md b/build/nuspec/README.md
@@ -0,0 +1,63 @@
+![GitVersion – From git log to SemVer in no time][banner]
+
+Versioning when using Git, solved. GitVersion looks at your git history and
+works out the [Semantic Version][semver] of the commit being built.
+
+[![Gitter][gitter-badge]][gitter]
+
+| Artifact                   |                Stable                                              |   |
+| :------------------------- | :----------------------------------------------------------------- | - |
+| **GitVersion.Tool**        |                           [![NuGet][gvgt-badge]][gvgt]             |
+| **GitVersion.CommandLine** |                           [![NuGet][gvcl-badge]][gvcl]             |
+| **GitVersion.MsBuild**     |                            [![NuGet][gvt-badge]][gvt]              | Known as [GitVersionTask] before v5.6.0 |
+
+## Compatibility
+
+GitVersion works on Windows, Linux, and Mac.
+
+## Quick Links
+
+*   [Documentation][docs]
+*   [Contributing][contribute]
+*   [Why GitVersion][why]
+*   [Usage][usage]
+*   [How it works][how]
+*   [FAQ][faq]
+*   [Who is using GitVersion][who]
+
+## GitVersion in action!
+
+![README][gv-in-action]
+
+You are seeing:
+
+*   Pull requests being built as pre-release builds
+*   A branch called `release-1.0.0` producing beta v1 packages
+
+## Icon
+
+<a href="https://thenounproject.com/term/tree/13389/" target="_blank">Tree</a>
+designed by <a href="http://thenounproject.com/david.chapman" target="_blank">David Chapman</a>
+from The Noun Project.
+
+[semver]:                          http://semver.org
+[gitter]:                          https://gitter.im/GitTools/GitVersion?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+[gitter-badge]:                    https://badges.gitter.im/Join+Chat.svg
+[docs]:                            https://gitversion.net/docs/
+[gh-rel]:                          https://github.com/GitTools/GitVersion/releases/latest
+[gh-rel-badge]:                    https://img.shields.io/github/release/gittools/gitversion.svg?logo=github
+[gvt]:                             https://www.nuget.org/packages/GitVersion.MsBuild
+[gvt-badge]:                       https://img.shields.io/nuget/v/GitVersion.MsBuild.svg?logo=nuget
+[gitversiontask]:                  https://www.nuget.org/packages/GitVersionTask/
+[gvcl]:                            https://www.nuget.org/packages/GitVersion.CommandLine
+[gvcl-badge]:                      https://img.shields.io/nuget/v/GitVersion.CommandLine.svg?logo=nuget
+[gvgt]:                            https://www.nuget.org/packages/GitVersion.Tool
+[gvgt-badge]:                      https://img.shields.io/nuget/v/GitVersion.Tool.svg?logo=nuget
+[contribute]:                      https://github.com/GitTools/GitVersion/blob/main/CONTRIBUTING.md
+[why]:                             https://gitversion.net/docs/learn/why
+[usage]:                           https://gitversion.net/docs/usage
+[how]:                             https://gitversion.net/docs/learn/how-it-works
+[faq]:                             https://gitversion.net/docs/learn/faq
+[who]:                             https://gitversion.net/docs/learn/who
+[gv-in-action]:                    https://raw.github.com/GitTools/GitVersion/master/docs/input/docs/img/README.png
+[banner]:                          https://github.com/GitTools/graphics/raw/master/GitVersion/banner-1280x640.png
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -10,6 +10,7 @@
         <PackageTags>Git;Versioning;GitVersion;GitFlowVersion;GitFlow;GitHubFlow;SemVer</PackageTags>
         <PackageLicenseExpression>MIT</PackageLicenseExpression>
         <PackageIcon>package_icon.png</PackageIcon>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
         <PackageReleaseNotes>https://github.com/GitTools/GitVersion/releases</PackageReleaseNotes>
 
         <RepositoryUrl>https://github.com/GitTools/GitVersion</RepositoryUrl>
@@ -76,10 +77,8 @@
     </ItemGroup>
 
     <ItemGroup>
-        <None Include="../../docs/input/docs/img/package_icon.png">
-            <Pack>true</Pack>
-            <PackagePath>/</PackagePath>
-        </None>
+        <None Include="../../docs/input/docs/img/package_icon.png" Pack="true" PackagePath="/"/>
+        <None Include="../../docs/README.md" Pack="true" PackagePath="/"/>
     </ItemGroup>
 
     <ItemGroup Condition=" '$(TargetFramework)' == 'net48' ">

diff --git a/src/NuGet.Config b/src/NuGet.Config