Skip to content

Commit 3294566

Browse files
committed
Merge branch 'release/1.1.0'
2 parents 5b489e2 + 89cf13c commit 3294566

32 files changed

+473
-184
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@ paket-files/
349349
.fake/
350350

351351
# CodeRush personal settings
352-
.cr/personal
352+
**/.cr/personal
353353

354354
# Python Tools for Visual Studio (PTVS)
355355
__pycache__/

Cake.Frosting.Issues.Recipe/.cr/personal/FavoritesList/List.xml

Lines changed: 0 additions & 6 deletions
This file was deleted.

Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe.csproj

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
<PropertyGroup>
44
<TargetFramework>netstandard2.0</TargetFramework>
55
<DocumentationFile>bin\$(Configuration)\$(TargetFramework)\Cake.Frosting.Issues.Recipe.xml</DocumentationFile>
6+
<EnableNETAnalyzers>true</EnableNETAnalyzers>
7+
<AnalysisMode>AllEnabledByDefault</AnalysisMode>
68
</PropertyGroup>
79

810
<PropertyGroup>
@@ -22,7 +24,7 @@ For recipe compatible with Cake Script Runners see Cake.Issues.Recipe.</Descript
2224
<PackageLicenseExpression>MIT</PackageLicenseExpression>
2325
<RepositoryType>git</RepositoryType>
2426
<RepositoryUrl>https://github.com/cake-contrib/Cake.Issues.Recipe.git</RepositoryUrl>
25-
<PackageReleaseNotes>https://github.com/cake-contrib/Cake.Issues.Recipe/releases/tag/1.0.0</PackageReleaseNotes>
27+
<PackageReleaseNotes>https://github.com/cake-contrib/Cake.Issues.Recipe/releases/tag/1.1.0</PackageReleaseNotes>
2628
</PropertyGroup>
2729

