Added 'GitVersion init' command which creates a sample GitVersionConfig.yaml file

JakeGinnivan · JakeGinnivan · commit 93460fa06b51 · 2014-12-05T10:48:35.000Z
diff --git a/GitVersionCore.Tests/ConfigReaderTests.cs b/GitVersionCore.Tests/ConfigReaderTests.cs
@@ -1,7 +1,10 @@
 using System.IO;
+using System.Linq;
+using System.Reflection;
 using GitVersion;
 using NUnit.Framework;
 using Shouldly;
+using YamlDotNet.Serialization;
 
 [TestFixture]
 public class ConfigReaderTests
@@ -11,15 +14,17 @@ public class ConfigReaderTests
     public void CanReadDocument()
     {
         const string text = @"
-assemblyVersioningScheme: MajorMinor
+assembly-versioning-scheme: MajorMinor
 develop-branch-tag: alpha
 release-branch-tag: rc
+next-version: 2.0.0
 tag-prefix: '[vV|version-]'
 ";
         var config = ConfigReader.Read(new StringReader(text));
         config.AssemblyVersioningScheme.ShouldBe(AssemblyVersioningScheme.MajorMinor);
         config.DevelopBranchTag.ShouldBe("alpha");
         config.ReleaseBranchTag.ShouldBe("rc");
+        config.NextVersion.ShouldBe("2.0.0");
         config.TagPrefix.ShouldBe("[vV|version-]");
     }
 
@@ -32,5 +37,31 @@ public void CanReadDefaultDocument()
         config.DevelopBranchTag.ShouldBe("unstable");
         config.ReleaseBranchTag.ShouldBe("beta");
         config.TagPrefix.ShouldBe("[vV]");
+        config.NextVersion.ShouldBe(null);
+    }
+
+    [Test]
+    public void VerifyInit()
+    {
+        var config = typeof(Config);
+        var aliases = config.GetProperties().Select(p => ((YamlAliasAttribute) p.GetCustomAttribute(typeof(YamlAliasAttribute))).Alias);
+        var writer = new StringWriter();
+
+        ConfigReader.WriteSample(writer);
+        var initFile = writer.GetStringBuilder().ToString();
+
+        foreach (var alias in aliases)
+        {
+            initFile.ShouldContain(alias);
+        }
+    }
+
+    [Test]
+    public void VerifyAliases()
+    {
+        var config = typeof(Config);
+        var propertiesMissingAlias = config.GetProperties().Where(p => p.GetCustomAttribute(typeof(YamlAliasAttribute)) == null).Select(p => p.Name);
+
+        propertiesMissingAlias.ShouldBeEmpty();
     }
 }
diff --git a/GitVersionCore.Tests/GitVersionCore.Tests.csproj b/GitVersionCore.Tests/GitVersionCore.Tests.csproj
@@ -60,6 +60,10 @@
     <Reference Include="System.Data.DataSetExtensions" />
     <Reference Include="System.Data" />
     <Reference Include="System.Xml" />
+    <Reference Include="YamlDotNet, Version=3.3.0.0, Culture=neutral, processorArchitecture=MSIL">
+      <SpecificVersion>False</SpecificVersion>
+      <HintPath>..\packages\YamlDotNet.3.3.1\lib\net35\YamlDotNet.dll</HintPath>
+    </Reference>
   </ItemGroup>
   <ItemGroup>
     <Compile Include="..\GitVersionTask.Tests\Helpers\DirectoryHelper.cs">
diff --git a/GitVersionCore.Tests/SemanticVersionTests.cs b/GitVersionCore.Tests/SemanticVersionTests.cs
@@ -8,7 +8,6 @@ public class SemanticVersionTests
 
     [TestCase("1.2.3", 1, 2, 3, null, null, null, null, null, null, null)]
     [TestCase("1.2", 1, 2, 0, null, null, null, null, null, null, "1.2.0")]
-    [TestCase("1", 1, 0, 0, null, null, null, null, null, null, "1.0.0")]
     [TestCase("1.2.3-beta", 1, 2, 3, "beta", null, null, null, null, null, null)]
     [TestCase("1.2.3-beta3", 1, 2, 3, "beta", 3, null, null, null, null, "1.2.3-beta.3")]
     [TestCase("1.2.3-alpha", 1, 2, 3, "alpha", null, null, null, null, null, null)]
