Merge pull request #2146 from gitfool/gh2139

GH2139: GitVersion logging does not include newlines

Author: asbjornu

src/GitVersionCore.Tests/ConfigProviderTests.cs

@@ -96,7 +96,7 @@ public void RegexIsRequired()
         tag: bugfix";
             SetupConfigFileContent(text);
             var ex = Should.Throw<GitVersionConfigurationException>(() => configProvider.Provide(repoPath));
-            ex.Message.ShouldBe("Branch configuration 'bug' is missing required configuration 'regex'\n\n" +
+            ex.Message.ShouldBe($"Branch configuration 'bug' is missing required configuration 'regex'{System.Environment.NewLine}" +
                                 "See https://gitversion.net/docs/configuration/ for more info");
         }
 
@@ -111,7 +111,7 @@ public void SourceBranchIsRequired()
         tag: bugfix";
             SetupConfigFileContent(text);
             var ex = Should.Throw<GitVersionConfigurationException>(() => configProvider.Provide(repoPath));
-            ex.Message.ShouldBe("Branch configuration 'bug' is missing required configuration 'source-branches'\n\n" +
+            ex.Message.ShouldBe($"Branch configuration 'bug' is missing required configuration 'source-branches'{System.Environment.NewLine}" +
                                 "See https://gitversion.net/docs/configuration/ for more info");
         }
 

src/GitVersionCore.Tests/VariableProviderTests.cs

@@ -43,7 +43,9 @@ public void ShouldLogWarningWhenUsingDefaultInformationalVersionInCustomFormat()
                 Patch = 3,
             };
 
+#pragma warning disable CS0618 // Type or member is obsolete
             var propertyName = nameof(SemanticVersionFormatValues.DefaultInformationalVersion);
+#pragma warning restore CS0618 // Type or member is obsolete
             var config = new TestEffectiveConfiguration(assemblyInformationalFormat: $"{{{propertyName}}}");
             variableProvider.GetVariablesFor(semVer, config, false);
             logMessages.ShouldContain(message => message.Trim().StartsWith("WARN") && message.Contains(propertyName), 1, $"Expected a warning to be logged when using the variable {propertyName} in a configuration format template");

src/GitVersionCore/BuildServers/TeamCity.cs

@@ -34,11 +34,8 @@ public override string GetCurrentBranch(bool usingDynamicRepos)
         private void WriteBranchEnvVariableWarning()
         {
             Log.Warning(@"TeamCity doesn't make the current branch available through environmental variables.
-
 Depending on your authentication and transport setup of your git VCS root things may work. In that case, ignore this warning.
-
 In your TeamCity build configuration, add a parameter called `env.Git_Branch` with value %teamcity.build.vcs.branch.<vcsid>%
-
 See https://gitversion.net/docs/build-server-support/build-server/teamcity for more info");
         }
 

src/GitVersionCore/Configuration/BranchConfigurationCalculator.cs

@@ -145,7 +145,7 @@ private BranchConfig InheritBranchConfiguration(Branch targetBranch, BranchConfi
                 }
 
                 var branchName = chosenBranch.FriendlyName;
-                log.Warning(errorMessage + System.Environment.NewLine + System.Environment.NewLine + "Falling back to " + branchName + " branch config");
+                log.Warning(errorMessage + System.Environment.NewLine + "Falling back to " + branchName + " branch config");
 
                 // To prevent infinite loops, make sure that a new branch was chosen.
                 if (targetBranch.IsSameBranch(chosenBranch))

src/GitVersionCore/Configuration/ConfigExtensions.cs

@@ -88,14 +88,14 @@ public static void Reset(this Config config)
                 var regex = branchConfig.Value.Regex;
                 if (regex == null)
                 {
-                    throw new GitVersionConfigurationException($"Branch configuration '{branchConfig.Key}' is missing required configuration 'regex'\n\n" +
+                    throw new GitVersionConfigurationException($"Branch configuration '{branchConfig.Key}' is missing required configuration 'regex'{System.Environment.NewLine}" +
                                                                "See https://gitversion.net/docs/configuration/ for more info");
                 }
 
                 var sourceBranches = branchConfig.Value.SourceBranches;
                 if (sourceBranches == null)
                 {
-                    throw new GitVersionConfigurationException($"Branch configuration '{branchConfig.Key}' is missing required configuration 'source-branches'\n\n" +
+                    throw new GitVersionConfigurationException($"Branch configuration '{branchConfig.Key}' is missing required configuration 'source-branches'{System.Environment.NewLine}" +
                                                                "See https://gitversion.net/docs/configuration/ for more info");
                 }
 
@@ -189,7 +189,7 @@ public static BranchConfig GetConfigForBranch(this Config config, string branchN
             }
             catch (InvalidOperationException)
             {
-                var matchingConfigs = String.Concat(matches.Select(m => $"\n - {m.Key}"));
+                var matchingConfigs = String.Concat(matches.Select(m => $"{System.Environment.NewLine} - {m.Key}"));
                 var picked = matches
                     .Select(kvp => kvp.Value)
                     .First();

src/GitVersionCore/Configuration/Init/SetConfig/ConfigureBranches.cs

@@ -46,7 +46,7 @@ protected override string GetPrompt(Config config, string workingDirectory)
             return @"Which branch would you like to configure:
 
 0) Go Back
-" + string.Join("\r\n", OrderedBranches(config).Select((c, i) => $"{i + 1}) {c.Key}"));
+" + string.Join(System.Environment.NewLine, OrderedBranches(config).Select((c, i) => $"{i + 1}) {c.Key}"));
         }
 
         private static IOrderedEnumerable<KeyValuePair<string, BranchConfig>> OrderedBranches(Config config)