2830
<ItemGroup>
@@ -36,7 +38,7 @@ For recipe compatible with Cake Script Runners see Cake.Issues.Recipe.</Descript
3638
<ItemGroup>
3739
<PackageReference Include="Cake.AzureDevOps" Version="1.0.0" />
3840
<PackageReference Include="Cake.Frosting" Version="1.0.0" PrivateAssets="All" />
39-
<PackageReference Include="Cake.Git" Version="1.0.1" />
41+
<PackageReference Include="Cake.Git" Version="1.1.0" />
4042
<PackageReference Include="Cake.Issues" Version="1.0.0" />
4143
<PackageReference Include="Cake.Issues.DupFinder" Version="1.0.0" />
4244
<PackageReference Include="Cake.Issues.EsLint" Version="1.0.1" />

Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/Context/Parameters/IssuesParametersReporting.cs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
using Cake.Issues.Reporting.Generic;
2+
13
namespace Cake.Frosting.Issues.Recipe
24
{
35
/// <summary>
@@ -10,5 +12,15 @@ public class IssuesParametersReporting
1012
/// Default value is <c>true</c>.
1113
/// </summary>
1214
public bool ShouldCreateFullIssuesReport { get; set; } = true;
15+
16+
/// <summary>
17+
/// Gets the settings for the full issues report.
18+
/// By default <see cref="GenericIssueReportTemplate.HtmlDxDataGrid"/> template is used
19+
/// with <see cref="DevExtremeTheme.MaterialBlueLight"/> theme.
20+
/// </summary>
21+
public GenericIssueReportFormatSettings FullIssuesReportSettings { get; } =
22+
GenericIssueReportFormatSettings
23+
.FromEmbeddedTemplate(GenericIssueReportTemplate.HtmlDxDataGrid)
24+
.WithOption(HtmlDxDataGridOption.Theme, DevExtremeTheme.MaterialBlueLight);
1325
}
1426
}

Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/Context/State/IssuesState.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ private static IIssuesBuildServer DetermineBuildServer(IssuesContext context)
181181
!string.IsNullOrWhiteSpace(context.EnvironmentVariable("SYSTEM_COLLECTIONURI")) &&
182182
(
183183
new Uri(context.EnvironmentVariable("SYSTEM_COLLECTIONURI")).Host == "dev.azure.com" ||
184-
new Uri(context.EnvironmentVariable("SYSTEM_COLLECTIONURI")).Host.EndsWith("visualstudio.com")
184+
new Uri(context.EnvironmentVariable("SYSTEM_COLLECTIONURI")).Host.EndsWith("visualstudio.com", StringComparison.InvariantCulture)
185185
))
186186
{
187187
context.Information("Build server detected: {0}", "Azure Pipelines");
@@ -221,7 +221,7 @@ private static IIssuesPullRequestSystem DeterminePullRequestSystem(IssuesContext
221221
throw new ArgumentNullException(nameof(repositoryUrl));
222222
}
223223

224-
if (repositoryUrl.Host == "dev.azure.com" || repositoryUrl.Host.EndsWith("visualstudio.com"))
224+
if (repositoryUrl.Host == "dev.azure.com" || repositoryUrl.Host.EndsWith("visualstudio.com", StringComparison.InvariantCulture))
225225
{
226226
context.Information("Pull request system detected: {0}", "Azure Repos");
227227
return new AzureDevOpsPullRequestSystem();

Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/CreateFullIssuesReportTask.cs

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
using Cake.Common.IO;
2+
using Cake.Issues;
23
using Cake.Issues.Reporting;
34
using Cake.Issues.Reporting.Generic;
45

@@ -14,12 +15,16 @@ public sealed class CreateFullIssuesReportTask : FrostingTask<IssuesContext>
1415
/// <inheritdoc/>
1516
public override bool ShouldRun(IssuesContext context)
1617
{
18+
context.NotNull(nameof(context));
19+
1720
return context.Parameters.Reporting.ShouldCreateFullIssuesReport;
1821
}
1922

2023
/// <inheritdoc/>
2124
public override void Run(IssuesContext context)
2225
{
26+
context.NotNull(nameof(context));
27+
2328
var reportFileName = "report";
2429
if (!string.IsNullOrWhiteSpace(context.Parameters.BuildIdentifier))
2530
{
@@ -31,14 +36,10 @@ public override void Run(IssuesContext context)
3136
context.Parameters.OutputDirectory.CombineWithFilePath(reportFileName);
3237
context.EnsureDirectoryExists(context.Parameters.OutputDirectory);
3338

34-
// Create HTML report using DevExpress template.
35-
var settings =
36-
GenericIssueReportFormatSettings
37-
.FromEmbeddedTemplate(GenericIssueReportTemplate.HtmlDxDataGrid)
38-
.WithOption(HtmlDxDataGridOption.Theme, DevExtremeTheme.MaterialBlueLight);
39+
// Create HTML report.
3940
context.CreateIssueReport(
4041
context.State.Issues,
41-
context.GenericIssueReportFormat(settings),
42+
context.GenericIssueReportFormat(context.Parameters.Reporting.FullIssuesReportSettings),
4243
context.State.BuildRootDirectory,
4344
context.State.FullIssuesReport);
4445
}

Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/CreateSummaryIssuesReportTask.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
using Cake.Common.Build;
22
using Cake.Common.Diagnostics;
3+
using Cake.Issues;
34

45
namespace Cake.Frosting.Issues.Recipe
56
{
@@ -13,6 +14,8 @@ public sealed class CreateSummaryIssuesReportTask : FrostingTask<IssuesContext>
1314
/// <inheritdoc/>
1415
public override bool ShouldRun(IssuesContext context)
1516
{
17+
context.NotNull(nameof(context));
18+
1619
return
1720
!context.BuildSystem().IsLocalBuild &&
1821
context.Parameters.BuildServer.ShouldCreateSummaryIssuesReport;
@@ -21,6 +24,8 @@ public override bool ShouldRun(IssuesContext context)
2124
/// <inheritdoc/>
2225
public override void Run(IssuesContext context)
2326
{
27+
context.NotNull(nameof(context));
28+
2429
if (context.State.BuildServer == null)
2530
{
2631
context.Information("Not supported build server.");

Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/PublishIssuesArtifactsTask.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
using Cake.Common.Build;
22
using Cake.Common.Diagnostics;
3+
using Cake.Issues;
34

45
namespace Cake.Frosting.Issues.Recipe
56
{
@@ -13,12 +14,16 @@ public sealed class PublishIssuesArtifactsTask : FrostingTask<IssuesContext>
1314
/// <inheritdoc/>
1415
public override bool ShouldRun(IssuesContext context)
1516
{
17+
context.NotNull(nameof(context));
18+
1619
return !context.BuildSystem().IsLocalBuild;
1720
}
1821

1922
/// <inheritdoc/>
2023
public override void Run(IssuesContext context)
2124
{
25+
context.NotNull(nameof(context));
26+
2227
if (context.State.BuildServer == null)
2328
{
2429
context.Information("Not supported build server.");

Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/ReadIssuesTask.cs

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ public sealed class ReadIssuesTask : FrostingTask<IssuesContext>
1818
/// <inheritdoc/>
1919
public override void Run(IssuesContext context)
2020
{
21+
context.NotNull(nameof(context));
22+
2123
// Define default settings.
2224
var defaultSettings = new ReadIssuesSettings(context.State.BuildRootDirectory);
2325

@@ -30,12 +32,14 @@ public override void Run(IssuesContext context)
3032
// Read MSBuild log files created by XmlFileLogger.
3133
foreach (var logFile in context.Parameters.InputFiles.MsBuildXmlFileLoggerLogFilePaths)
3234
{
35+
context.NotNull(nameof(context));
36+
3337
context.State.AddIssues(
3438
context.ReadIssues(
3539
context.MsBuildIssuesFromFilePath(
3640
logFile.Key,
3741
context.MsBuildXmlFileLoggerFormat()),
38-
this.GetSettings(logFile.Value, defaultSettings)));
42+
GetSettings(logFile.Value, defaultSettings)));
3943
}
4044

4145
// Read MSBuild binary log files.
@@ -46,7 +50,7 @@ public override void Run(IssuesContext context)
4650
context.MsBuildIssuesFromFilePath(
4751
logFile.Key,
4852
context.MsBuildBinaryLogFileFormat()),
49-
this.GetSettings(logFile.Value, defaultSettings)));
53+
GetSettings(logFile.Value, defaultSettings)));
5054
}
5155

5256
// Read InspectCode log files.
@@ -55,7 +59,7 @@ public override void Run(IssuesContext context)
5559
context.State.AddIssues(
5660
context.ReadIssues(
5761
context.InspectCodeIssuesFromFilePath(logFile.Key),
58-
this.GetSettings(logFile.Value, defaultSettings)));
62+
GetSettings(logFile.Value, defaultSettings)));
5963
}
6064

6165
// Read dupFinder log files.
@@ -64,7 +68,7 @@ public override void Run(IssuesContext context)
6468
context.State.AddIssues(
6569
context.ReadIssues(
6670
context.DupFinderIssuesFromFilePath(logFile.Key),
67-
this.GetSettings(logFile.Value, defaultSettings)));
71+
GetSettings(logFile.Value, defaultSettings)));
6872
}
6973