diff --git a/GitVersionCore.Tests/packages.config b/GitVersionCore.Tests/packages.config
@@ -6,4 +6,5 @@
   <package id="LibGit2Sharp" version="0.19.0.0" targetFramework="net45" />
   <package id="NUnit" version="2.6.3" targetFramework="net45" />
   <package id="Shouldly" version="2.2.0" targetFramework="net45" />
+  <package id="YamlDotNet" version="3.3.1" targetFramework="net45" />
 </packages>
diff --git a/GitVersionCore/AssemblyVersioningScheme.cs b/GitVersionCore/AssemblyVersioningScheme.cs
@@ -5,6 +5,6 @@ public enum AssemblyVersioningScheme
         MajorMinorPatchMetadata,
         MajorMinorPatch,
         MajorMinor,
-        Major,
+        Major
     }
 }
diff --git a/GitVersionCore/Configuration/Config.cs b/GitVersionCore/Configuration/Config.cs
@@ -12,6 +12,7 @@ public Config()
             TagPrefix = "[vV]";
         }
 
+        [YamlAlias("assembly-versioning-scheme")]
         public AssemblyVersioningScheme AssemblyVersioningScheme { get; set; }
 
         [YamlAlias("develop-branch-tag")]
diff --git a/GitVersionCore/Configuration/ConfigReader.cs b/GitVersionCore/Configuration/ConfigReader.cs
@@ -16,5 +16,14 @@ public static Config Read(TextReader reader)
             }
             return deserialize;
         }
+
+        public static void WriteSample(TextWriter writer)
+        {
+            writer.WriteLine("# assembly-versioning-scheme: MajorMinorPatchMetadata | MajorMinorPatch | MajorMinor | Major");
+            writer.WriteLine("# develop-branch-tag: alpha");
+            writer.WriteLine("# release-branch-tag: rc");
+            writer.WriteLine("# tag-prefix: '[vV|version-] # regex to match git tag prefix");
+            writer.WriteLine("# next-version: 1.0.0");
+        }
     }
 }
diff --git a/GitVersionCore/Configuration/ConfigurationProvider.cs b/GitVersionCore/Configuration/ConfigurationProvider.cs
@@ -6,7 +6,7 @@ public class ConfigurationProvider
     {
         public static Config Provide(string gitDirectory)
         {
-            var configFilePath = Path.Combine(Directory.GetParent(gitDirectory).FullName, "GitVersionConfig.yaml");
+            var configFilePath = GetConfigFilePath(gitDirectory);
             if (File.Exists(configFilePath))
             {
                 using (var reader = File.OpenText(configFilePath))
@@ -17,5 +17,25 @@ public static Config Provide(string gitDirectory)
 
             return new Config();
         }
+
+        public static void WriteSample(string gitDirectory)
+        {
+            var configFilePath = GetConfigFilePath(gitDirectory);
+
+            if (!File.Exists(configFilePath))
+            {
+                using (var stream = File.OpenWrite(configFilePath))
+                using (var writer = new StreamWriter(stream))
+                {
+                    ConfigReader.WriteSample(writer);
+                }
+            }
+            // TODO else write warning?
+        }
+
+        static string GetConfigFilePath(string gitDirectory)
+        {
+            return Path.Combine(Directory.GetParent(gitDirectory).FullName, "GitVersionConfig.yaml");
+        }
     }
 }
diff --git a/GitVersionCore/GitFlow/BranchFinders/VersionOnMasterFinder.cs b/GitVersionCore/GitFlow/BranchFinders/VersionOnMasterFinder.cs
@@ -39,9 +39,5 @@ public VersionPoint Execute(GitVersionContext context, DateTimeOffset olderThan)
             };
         }
 
-    
-
-
-
     }
 }
diff --git a/GitVersionCore/GitVersionCore.csproj b/GitVersionCore/GitVersionCore.csproj
@@ -53,8 +53,9 @@
       <SpecificVersion>False</SpecificVersion>
       <HintPath>..\Packages\Visualize.Fody.0.4.0.0\Lib\portable-net4+sl4+wp7+win8+MonoAndroid16+MonoTouch40\Visualize.dll</HintPath>
     </Reference>
