Skip to content

Commit db1150e

Browse files
committed
Add descriptions to cake tasks
1 parent d1e6449 commit db1150e

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

build.cake

+7
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ var artefactsDirectory = Directory("./Artefacts");
2020
var versionSuffix = string.IsNullOrEmpty(preReleaseSuffix) ? null : preReleaseSuffix + "-" + buildNumber.ToString("D4");
2121

2222
Task("Clean")
23+
.Description("Cleans the artefacts, bin and obj directories.")
2324
.Does(() =>
2425
{
2526
CleanDirectory(artefactsDirectory);
@@ -28,13 +29,15 @@ Task("Clean")
2829
});
2930

3031
Task("Restore")
32+
.Description("Restores NuGet packages.")
3133
.IsDependentOn("Clean")
3234
.Does(() =>
3335
{
3436
DotNetCoreRestore();
3537
});
3638

3739
Task("Build")
40+
.Description("Builds the solution.")
3841
.IsDependentOn("Restore")
3942
.Does(() =>
4043
{
@@ -49,6 +52,7 @@ Task("Build")
4952
});
5053

5154
Task("RunTool")
55+
.Description("Downloads the latest schema.org JSON-LD and re-generates the C# classes from them.")
5256
.IsDependentOn("Build")
5357
.Does(() =>
5458
{
@@ -64,6 +68,7 @@ Task("Build")
6468
});
6569

6670
Task("Test")
71+
.Description("Runs unit tests and outputs test results to the artefacts directory.")
6772
.DoesForEach(GetFiles("./Tests/**/*.csproj"), project =>
6873
{
6974
DotNetCoreTest(
@@ -80,6 +85,7 @@ Task("Test")
8085
});
8186

8287
Task("Pack")
88+
.Description("Creates NuGet packages and outputs them to the artefacts directory.")
8389
.Does(() =>
8490
{
8591
DotNetCorePack(
@@ -97,6 +103,7 @@ Task("Pack")
97103
});
98104

99105
Task("Default")
106+
.Description("Cleans, restores NuGet packages, builds the solution, runs unit tests and then creates NuGet packages.")
100107
.IsDependentOn("Build")
101108
.IsDependentOn("Test")
102109
.IsDependentOn("Pack");

0 commit comments

Comments
 (0)