7074
// Read markdownlint-cli log files.
@@ -75,7 +79,7 @@ public override void Run(IssuesContext context)
7579
context.MarkdownlintIssuesFromFilePath(
7680
logFile.Key,
7781
context.MarkdownlintCliLogFileFormat()),
78-
this.GetSettings(logFile.Value, defaultSettings)));
82+
GetSettings(logFile.Value, defaultSettings)));
7983
}
8084

8185
// Read markdownlint log files in version 1.
@@ -86,7 +90,7 @@ public override void Run(IssuesContext context)
8690
context.MarkdownlintIssuesFromFilePath(
8791
logFile.Key,
8892
context.MarkdownlintV1LogFileFormat()),
89-
this.GetSettings(logFile.Value, defaultSettings)));
93+
GetSettings(logFile.Value, defaultSettings)));
9094
}
9195

9296
// Read ESLint log files in JSON format.
@@ -97,13 +101,13 @@ public override void Run(IssuesContext context)
97101
context.EsLintIssuesFromFilePath(
98102
logFile.Key,
99103
context.EsLintJsonFormat()),
100-
this.GetSettings(logFile.Value, defaultSettings)));
104+
GetSettings(logFile.Value, defaultSettings)));
101105
}
102106

103107
context.Information("{0} issues are found.", context.State.Issues.Count());
104108
}
105109

