Merge branch 'release/0.3.2'

agc93 · agc93 · commit 2c2c5fde3c4a · 2019-09-04T15:53:51.000+10:00
diff --git a/ReleaseNotes.md b/ReleaseNotes.md
@@ -42,3 +42,9 @@
 - Supports Cake 0.30.0
 - Retargeted to .NET Standard 2.0 (raise issues if you see new issues from this)
 - Thanks again to @flcdrg and @RaringCoder for contributions and testing!
+
+# 0.3.2
+
+- Supports Cake 0.34.1
+- Fixes errors writing summary report when run in Azure Pipelines container (#21)
+- Thanks again to @flcdrg for contributions!
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -0,0 +1,44 @@
+trigger:
+  - master
+  - develop
+
+variables:
+  buildConfiguration: 'Release'
+  cakeVersion: 0.34.1
+  sdkVersion: '2.2.300'
+  target: NuGet
+
+pool:
+  vmImage: 'windows-2019'
+steps:
+  - task: UseDotNet@2
+    displayName: 'Use .NET Core SDK'
+    inputs:
+      packageType: sdk
+      version: $(sdkVersion)
+      installationPath: $(Agent.ToolsDirectory)/dotnet
+  - task: NuGetToolInstaller@1
+    inputs:
+      versionSpec: '>=5.x'
+  - task: DotNetCoreCLI@2
+    displayName: Install Cake tool
+    inputs:
+      command: custom
+      custom: tool
+      arguments: install -g Cake.Tool --version $(cakeVersion)
+  - task: DotNetCoreCLI@2
+    displayName: Run build
+    inputs:
+      command: custom
+      custom: cake
+      arguments: --settings_skipverification=true --target=$(target)
+  - task: PublishPipelineArtifact@1
+    displayName: Publish packages artifact
+    inputs:
+      path: dist/package
+      artifact: package
+  - task: PublishPipelineArtifact@1
+    displayName: Publish build output
+    inputs:
+      path: dist/build
+      artifact: publish
diff --git a/build.cake b/build.cake
@@ -119,7 +119,7 @@ Task("NuGet")
 		Summary			= "A simple Cake module to enhance running from a hosted CI environment.",
 		ProjectUrl		= new Uri("https://github.com/agc93/Cake.BuildSystems.Module"),
 		IconUrl			= new Uri("https://cakeresources.blob.core.windows.net/nuget/64/deployment-64.png"),
-		LicenseUrl		= new Uri("https://raw.githubusercontent.com/agc93/Cake.BuildSystems.Module/master/LICENSE"),
+		License 		= new NuSpecLicense() { Type = "expression", Value = "MIT" },
 		Copyright		= "Alistair Chapman 2017",
 		Tags			= new[] { "cake", "build", "ci", "build" },
 		OutputDirectory = artifacts + "/package",
diff --git a/src/Cake.Module.Shared/Cake.Module.Shared.csproj b/src/Cake.Module.Shared/Cake.Module.Shared.csproj
@@ -14,7 +14,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Cake.Core" Version="0.30.0" />
-    <PackageReference Include="Cake.Common" Version="0.30.0" />
+    <PackageReference Include="Cake.Core" Version="0.34.1" />
+    <PackageReference Include="Cake.Common" Version="0.34.1" />
   </ItemGroup>
 </Project>
diff --git a/src/Cake.MyGet.Module/Cake.MyGet.Module.csproj b/src/Cake.MyGet.Module/Cake.MyGet.Module.csproj
@@ -12,8 +12,8 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Cake.Core" Version="0.30.0" />
-    <PackageReference Include="Cake.Common" Version="0.30.0" />
+    <PackageReference Include="Cake.Core" Version="0.34.1" />
+    <PackageReference Include="Cake.Common" Version="0.34.1" />
   </ItemGroup>
 
   </Project>
diff --git a/src/Cake.TFBuild.Module/Cake.TFBuild.Module.csproj b/src/Cake.TFBuild.Module/Cake.TFBuild.Module.csproj
@@ -12,8 +12,8 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Cake.Core" Version="0.30.0" />
-    <PackageReference Include="Cake.Common" Version="0.30.0" />
+    <PackageReference Include="Cake.Core" Version="0.34.1" />
+    <PackageReference Include="Cake.Common" Version="0.34.1" />
   </ItemGroup>
 
 </Project>
diff --git a/src/Cake.TFBuild.Module/Extensions.cs b/src/Cake.TFBuild.Module/Extensions.cs
@@ -13,5 +13,7 @@ public static void UpdateProgress(this ITFBuildProvider provider, Guid parent, i
         {
             provider.Commands.UpdateRecord(parent, new TFBuildRecordData {Progress = progress, Status = TFBuildTaskStatus.InProgress});
         }
+
+        internal static bool IsRunningOnPipelines(this Common.Build.BuildSystem b) => b.IsRunningOnAzurePipelines || b.IsRunningOnAzurePipelinesHosted;
     }
 }
