Skip to content

Commit 8c29400

Browse files
committed
fix verbosity help information
1 parent 300fbaa commit 8c29400

File tree

8 files changed

+39
-20
lines changed

8 files changed

+39
-20
lines changed

src/GitVersionCore/Logging/ConsoleAppender.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,23 +23,23 @@ public void WriteTo(LogLevel level, string message)
2323
Console.BackgroundColor = backgroundColor;
2424
Console.ForegroundColor = foregroundColor;
2525

26-
if (level == LogLevel.Error)
26+
if (level == LogLevel.Error || level == LogLevel.Fatal)
2727
{
2828
Console.Error.Write(message);
2929
}
30-
else if (level != LogLevel.None)
30+
else
3131
{
3232
Console.Write(message);
3333
}
3434
}
3535
finally
3636
{
3737
Console.ResetColor();
38-
if (level == LogLevel.Error)
38+
if (level == LogLevel.Error || level == LogLevel.Fatal)
3939
{
4040
Console.Error.WriteLine();
4141
}
42-
else if (level != LogLevel.None)
42+
else
4343
{
4444
Console.WriteLine();
4545
}

src/GitVersionCore/Logging/FileAppender.cs

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,11 @@ public void WriteTo(LogLevel level, string message)
2424
{
2525
try
2626
{
27-
if (level != LogLevel.None)
28-
{
29-
WriteLogEntry(filePath, message);
30-
}
27+
WriteLogEntry(filePath, message);
3128
}
3229
catch (Exception)
3330
{
34-
//
31+
//
3532
}
3633
}
3734

src/GitVersionCore/Logging/LogExtensions.cs

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,26 @@ public static void Info(this ILog log, Verbosity verbosity, LogAction logAction)
6565
log?.Write(verbosity, LogLevel.Info, logAction);
6666
}
6767

68+
public static void Verbose(this ILog log, string format, params object[] args)
69+
{
70+
log?.Write(LogLevel.Verbose, format, args);
71+
}
72+
73+
public static void Verbose(this ILog log, Verbosity verbosity, string format, params object[] args)
74+
{
75+
log?.Write(verbosity, LogLevel.Verbose, format, args);
76+
}
77+
78+
public static void Verbose(this ILog log, LogAction logAction)
79+
{
80+
log?.Write(LogLevel.Verbose, logAction);
81+
}
82+
83+
public static void Verbose(this ILog log, Verbosity verbosity, LogAction logAction)
84+
{
85+
log?.Write(verbosity, LogLevel.Verbose, logAction);
86+
}
87+
6888
public static void Error(this ILog log, string format, params object[] args)
6989
{
7090
log?.Write(LogLevel.Error, format, args);
@@ -168,10 +188,12 @@ public static IDisposable WithVerbosity(this ILog log, Verbosity verbosity)
168188

169189
private static readonly IDictionary<LogLevel, Verbosity> VerbosityMaps = new Dictionary<LogLevel, Verbosity>
170190
{
191+
{ LogLevel.Verbose, Verbosity.Verbose },
171192
{ LogLevel.Debug, Verbosity.Diagnostic },
172193
{ LogLevel.Info, Verbosity.Normal },
173194
{ LogLevel.Warn, Verbosity.Minimal },
174195
{ LogLevel.Error, Verbosity.Quiet },
196+
{ LogLevel.Fatal, Verbosity.Quiet },
175197
};
176198
}
177199
}

src/GitVersionCore/Logging/LogLevel.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@ namespace GitVersion.Logging
22
{
33
public enum LogLevel
44
{
5-
None,
5+
Fatal,
66
Error,
77
Warn,
88
Info,
9+
Verbose,
910
Debug
1011
}
1112
}

src/GitVersionExe.Tests/HelpWriterTests.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ public void AllArgsAreInHelp()
3636
{ nameof(Arguments.IsVersion), "/version" },
3737
{ nameof(Arguments.UpdateWixVersionFile), "/updatewixversionfile" },
3838
{ nameof(Arguments.ConfigFile), "/config" },
39+
{ nameof(Arguments.Verbosity), "/verbosity" },
3940
};
4041
string helpText = null;
4142

src/GitVersionExe/ArgumentParser.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,7 @@ public Arguments ParseArguments(string[] commandLineArguments)
365365

366366
if (name.IsSwitch("verbosity"))
367367
{
368-
// first try the old version
368+
// first try the old version, this check will be removed in version 6.0.0, making it a breaking change
369369
if (Enum.TryParse(value, true, out LogLevel logLevel))
370370
{
371371
arguments.Verbosity = LogExtensions.GetVerbosityForLevel(logLevel);

src/GitVersionExe/HelpWriter.cs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,9 @@ All the GitVersion variables are written to 'GitVersion_WixVersion.wxi'.
8080
/execargs Arguments for the executable specified by /exec
8181
/proj Build a msbuild file, GitVersion variables will be passed as msbuild properties
8282
/projargs Additional arguments to pass to msbuild
83-
/verbosity Set Verbosity level (debug, info, warn, error, none). Default is info
84-
83+
/verbosity Specifies the amount of information to be displayed.
84+
(Quiet, Minimal, Normal, Verbose, Diagnostic)
85+
Default is Normal
8586
8687
gitversion init Configuration utility for gitversion
8788
";

src/GitVersionTask/MsBuildAppender.cs

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,11 @@ public void WriteTo(LogLevel level, string message)
1616
{
1717
try
1818
{
19-
if (level != LogLevel.None)
20-
{
21-
WriteLogEntry(level, message);
22-
}
19+
WriteLogEntry(level, message);
2320
}
2421
catch (Exception)
2522
{
26-
//
23+
//
2724
}
2825
}
2926

@@ -32,15 +29,15 @@ private void WriteLogEntry(LogLevel level, string str)
3229
var contents = $"{DateTime.Now:yyyy-MM-dd HH:mm:ss}\t\t{str}{System.Environment.NewLine}";
3330
switch (level)
3431
{
35-
case LogLevel.None:
36-
break;
32+
case LogLevel.Fatal:
3733
case LogLevel.Error:
3834
taskLog.LogError(contents);
3935
break;
4036
case LogLevel.Warn:
4137
taskLog.LogWarning(contents);
4238
break;
4339
case LogLevel.Info:
40+
case LogLevel.Verbose:
4441
case LogLevel.Debug:
4542
taskLog.LogMessage(contents);
4643
break;

0 commit comments

Comments
 (0)