Support for dotted versions of the GitVersion config files by default

follow the convention of having a leading dot for
config files used e.g. for .gitignore, .editorconfig, .gitattributes, etc

Author: Bi0T1N

docs/input/docs/usage/cli/arguments.md

@@ -41,9 +41,9 @@ GitVersion [path]
                     E.g. /output json /format {SemVer} - will output `1.2.3+beta.4`
                          /output json /format {Major}.{Minor} - will output `1.2`
     /l              Path to logfile.
-    /config         Path to config file (defaults to GitVersion.yml or GitVersion.yaml)
+    /config         Path to config file (defaults to GitVersion.yml, GitVersion.yaml, .GitVersion.yml or .GitVersion.yaml)
     /showconfig     Outputs the effective GitVersion config (defaults + custom
-                    from GitVersion.yml or GitVersion.yaml) in yaml format
+                    from GitVersion.yml, GitVersion.yaml, .GitVersion.yml or .GitVersion.yaml) in yaml format
     /overrideconfig Overrides GitVersion config values inline (semicolon-
                     separated key value pairs e.g. /overrideconfig
                     tag-prefix=Foo)
@@ -97,7 +97,7 @@ GitVersion [path]
 
 ## Override config
 
-`/overrideconfig [key=value]` will override appropriate `key` from 'GitVersion.yml' or 'GitVersion.yaml'.
+`/overrideconfig [key=value]` will override appropriate `key` from 'GitVersion.yml', 'GitVersion.yaml', '.GitVersion.yml' or '.GitVersion.yaml'.
 
 To specify multiple options add multiple `/overrideconfig [key=value]` entries:
 `/overrideconfig key1=value1 /overrideconfig key2=value2`.
@@ -129,7 +129,7 @@ Following options are supported:
 
 Read more about [Configuration](/docs/reference/configuration).
 
-Using `override-config` on the command line will not change the contents of the config file `GitVersion.yml` or `GitVersion.yaml`.
+Using `override-config` on the command line will not change the contents of the config file `GitVersion.yml`, `GitVersion.yaml`, `.GitVersion.yml` or `.GitVersion.yaml`.
 
 ### Example: How to override configuration option 'tag-prefix' to use prefix 'custom'
 

src/GitVersion.App/OverrideConfigurationOptionParser.cs

@@ -18,7 +18,7 @@ internal class OverrideConfigurationOptionParser
     /// </summary>
     /// <returns></returns>
     /// <remarks>
-    /// Lookup keys are created from <see cref="System.Text.Json.Serialization.JsonPropertyNameAttribute"/> to match 'GitVersion.yml' or 'GitVersion.yaml' file
+    /// Lookup keys are created from <see cref="System.Text.Json.Serialization.JsonPropertyNameAttribute"/> to match 'GitVersion.yml', 'GitVersion.yaml', '.GitVersion.yml' or '.GitVersion.yaml' file
     /// options as close as possible.
     /// </remarks>
     private static ILookup<string?, PropertyInfo> GetSupportedProperties() => typeof(GitVersionConfiguration).GetProperties(BindingFlags.Public | BindingFlags.Instance)

src/GitVersion.Configuration.Tests/Configuration/ConfigurationFileLocatorTests.cs

@@ -37,8 +37,20 @@ public void Setup()
 
         [TestCase(ConfigurationFileLocator.DefaultFileName, ConfigurationFileLocator.DefaultFileName)]
         [TestCase(ConfigurationFileLocator.DefaultFileName, ConfigurationFileLocator.DefaultAlternativeFileName)]
+        [TestCase(ConfigurationFileLocator.DefaultFileName, ConfigurationFileLocator.DefaultFileNameDotted)]
+        [TestCase(ConfigurationFileLocator.DefaultFileName, ConfigurationFileLocator.DefaultAlternativeFileNameDotted)]
         [TestCase(ConfigurationFileLocator.DefaultAlternativeFileName, ConfigurationFileLocator.DefaultFileName)]
         [TestCase(ConfigurationFileLocator.DefaultAlternativeFileName, ConfigurationFileLocator.DefaultAlternativeFileName)]
