Add support for GitVersion.yml configuration file

Author: Guillaume Rouchon

GitVersionConfig.yaml renamed to GitVersion.yml

@@ -19,7 +19,7 @@ There are a number of sources GitVersion can get it's versions from, they includ
  - Version numbers in branches (i.e `release/2.0.0`)
  - Merge messages (for branches with versions in them, i.e `Merged branch 'release/2.0.0' into master`)
  - Track version of another branch (i.e develop tracks master, so when master increments so does develop)
- - GitVersionConfig.yaml file (i.e `next-version: 2.0.0`)
+ - GitVersion.yml file (i.e `next-version: 2.0.0`)
 
 Read more at [version sources](more-info/version-sources.md)
 

docs/index.md

@@ -39,8 +39,8 @@ The options for `commit-message-incrementing` are `Enabled`, `MergeMessageOnly`
 
 If the incrementing mode is set to `MergeMessageOnly` you can add this information in when merging a pull request. This prevents commits within a PR bumping the version.
 
-### GitVersionConfig.yaml
-The first is by setting the `next-version` property in the GitVersionConfig.yaml file. This property only serves as a base version,
+### GitVersion.yml
+The first is by setting the `next-version` property in the GitVersion.yml file. This property only serves as a base version,
 
 ### Branch name
 If you create a branch with the version number in the branch name such as `release-1.2.0` or `hotfix/1.0.1` then GitVersion will take the version number from the branch name as a source

docs/more-info/version-increments.md

@@ -26,7 +26,7 @@ If a branch with a version number in it is merged into the current branch, that
 
 Will increment: false
 
-### GitVersionConfig.yaml
+### GitVersion.yml
 If the `next-version` property is specified in the config file, it will be used as a version source.
 
 Will increment: false

docs/more-info/version-sources.md

@@ -17,7 +17,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		..\BREAKING CHANGES.md = ..\BREAKING CHANGES.md
 		..\Build.cmd = ..\Build.cmd
 		..\CONTRIBUTING.md = ..\CONTRIBUTING.md
-		..\GitVersionConfig.yaml = ..\GitVersionConfig.yaml
+		..\GitVersion.yml = ..\GitVersion.yml
 		..\LICENSE = ..\LICENSE
 		..\mkdocs.yml = ..\mkdocs.yml
 		..\README.md = ..\README.md

src/GitVersion.sln

@@ -62,7 +62,7 @@ public void CanReadOldDocument()
 ";
         SetupConfigFileContent(text);
         var error = Should.Throw<OldConfigurationException>(() => ConfigurationProvider.Provide(repoPath, fileSystem));
-        error.Message.ShouldContainWithoutWhitespace(@"GitVersionConfig.yaml contains old configuration, please fix the following errors:
+        error.Message.ShouldContainWithoutWhitespace(@"GitVersion configuration file contains old configuration, please fix the following errors:
 assemblyVersioningScheme has been replaced by assembly-versioning-scheme
 develop-branch-tag has been replaced by branch specific configuration.See http://gitversion.readthedocs.org/en/latest/configuration/#branch-configuration
 release-branch-tag has been replaced by branch specific configuration.See http://gitversion.readthedocs.org/en/latest/configuration/#branch-configuration");
@@ -209,8 +209,36 @@ public void VerifyAliases()
         propertiesMissingAlias.ShouldBeEmpty();
     }
 
-    void SetupConfigFileContent(string text)
+    [Test]
+    public void WarnOnExistingGitVersionConfigYamlFile()
+    {
+        SetupConfigFileContent(string.Empty, "GitVersionConfig.yaml");
+
+        var s = string.Empty;
+        Action<string> action = info => { s = info; };
+        Logger.SetLoggers(action, action, action);
+
+        ConfigurationProvider.Provide(repoPath, fileSystem);
+
+        s.Contains("'GitVersionConfig.yaml' is deprecated, use 'GitVersion.yml' instead.").ShouldBe(true);
+    }
+
+    [Test]
+    public void NoWarnOnGitVersionYmlFile()
+    {
+        SetupConfigFileContent(string.Empty);
+
+        var s = string.Empty;
+        Action<string> action = info => { s = info; };
+        Logger.SetLoggers(action, action, action);
+
+        ConfigurationProvider.Provide(repoPath, fileSystem);
+
+        s.Length.ShouldBe(0);
+    }
+
+    void SetupConfigFileContent(string text, string fileName = "GitVersion.yml")
     {
-        fileSystem.WriteAllText(Path.Combine(repoPath, "GitVersionConfig.yaml"), text);
+        fileSystem.WriteAllText(Path.Combine(repoPath, fileName), text);
     }
 }