106-
private IReadIssuesSettings GetSettings(IReadIssuesSettings configuredSettings, IReadIssuesSettings defaultSettings)
110+
private static IReadIssuesSettings GetSettings(IReadIssuesSettings configuredSettings, IReadIssuesSettings defaultSettings)
107111
{
108112
if (configuredSettings == null)
109113
{

Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/ReportIssuesToBuildServerTask.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
using Cake.Common.Build;
22
using Cake.Common.Diagnostics;
3+
using Cake.Issues;
34

45
namespace Cake.Frosting.Issues.Recipe
56
{
@@ -13,6 +14,8 @@ public sealed class ReportIssuesToBuildServerTask : FrostingTask<IssuesContext>
1314
/// <inheritdoc/>
1415
public override bool ShouldRun(IssuesContext context)
1516
{
17+
context.NotNull(nameof(context));
18+
1619
return
1720
!context.BuildSystem().IsLocalBuild &&
1821
context.Parameters.BuildServer.ShouldReportIssuesToBuildServer;
@@ -21,6 +24,8 @@ public override bool ShouldRun(IssuesContext context)
2124
/// <inheritdoc/>
2225
public override void Run(IssuesContext context)
2326
{
27+
context.NotNull(nameof(context));
28+
2429
if (context.State.BuildServer == null)
2530
{
2631
context.Information("Not supported build server.");

Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/ReportIssuesToPullRequestTask.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
using Cake.Common.Build;
22
using Cake.Common.Diagnostics;
3+
using Cake.Issues;
34

45
namespace Cake.Frosting.Issues.Recipe
56
{
@@ -16,6 +17,8 @@ public sealed class ReportIssuesToPullRequestTask : FrostingTask<IssuesContext>
1617
/// <inheritdoc/>
1718
public override bool ShouldRun(IssuesContext context)
1819
{
20+
context.NotNull(nameof(context));
21+
1922
return
2023
!context.BuildSystem().IsLocalBuild &&
2124
context.Parameters.PullRequestSystem.ShouldReportIssuesToPullRequest &&
@@ -26,6 +29,8 @@ public override bool ShouldRun(IssuesContext context)
2629
/// <inheritdoc/>
2730
public override void Run(IssuesContext context)
2831
{
32+
context.NotNull(nameof(context));
33+
2934
if (context.State.PullRequestSystem == null)
3035
{
3136
context.Information("Not supported pull request system.");

Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/RepositoryInfo/CliRepositoryInfoProvider.cs

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
using Cake.Common;
22
using Cake.Core;
33
using Cake.Core.IO;
4+
using Cake.Issues;
45
using System;
56
using System.Collections.Generic;
67
using System.Linq;
@@ -15,28 +16,37 @@ public class CliRepositoryInfoProvider : IRepositoryInfoProvider
1516
/// <inheritdoc />
1617
public DirectoryPath GetRepositoryRootDirectory(ICakeContext context, DirectoryPath buildRootDirectory)
1718
{
19+
context.NotNull(nameof(context));
20+
buildRootDirectory.NotNull(nameof(buildRootDirectory));
21+
1822
var result =
19-
this.GitCommand(context, buildRootDirectory, "rev-parse", "--show-toplevel");
23+
GitCommand(context, buildRootDirectory, "rev-parse", "--show-toplevel");
2024
return new DirectoryPath(result.Single());
2125
}
2226

2327
/// <inheritdoc />
2428
public Uri GetRepositoryRemoteUrl(ICakeContext context, DirectoryPath repositoryRootDirectory)
2529
{
30+
context.NotNull(nameof(context));
31+
repositoryRootDirectory.NotNull(nameof(repositoryRootDirectory));
32+
2633
var result =
27-
this.GitCommand(context, repositoryRootDirectory, "config", "--get", "remote.origin.url");
34+
GitCommand(context, repositoryRootDirectory, "config", "--get", "remote.origin.url");
2835
return new Uri(result.Single());
2936
}
3037

3138
/// <inheritdoc />
3239
public string GetCommitId(ICakeContext context, DirectoryPath repositoryRootDirectory)
3340
{
41+
context.NotNull(nameof(context));
42+
repositoryRootDirectory.NotNull(nameof(repositoryRootDirectory));
43+
3444
return
35-
this.GitCommand(context, repositoryRootDirectory, "rev-parse", "HEAD")
45+
GitCommand(context, repositoryRootDirectory, "rev-parse", "HEAD")
3646
.Single();
3747
}
3848

39-
private IEnumerable<string> GitCommand(
49+
private static IEnumerable<string> GitCommand(
4050
ICakeContext context,
4151
DirectoryPath repositoryRootFolder,
4252
params string[] arguments)

Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/SetPullRequestIssuesStateTask.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
using Cake.Common.Build;
22
using Cake.Common.Diagnostics;
3+
using Cake.Issues;
34

45
namespace Cake.Frosting.Issues.Recipe
56
{
@@ -16,6 +17,8 @@ public sealed class SetPullRequestIssuesStateTask : FrostingTask<IssuesContext>
1617
/// <inheritdoc/>
1718
public override bool ShouldRun(IssuesContext context)
1819
{
20+
context.NotNull(nameof(context));
21+
1922
return
2023
!context.BuildSystem().IsLocalBuild &&
2124
context.Parameters.PullRequestSystem.ShouldReportIssuesToPullRequest &&
@@ -26,6 +29,8 @@ public override bool ShouldRun(IssuesContext context)
2629
/// <inheritdoc/>
2730
public override void Run(IssuesContext context)
2831
{
32+
context.NotNull(nameof(context));
33+
2934
if (context.State.PullRequestSystem == null)
3035
{
3136
context.Information("Not supported pull request system.");

Cake.Issues.Recipe/Content/addins.cake

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// ADDINS
33
///////////////////////////////////////////////////////////////////////////////
44

5-
#addin nuget:?package=Cake.Git&version=1.0.1
5+
#addin nuget:?package=Cake.Git&version=1.1.0
66
#addin nuget:?package=Cake.Issues&version=1.0.0
77
#addin nuget:?package=Cake.Issues.MsBuild&version=1.0.0
88
#addin nuget:?package=Cake.Issues.InspectCode&version=1.0.0

0 commit comments

Comments
 (0)