-    <Reference Include="YamlDotNet">
-      <HintPath>..\packages\YamlDotNet.3.3.0\lib\net35\YamlDotNet.dll</HintPath>
+    <Reference Include="YamlDotNet, Version=3.3.0.0, Culture=neutral, processorArchitecture=MSIL">
+      <SpecificVersion>False</SpecificVersion>
+      <HintPath>..\packages\YamlDotNet.3.3.1\lib\net35\YamlDotNet.dll</HintPath>
     </Reference>
   </ItemGroup>
   <ItemGroup>
diff --git a/GitVersionCore/SemanticVersion.cs b/GitVersionCore/SemanticVersion.cs
@@ -6,7 +6,7 @@ namespace GitVersion
     public class SemanticVersion : IFormattable, IComparable<SemanticVersion>
     {
         static Regex ParseSemVer = new Regex(
-            @"(?<SemVer>(?<Major>\d+)(\.(?<Minor>\d+))?(\.(?<Patch>\d+))?)(\.(?<FourthPart>\d+))?(-(?<Tag>[^\+]*))?(\+(?<BuildMetaData>.*))?",
+            @"(?<SemVer>(?<Major>\d+)(\.(?<Minor>\d+))(\.(?<Patch>\d+))?)(\.(?<FourthPart>\d+))?(-(?<Tag>[^\+]*))?(\+(?<BuildMetaData>.*))?",
             RegexOptions.Compiled);
 
         public int Major;
diff --git a/GitVersionCore/packages.config b/GitVersionCore/packages.config
@@ -6,4 +6,5 @@
   <package id="LibGit2Sharp" version="0.19.0.0" targetFramework="net40" />
   <package id="PepitaPackage" version="1.21.3" targetFramework="net40" developmentDependency="true" />
   <package id="Visualize.Fody" version="0.4.0.0" targetFramework="net40" developmentDependency="true" />
+  <package id="YamlDotNet" version="3.3.1" targetFramework="net40" />
 </packages>
diff --git a/GitVersionExe/ArgumentParser.cs b/GitVersionExe/ArgumentParser.cs
@@ -37,6 +37,14 @@ public static Arguments ParseArguments(List<string> commandLineArguments)
                     IsHelp = true
                 };
             }
+            if (IsInit(firstArgument))
+            {
+                return new Arguments
+                {
+                    TargetPath = Environment.CurrentDirectory,
+                    Init = true
+                };
+            }
 
             if (commandLineArguments.Count == 1)
             {
@@ -190,6 +198,11 @@ static bool IsSwitch(string switchName, string value)
             return (string.Equals(switchName, value, StringComparison.InvariantCultureIgnoreCase));
         }
 
+        static bool IsInit(string singleArgument)
+        {
+            return singleArgument.Equals("init", StringComparison.InvariantCultureIgnoreCase);
+        }
+
         static bool IsHelp(string singleArgument)
         {
             return (singleArgument == "?") ||
diff --git a/GitVersionExe/Arguments.cs b/GitVersionExe/Arguments.cs
@@ -15,6 +15,7 @@ public Arguments()
         public string TargetUrl;
         public string TargetBranch;
 
+        public bool Init;
 
         public bool IsHelp;
         public string LogFilePath;
diff --git a/GitVersionExe/Program.cs b/GitVersionExe/Program.cs
@@ -69,6 +69,12 @@ static int Run()
                     return 1;
                 }
 
+                if (arguments.Init)
+                {
+                    ConfigurationProvider.WriteSample(gitDirectory);
+                    return 0;
+                }
+
                 var workingDirectory = Directory.GetParent(gitDirectory).FullName;
                 Logger.WriteInfo("Working directory: " + workingDirectory);
                 var applicableBuildServers = GetApplicableBuildServers(arguments.Authentication).ToList();
diff --git a/GitVersionTask.Tests/MergeMessageParserTests.cs b/GitVersionTask.Tests/MergeMessageParserTests.cs
@@ -22,7 +22,9 @@ public class MergeMessageParserTests
     [TestCase("Merge pull request #165 from Particular/release-1.0.0", true, "1.0.0")]
     [TestCase("Merge pull request #95 from Particular/issue-94", false, null)]
     [TestCase("Merge pull request #165 in Particular/release-1.0.0", true, "1.0.0")]
+    [TestCase("Merge pull request #95 in Particular/issue-94", true, null)]
     [TestCase("Merge pull request #95 in Particular/issue-94", false, null)]