diff --git a/src/Cake.TFBuild.Module/TFBuildEngine.cs b/src/Cake.TFBuild.Module/TFBuildEngine.cs
@@ -30,7 +30,7 @@ public TFBuildEngine(ICakeDataService dataService, ICakeLog log) : base(new Cake
         private void OnBuildTeardown(object sender, TeardownEventArgs e)
         {
             var b = e.TeardownContext.BuildSystem();
-            if (b.IsRunningOnVSTS || b.IsRunningOnTFS)
+            if (b.IsRunningOnPipelines())
             {
                 b.TFBuild.Commands.UpdateRecord(_parentRecord, new TFBuildRecordData
                 {
@@ -45,7 +45,7 @@ private void OnBuildTeardown(object sender, TeardownEventArgs e)
         private void OnTaskTeardown(object sender, TaskTeardownEventArgs e)
         {
             var b = e.TaskTeardownContext.BuildSystem();
-            if (b.IsRunningOnVSTS || b.IsRunningOnTFS)
+            if (b.IsRunningOnPipelines())
             {
                 var currentTask = _engine.Tasks.First(t => t.Name == e.TaskTeardownContext.Task.Name);
                 var currentIndex = _engine.Tasks.ToList().IndexOf(currentTask);
@@ -72,7 +72,7 @@ private void OnTaskTeardown(object sender, TaskTeardownEventArgs e)
         private void OnTaskSetup(object sender, TaskSetupEventArgs e)
         {
             var b = e.TaskSetupContext.BuildSystem();
-            if (b.IsRunningOnVSTS || b.IsRunningOnTFS)
+            if (b.IsRunningOnPipelines())
             {
                 var currentTask =
                     _engine.Tasks.First(t => t.Name == e.TaskSetupContext.Task.Name);
@@ -96,7 +96,7 @@ private int GetProgress(int currentTask, int count)
         private void BuildSetup(object sender, SetupEventArgs e)
         {
             var b = e.Context.BuildSystem();
-            if (b.IsRunningOnTFS || b.IsRunningOnVSTS)
+            if (b.IsRunningOnPipelines())
             {
                 //e.Context.TFBuild().Commands.SetProgress(0, "Build Setup");
                 e.Context.TFBuild().Commands.SetProgress(0, string.Empty);
diff --git a/src/Cake.TFBuild.Module/TFBuildReportPrinter.cs b/src/Cake.TFBuild.Module/TFBuildReportPrinter.cs
@@ -8,12 +8,24 @@
 
 namespace Cake.TFBuild.Module
 {
+    /// <summary>
+    /// The TF Build/Azure Pipelines report printer.
+    /// </summary>
     public class TFBuildReportPrinter : CakeReportPrinterBase
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="TFBuildReportPrinter"/> class.
+        /// </summary>
+        /// <param name="console">The console.</param>
+        /// <param name="context">The context.</param>
         public TFBuildReportPrinter(IConsole console, ICakeContext context) : base(console, context)
         {
         }
 
+        /// <summary>
+        /// Writes the specified report to a target.
+        /// </summary>
+        /// <param name="report">The report to write.</param>
         public override void Write(CakeReport report)
         {
             if (report == null)
@@ -24,7 +36,7 @@ public override void Write(CakeReport report)
             try
             {
 
-                if (_context.TFBuild().IsRunningOnTFS || _context.TFBuild().IsRunningOnVSTS) {
+                if (_context.TFBuild().IsRunningOnAzurePipelines || _context.TFBuild().IsRunningOnAzurePipelinesHosted) {
                     WriteToMarkdown(report);
                 }
                 WriteToConsole(report);
@@ -63,7 +75,7 @@ private void WriteToMarkdown(CakeReport report)
             }
             sb.AppendLine("");
             var b = _context.BuildSystem().TFBuild;
-            FilePath agentWorkPath = b.Environment.Agent.WorkingDirectory + "/tasksummary.md";
+            FilePath agentWorkPath = b.Environment.Build.ArtifactStagingDirectory + "/tasksummary.md";
             var absFilePath = agentWorkPath.MakeAbsolute(_context.Environment);
             var file = _context.FileSystem.GetFile(absFilePath);
             using (var writer = new StreamWriter(file.OpenWrite())) {
@@ -72,7 +84,5 @@ private void WriteToMarkdown(CakeReport report)
             //b.Commands.UploadTaskSummary(absFilePath);
             _console.WriteLine($"##vso[task.addattachment type=Distributedtask.Core.Summary;name=Cake Build Summary;]{absFilePath.MakeAbsolute(_context.Environment).FullPath}");
         }
-
-        
     }
 }
diff --git a/src/Cake.TeamCity.Module/Cake.TeamCity.Module.csproj b/src/Cake.TeamCity.Module/Cake.TeamCity.Module.csproj
@@ -12,8 +12,8 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Cake.Core" Version="0.30.0" />
-    <PackageReference Include="Cake.Common" Version="0.30.0" />
+    <PackageReference Include="Cake.Core" Version="0.34.1" />
+    <PackageReference Include="Cake.Common" Version="0.34.1" />
   </ItemGroup>
 
 </Project>
diff --git a/src/Cake.TravisCI.Module/Cake.TravisCI.Module.csproj b/src/Cake.TravisCI.Module/Cake.TravisCI.Module.csproj
@@ -12,8 +12,8 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Cake.Core" Version="0.30.0" />
-    <PackageReference Include="Cake.Common" Version="0.30.0" />
+    <PackageReference Include="Cake.Core" Version="0.34.1" />
+    <PackageReference Include="Cake.Common" Version="0.34.1" />
   </ItemGroup>
 
 </Project>
diff --git a/tools/packages.config b/tools/packages.config
@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-    <package id="Cake" version="0.24.0" />
+    <package id="Cake" version="0.34.1" />
 </packages>

Original file line number	Diff line number	Diff line change
`@@ -13,5 +13,7 @@ public static void UpdateProgress(this ITFBuildProvider provider, Guid parent, i`
`13`	`13`	`{`
`14`	`14`	`provider.Commands.UpdateRecord(parent, new TFBuildRecordData {Progress = progress, Status = TFBuildTaskStatus.InProgress});`
`15`	`15`	`}`
	`16`	`+`
	`17`	`+ internal static bool IsRunningOnPipelines(this Common.Build.BuildSystem b) => b.IsRunningOnAzurePipelines \|\| b.IsRunningOnAzurePipelinesHosted;`
`16`	`18`	`}`
`17`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public TFBuildEngine(ICakeDataService dataService, ICakeLog log) : base(new Cake`
`30`	`30`	`private void OnBuildTeardown(object sender, TeardownEventArgs e)`
`31`	`31`	`{`
`32`	`32`	`var b = e.TeardownContext.BuildSystem();`
`33`		`- if (b.IsRunningOnVSTS \|\| b.IsRunningOnTFS)`
	`33`	`+ if (b.IsRunningOnPipelines())`
`34`	`34`	`{`
`35`	`35`	`b.TFBuild.Commands.UpdateRecord(_parentRecord, new TFBuildRecordData`
`36`	`36`	`{`
`@@ -45,7 +45,7 @@ private void OnBuildTeardown(object sender, TeardownEventArgs e)`
`45`	`45`	`private void OnTaskTeardown(object sender, TaskTeardownEventArgs e)`
`46`	`46`	`{`
`47`	`47`	`var b = e.TaskTeardownContext.BuildSystem();`
`48`		`- if (b.IsRunningOnVSTS \|\| b.IsRunningOnTFS)`
	`48`	`+ if (b.IsRunningOnPipelines())`
`49`	`49`	`{`
`50`	`50`	`var currentTask = _engine.Tasks.First(t => t.Name == e.TaskTeardownContext.Task.Name);`
`51`	`51`	`var currentIndex = _engine.Tasks.ToList().IndexOf(currentTask);`
`@@ -72,7 +72,7 @@ private void OnTaskTeardown(object sender, TaskTeardownEventArgs e)`
`72`	`72`	`private void OnTaskSetup(object sender, TaskSetupEventArgs e)`
`73`	`73`	`{`
`74`	`74`	`var b = e.TaskSetupContext.BuildSystem();`
`75`		`- if (b.IsRunningOnVSTS \|\| b.IsRunningOnTFS)`
	`75`	`+ if (b.IsRunningOnPipelines())`
`76`	`76`	`{`
`77`	`77`	`var currentTask =`
`78`	`78`	`_engine.Tasks.First(t => t.Name == e.TaskSetupContext.Task.Name);`
`@@ -96,7 +96,7 @@ private int GetProgress(int currentTask, int count)`
`96`	`96`	`private void BuildSetup(object sender, SetupEventArgs e)`
`97`	`97`	`{`
`98`	`98`	`var b = e.Context.BuildSystem();`
`99`		`- if (b.IsRunningOnTFS \|\| b.IsRunningOnVSTS)`
	`99`	`+ if (b.IsRunningOnPipelines())`
`100`	`100`	`{`
`101`	`101`	`//e.Context.TFBuild().Commands.SetProgress(0, "Build Setup");`
`102`	`102`	`e.Context.TFBuild().Commands.SetProgress(0, string.Empty);`
Original file line number	Diff line number	Diff line change
`@@ -8,12 +8,24 @@`
`8`	`8`
`9`	`9`	`namespace Cake.TFBuild.Module`
`10`	`10`	`{`
	`11`	`+ /// <summary>`
	`12`	`+ /// The TF Build/Azure Pipelines report printer.`
	`13`	`+ /// </summary>`
`11`	`14`	`public class TFBuildReportPrinter : CakeReportPrinterBase`
`12`	`15`	`{`
	`16`	`+ /// <summary>`
	`17`	`+ /// Initializes a new instance of the <see cref="TFBuildReportPrinter"/> class.`
	`18`	`+ /// </summary>`
	`19`	`+ /// <param name="console">The console.</param>`
	`20`	`+ /// <param name="context">The context.</param>`
`13`	`21`	`public TFBuildReportPrinter(IConsole console, ICakeContext context) : base(console, context)`
`14`	`22`	`{`
`15`	`23`	`}`
`16`	`24`
	`25`	`+ /// <summary>`
	`26`	`+ /// Writes the specified report to a target.`
	`27`	`+ /// </summary>`
	`28`	`+ /// <param name="report">The report to write.</param>`
`17`	`29`	`public override void Write(CakeReport report)`
`18`	`30`	`{`
`19`	`31`	`if (report == null)`
`@@ -24,7 +36,7 @@ public override void Write(CakeReport report)`
`24`	`36`	`try`
`25`	`37`	`{`
`26`	`38`
`27`		`- if (_context.TFBuild().IsRunningOnTFS \|\| _context.TFBuild().IsRunningOnVSTS) {`
	`39`	`+ if (_context.TFBuild().IsRunningOnAzurePipelines \|\| _context.TFBuild().IsRunningOnAzurePipelinesHosted) {`
`28`	`40`	`WriteToMarkdown(report);`
`29`	`41`	`}`
`30`	`42`	`WriteToConsole(report);`
`@@ -63,7 +75,7 @@ private void WriteToMarkdown(CakeReport report)`
`63`	`75`	`}`
`64`	`76`	`sb.AppendLine("");`
`65`	`77`	`var b = _context.BuildSystem().TFBuild;`
`66`		`- FilePath agentWorkPath = b.Environment.Agent.WorkingDirectory + "/tasksummary.md";`
	`78`	`+ FilePath agentWorkPath = b.Environment.Build.ArtifactStagingDirectory + "/tasksummary.md";`
`67`	`79`	`var absFilePath = agentWorkPath.MakeAbsolute(_context.Environment);`
`68`	`80`	`var file = _context.FileSystem.GetFile(absFilePath);`
`69`	`81`	`using (var writer = new StreamWriter(file.OpenWrite())) {`
`@@ -72,7 +84,5 @@ private void WriteToMarkdown(CakeReport report)`
`72`	`84`	`//b.Commands.UploadTaskSummary(absFilePath);`
`73`	`85`	`_console.WriteLine($"##vso[task.addattachment type=Distributedtask.Core.Summary;name=Cake Build Summary;]{absFilePath.MakeAbsolute(_context.Environment).FullPath}");`
`74`	`86`	`}`
`75`		`-`
`76`		`-`
`77`	`87`	`}`
`78`	`88`	`}`