src/GitVersionCore/Configuration/Init/Wizard/FinishedSetupStep.cs

@@ -10,7 +10,7 @@ public FinishedSetupStep(IConsole console, IFileSystem fileSystem, ILog log, ICo
 
         protected override string GetPrompt(Config config, string workingDirectory)
         {
-            return "Questions are all done, you can now edit GitVersion's configuration further\r\n" + base.GetPrompt(config, workingDirectory);
+            return $"Questions are all done, you can now edit GitVersion's configuration further{System.Environment.NewLine}" + base.GetPrompt(config, workingDirectory);
         }
     }
 }

src/GitVersionCore/Configuration/Init/Wizard/GitFlowSetupStep.cs

@@ -11,7 +11,7 @@ public GitFlowSetupStep(IConsole console, IFileSystem fileSystem, ILog log, ICon
 
         protected override string GetPrompt(Config config, string workingDirectory)
         {
-            return "By default GitVersion will only increment the version of the 'develop' branch every commit, all other branches will increment when tagged\r\n\r\n" +
+            return $"By default GitVersion will only increment the version of the 'develop' branch every commit, all other branches will increment when tagged{System.Environment.NewLine}{System.Environment.NewLine}" +
                 base.GetPrompt(config, workingDirectory);
         }
     }

src/GitVersionCore/Configuration/Init/Wizard/GitHubFlowStep.cs

@@ -11,7 +11,7 @@ public GitHubFlowStep(IConsole console, IFileSystem fileSystem, ILog log, IConfi
 
         protected override string GetPrompt(Config config, string workingDirectory)
         {
-            return "By default GitVersion will only increment the version when tagged\r\n\r\n" + base.GetPrompt(config, workingDirectory);
+            return $"By default GitVersion will only increment the version when tagged{System.Environment.NewLine}{System.Environment.NewLine}" + base.GetPrompt(config, workingDirectory);
         }
     }
 }

src/GitVersionCore/GitRepoMetadataProvider.cs

@@ -218,8 +218,8 @@ public BranchCommit FindCommitBranchWasBranchedFrom(Branch branch, params Branch
                 if (possibleBranches.Count > 1)
                 {
                     var first = possibleBranches.First();
-                    log.Info($"Multiple source branches have been found, picking the first one ({first.Branch.FriendlyName}).\n" +
-                        "This may result in incorrect commit counting.\nOptions were:\n " +
+                    log.Info($"Multiple source branches have been found, picking the first one ({first.Branch.FriendlyName}).{System.Environment.NewLine}" +
+                        $"This may result in incorrect commit counting.{System.Environment.NewLine}Options were:{System.Environment.NewLine}" +
                         string.Join(", ", possibleBranches.Select(b => b.Branch.FriendlyName)));
                     return first;
                 }