+        [TestCase(ConfigurationFileLocator.DefaultAlternativeFileName, ConfigurationFileLocator.DefaultFileNameDotted)]
+        [TestCase(ConfigurationFileLocator.DefaultAlternativeFileName, ConfigurationFileLocator.DefaultAlternativeFileNameDotted)]
+        [TestCase(ConfigurationFileLocator.DefaultFileNameDotted, ConfigurationFileLocator.DefaultFileName)]
+        [TestCase(ConfigurationFileLocator.DefaultFileNameDotted, ConfigurationFileLocator.DefaultAlternativeFileName)]
+        [TestCase(ConfigurationFileLocator.DefaultFileNameDotted, ConfigurationFileLocator.DefaultFileNameDotted)]
+        [TestCase(ConfigurationFileLocator.DefaultFileNameDotted, ConfigurationFileLocator.DefaultAlternativeFileNameDotted)]
+        [TestCase(ConfigurationFileLocator.DefaultAlternativeFileNameDotted, ConfigurationFileLocator.DefaultFileName)]
+        [TestCase(ConfigurationFileLocator.DefaultAlternativeFileNameDotted, ConfigurationFileLocator.DefaultAlternativeFileName)]
+        [TestCase(ConfigurationFileLocator.DefaultAlternativeFileNameDotted, ConfigurationFileLocator.DefaultFileNameDotted)]
+        [TestCase(ConfigurationFileLocator.DefaultAlternativeFileNameDotted, ConfigurationFileLocator.DefaultAlternativeFileNameDotted)]
         public void ThrowsExceptionOnAmbiguousConfigFileLocation(string repoConfigFile, string workingConfigFile)
         {
             using var repositoryConfigFilePath = this.fileSystem.SetupConfigFile(path: this.repoPath, fileName: repoConfigFile);
@@ -52,6 +64,8 @@ public void ThrowsExceptionOnAmbiguousConfigFileLocation(string repoConfigFile,
 
         [TestCase(ConfigurationFileLocator.DefaultFileName)]
         [TestCase(ConfigurationFileLocator.DefaultAlternativeFileName)]
+        [TestCase(ConfigurationFileLocator.DefaultFileNameDotted)]
+        [TestCase(ConfigurationFileLocator.DefaultAlternativeFileNameDotted)]
         public void NoWarnOnGitVersionYmlFile(string configurationFile)
         {
             using var _ = this.fileSystem.SetupConfigFile(path: this.repoPath, fileName: configurationFile);

src/GitVersion.Configuration/ConfigurationFileLocator.cs

@@ -13,6 +13,9 @@ internal class ConfigurationFileLocator(
 {
     public const string DefaultFileName = "GitVersion.yml";
     public const string DefaultAlternativeFileName = "GitVersion.yaml";
+    public const string DefaultFileNameDotted = $".{DefaultFileName}";
+    public const string DefaultAlternativeFileNameDotted = $".{DefaultAlternativeFileName}";
+    public List<string> PossibleConfigFileNames = [DefaultFileName, DefaultAlternativeFileName, DefaultFileNameDotted, DefaultAlternativeFileNameDotted];
 
     private readonly IFileSystem fileSystem = fileSystem.NotNull();
     private readonly ILog log = log.NotNull();
@@ -30,11 +33,17 @@ public void Verify(string? workingDirectory, string? projectRootDirectory)
     public string? GetConfigurationFile(string? directory)
     {
         if (directory is null) return null;
-        string?[] candidates = [this.ConfigurationFile, DefaultFileName, DefaultAlternativeFileName];
-        var candidatePaths =
-            from candidate in candidates
-            where !candidate.IsNullOrWhiteSpace()
-            select PathHelper.Combine(directory, candidate);
+        var candidateList = new List<string>(PossibleConfigFileNames);
+        if (!this.ConfigurationFile.IsNullOrEmpty())
+        {
+            // give configuration value the highest priority
+            candidateList.Insert(0, this.ConfigurationFile);
+        }
+
+        var candidatePaths = candidateList
+            .Where(candidate => !string.IsNullOrWhiteSpace(candidate))
+            .Select(candidate => PathHelper.Combine(directory, candidate))
+            .ToList();
 
         foreach (var candidatePath in candidatePaths)
         {
@@ -65,7 +74,7 @@ private void WarnAboutAmbiguousConfigFileSelection(string? workingDirectory, str
 
         if (!hasConfigInProjectRootDirectory && !hasConfigInWorkingDirectory)
         {
-            if (this.ConfigurationFile is not (DefaultFileName or DefaultAlternativeFileName))
+            if (!PossibleConfigFileNames.Any(entry => entry.Equals(this.ConfigurationFile)))
             {
                 workingConfigFile = PathHelper.Combine(workingDirectory, this.ConfigurationFile);
                 projectRootConfigFile = PathHelper.Combine(projectRootDirectory, this.ConfigurationFile);

src/GitVersion.Core.Tests/Core/GitVersionExecutorTests.cs

@@ -243,6 +243,8 @@ public void CacheFileIsMissing()
 
     [TestCase(ConfigurationFileLocator.DefaultFileName)]
     [TestCase(ConfigurationFileLocator.DefaultAlternativeFileName)]
+    [TestCase(ConfigurationFileLocator.DefaultFileNameDotted)]
+    [TestCase(ConfigurationFileLocator.DefaultAlternativeFileNameDotted)]
     public void ConfigChangeInvalidatesCache(string configFileName)
     {
         const string versionCacheFileContent = """