+    [TestCase("Merge pull request #64 from arledesma/feature-VS2013_3rd_party_test_framework_support", true, null)]
     [TestCase("Finish Release-0.12.0", true, "0.12.0")] //Support Syntevo SmartGit/Hg's Gitflow merge commit messages for finishing a 'Release' branch
     [TestCase("Finish 0.14.1", true, "0.14.1")] //Support Syntevo SmartGit/Hg's Gitflow merge commit messages for finishing a 'Hotfix' branch
     public void AssertMergeMessage(string message, bool isMergeCommit, string expectedVersion)

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,6 @@ public enum AssemblyVersioningScheme`
`5`	`5`	`MajorMinorPatchMetadata,`
`6`	`6`	`MajorMinorPatch,`
`7`	`7`	`MajorMinor,`
`8`		`- Major,`
	`8`	`+ Major`
`9`	`9`	`}`
`10`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ public Config()`
`12`	`12`	`TagPrefix = "[vV]";`
`13`	`13`	`}`
`14`	`14`
	`15`	`+ [YamlAlias("assembly-versioning-scheme")]`
`15`	`16`	`public AssemblyVersioningScheme AssemblyVersioningScheme { get; set; }`
`16`	`17`
`17`	`18`	`[YamlAlias("develop-branch-tag")]`
Original file line number	Diff line number	Diff line change
`@@ -16,5 +16,14 @@ public static Config Read(TextReader reader)`
`16`	`16`	`}`
`17`	`17`	`return deserialize;`
`18`	`18`	`}`
	`19`	`+`
	`20`	`+ public static void WriteSample(TextWriter writer)`
	`21`	`+ {`
	`22`	`+ writer.WriteLine("# assembly-versioning-scheme: MajorMinorPatchMetadata \| MajorMinorPatch \| MajorMinor \| Major");`
	`23`	`+ writer.WriteLine("# develop-branch-tag: alpha");`
	`24`	`+ writer.WriteLine("# release-branch-tag: rc");`
	`25`	`+ writer.WriteLine("# tag-prefix: '[vV\|version-] # regex to match git tag prefix");`
	`26`	`+ writer.WriteLine("# next-version: 1.0.0");`
	`27`	`+ }`
`19`	`28`	`}`
`20`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ public class ConfigurationProvider`
`6`	`6`	`{`
`7`	`7`	`public static Config Provide(string gitDirectory)`
`8`	`8`	`{`
`9`		`- var configFilePath = Path.Combine(Directory.GetParent(gitDirectory).FullName, "GitVersionConfig.yaml");`
	`9`	`+ var configFilePath = GetConfigFilePath(gitDirectory);`
`10`	`10`	`if (File.Exists(configFilePath))`
`11`	`11`	`{`
`12`	`12`	`using (var reader = File.OpenText(configFilePath))`
`@@ -17,5 +17,25 @@ public static Config Provide(string gitDirectory)`
`17`	`17`
`18`	`18`	`return new Config();`
`19`	`19`	`}`
	`20`	`+`
	`21`	`+ public static void WriteSample(string gitDirectory)`
	`22`	`+ {`
	`23`	`+ var configFilePath = GetConfigFilePath(gitDirectory);`
	`24`	`+`
	`25`	`+ if (!File.Exists(configFilePath))`
	`26`	`+ {`
	`27`	`+ using (var stream = File.OpenWrite(configFilePath))`
	`28`	`+ using (var writer = new StreamWriter(stream))`
	`29`	`+ {`
	`30`	`+ ConfigReader.WriteSample(writer);`
	`31`	`+ }`
	`32`	`+ }`
	`33`	`+ // TODO else write warning?`
	`34`	`+ }`
	`35`	`+`
	`36`	`+ static string GetConfigFilePath(string gitDirectory)`
	`37`	`+ {`
	`38`	`+ return Path.Combine(Directory.GetParent(gitDirectory).FullName, "GitVersionConfig.yaml");`
	`39`	`+ }`
`20`	`40`	`}`
`21`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,9 +39,5 @@ public VersionPoint Execute(GitVersionContext context, DateTimeOffset olderThan)`
`39`	`39`	`};`
`40`	`40`	`}`
`41`	`41`
`42`		`-`
`43`		`-`
`44`		`-`
`45`		`-`
`46`	`42`	`}`
`47`	`43`	`}`