src/GitVersionCore.Tests/ConfigProviderTests.cs

@@ -18,7 +18,7 @@ public void CanSetNextVersion()
             var testConsole = new TestConsole("3", "2.0.0", "0");
             ConfigurationProvider.Init("c:\\proj", testFileSystem, testConsole);
 
-            testFileSystem.ReadAllText("c:\\proj\\GitVersionConfig.yaml").ShouldMatchApproved();
+            testFileSystem.ReadAllText("c:\\proj\\GitVersion.yml").ShouldMatchApproved();
         }
 
         [Test]

src/GitVersionCore.Tests/Init/InitScenarios.cs

@@ -119,7 +119,7 @@ public static void ApplyBranchDefaults(Config config,
 
         static Config ReadConfig(string workingDirectory, IFileSystem fileSystem)
         {
-            var configFilePath = GetConfigFilePath(workingDirectory);
+            var configFilePath = GetConfigFilePath(workingDirectory, fileSystem);
 
             if (fileSystem.Exists(configFilePath))
             {
@@ -144,14 +144,28 @@ public static string GetEffectiveConfigAsString(string gitDirectory, IFileSystem
             return stringBuilder.ToString();
         }
 
-        static string GetConfigFilePath(string workingDirectory)
+        static string GetConfigFilePath(string workingDirectory, IFileSystem fileSystem)
         {
-            return Path.Combine(workingDirectory, "GitVersionConfig.yaml");
+            var ymlPath = Path.Combine(workingDirectory, "GitVersion.yml");
+            if (fileSystem.Exists(ymlPath))
+            {
+                return ymlPath;
+            }
+
+            var yamlPath = Path.Combine(workingDirectory, "GitVersionConfig.yaml");
+            if (fileSystem.Exists(yamlPath))
+            {
+                Logger.WriteWarning("'GitVersionConfig.yaml' is deprecated, use 'GitVersion.yml' instead.");
+
+                return yamlPath;
+            }
+
+            return ymlPath;
         }
 
         public static void Init(string workingDirectory, IFileSystem fileSystem, IConsole console)
         {
-            var configFilePath = GetConfigFilePath(workingDirectory);
+            var configFilePath = GetConfigFilePath(workingDirectory, fileSystem);
             var currentConfiguration = Provide(workingDirectory, fileSystem, applyDefaults: false);
             var config = new ConfigInitWizard(console, fileSystem).Run(currentConfiguration, workingDirectory);
             if (config == null) return;

src/GitVersionCore/Configuration/ConfigurationProvider.cs

@@ -27,7 +27,7 @@ public static void Notify(StringReader reader)
                 issues.Add("release-branch-tag has been replaced by branch specific configuration. See http://gitversion.readthedocs.org/en/latest/configuration/#branch-configuration");
 
             if (issues.Any())
-                throw new OldConfigurationException("GitVersionConfig.yaml contains old configuration, please fix the following errors:\r\n" + string.Join("\r\n", issues));
+                throw new OldConfigurationException("GitVersion configuration file contains old configuration, please fix the following errors:\r\n" + string.Join("\r\n", issues));
         }
     }
 }

src/GitVersionCore/Configuration/LegacyConfigNotifier.cs

@@ -9,7 +9,7 @@ public override IEnumerable<BaseVersion> GetVersions(GitVersionContext context)
             if (string.IsNullOrEmpty(context.Configuration.NextVersion) || context.IsCurrentCommitTagged)
                 yield break;
             var semanticVersion = SemanticVersion.Parse(context.Configuration.NextVersion, context.Configuration.GitTagPrefix);
-            yield return new BaseVersion("NextVersion in GitVersionConfig.yaml", false, semanticVersion, null, null);
+            yield return new BaseVersion("NextVersion in GitVersion configuration file", false, semanticVersion, null, null);
         }
     }
 }