Browse Source

updated build props with docs

Charlie Kindel 4 years ago
parent
commit
fe6a651fa9
1 changed files with 21 additions and 14 deletions
  1. 21 14
      Terminal.Gui/Directory.Build.props

+ 21 - 14
Terminal.Gui/Directory.Build.props

@@ -2,20 +2,27 @@
 
   <PropertyGroup>
     <!--
-       This file determines version info for Terminal.Gui
-       - Uses this guidance: https://docs.microsoft.com/en-us/dotnet/standard/library-guidance/versioning
-       - Use major.minor.build.revision
-       - Version 
-          - Used for Nuget. Changing it will cause a new nuget package to be generated when a PR is merged to master as part of CI/CD.
-          - Version should be of the form major.minor.build[-pre].revision where [-pre] indicates it's a pre-release.
-          - Miguel can hide defunct/old nuget packages.
-       - AssemblyVersion & FileVersion are for the assembly. 
-          - Use major.minor.build.revision - revision is the same as used in Version
-          
-       e.g. If AssemblyVersion is 1.2.3.4, Version could be EITHER 1.2.3.4 or 1.2.3-pre.4 depending on whether it's a pre-release or not.
-    <Version>1.0.0-pre.8</Version>
-    <AssemblyVersion>1.0.0.8</AssemblyVersion>
-    <FileVersion>1.0.0.8</FileVersion>    
+       Version info for Terminal.Gui is managed by MinVer (https://github.com/adamralph/minver)
+       
+       - To release a new version simply tag at commit
+
+      git tag major.minor.patch.build.height
+      
+      // patch can indicate pre-release or not
+
+       e.g: 
+       
+       git tag 1.3.4-beta.5
+       
+          or
+       
+       git tag 2.3.4.5
+       
+       Then build.
+       
+       - When the .revision changes a new nuget package will be generated when a PR is merged to master as part of CI/CD.
+
+       - Miguel can hide defunct/old nuget packages.
     -->
     <Authors>Miguel de Icaza, Charlie Kindel (@tig), @BDisp</Authors>
   </PropertyGroup>