Merge pull request #43 from nunit/release-3.7.1

Release 3.7.1

Author: CharliePoole

.gitignore

@@ -180,3 +180,4 @@ MockAssemblyResult.xml
 PortabilityAnalysis*.html
 tools
 !tools/packages.config
+DraftRelease.md

CHANGES.md

@@ -0,0 +1,42 @@
+## NUnit Project Loader Extension 3.7.1 - September 17, 2021
+
+This release serves as a final test of our build automation. 
+There are no changes other than those related to the build.
+
+### Build
+
+* 35 Update Cake to version 1.2.0
+* 37 Change default branch from master to main
+* 38 Standardize build scripts for extensions
+* 41 Automate the GitHub release process
+
+## NUnit Project Loader Extension 3.7.0 - August 29, 2021
+
+No new features or bug fixes but includes changes in the build script
+to facilitate moving to the next major version of the extension, v4.0.
+
+This is expected to be the final release of the 3.x series.
+  
+### Issues Resolved
+
+* 17 Add functional package tests to build
+* 18 Automate publication of packages
+* 20 Update Cake version and get build working again
+* 23 Refactor Cake scripts
+* 33 Specify console versions for each test separately
+
+## NUnit Project Loader Extension 3.6.0 - July 28, 2017
+
+Fixes several packaging errors and adds a new chocolatey package. Runners and engines
+installed under chocolatey will see and make use of this package.
+
+### Issues Resolved
+
+ * 2 Change API reference to released version
+ * 4 Create file of constants for XML element and attribute names
+ * 7 No license file in NuGet package
+ * 8 Integrate chocolatey package in release build script
+
+## NUnit Project Loader Extension 3.5.0 - October 6, 2016
+
+The first independent release of the nunit-project-loader extension.

CHANGES.txt

@@ -0,0 +1,56 @@
+# The labels that will be used to include issues in release notes.
+issue-labels-include:
+- Feature
+- Enhancement
+- Bug
+- Build
+- Documentation
+# The labels that will NOT be used when including issues in release notes.
+issue-labels-exclude:
+- Refactor
+# Overrides default pluralization and header names for specific labels.
+issue-labels-alias:
+- name: Build
+  header: Build
+  plural: Build
+- name: Documentation
+  header: Documentation
+  plural: Documentation
+# Configuration values used when creating new releases
+create:
+  include-footer: true
+  footer-heading: Packages
+  footer-content: >-
+    There are two different packages available for the extension.
+    <ul>
+    <li>For a chocolatey install: `nunit-extension-nunit-v2-result-writer.{milestone}.nupkg`
+    <li>For a nuget install: `NUnit.Extension.NUnitV2ResultWriter.{milestone}.nupkg`
+    </ul>
+    You may also download the extension from
+    [chocolatey.org](https://chocolatey.org/packages/nunit-extension-nunit-v2-result-writer/) 
+    or [nuget.org](https://nuget.org/packages/NUnit.Extension.NUnitV2ResultWriter/).
+  footer-includes-milestone: true
+  milestone-replace-text: '{milestone}'
+  include-sha-section: true
+  sha-section-heading: "SHA256 Hashes of the release artifacts"
+  sha-section-line-format: "- `{1}\t{0}`"
+  allow-update-to-published: false
+# Configuration values used when exporting release notes
+export:
+  include-created-date-in-title: true
+  created-date-string-format: MMMM dd, yyyy
+  perform-regex-removal: false
+#  regex-text: '### Where to get it(\r\n)*You can .*\.'
+#  multiline-regex: false
+# Configuration values used when closing a milestone
+close:
+# Whether to add comments to issues closed with the published milestone release.
+  use-issue-comments: true
+  issue-comment: |-
+    :tada: This issue has been resolved in version {milestone} :tada:
+
+    The release is available on:
+
+    - [GitHub Release](https://github.com/{owner}/{repository}/releases/tag/{milestone})
+    - [NuGet Package](https://www.nuget.org/packages/NUnit.Extension.NUnitV2ResultWriter/{milestone})
+    - [Chocolatey Package](https://chocolatey.org/packages/nunit-extension-nunit-v2-result-writer/{milestone})

GitReleaseManager.yaml

@@ -1,4 +1,5 @@
 #tool nuget:?package=GitVersion.CommandLine&version=5.0.0
+#tool nuget:?package=GitReleaseManager&version=0.11.0
 #tool nuget:?package=NUnit.ConsoleRunner&version=3.12.0
 #tool nuget:?package=NUnit.ConsoleRunner&version=3.11.1
 #tool nuget:?package=NUnit.ConsoleRunner&version=3.10.0
@@ -12,7 +13,7 @@ const string NUGET_ID = "NUnit.Extension.NUnitProjectLoader";
 const string CHOCO_ID = "nunit-extension-nunit-project-loader";
 const string GITHUB_OWNER = "nunit";
 const string GITHUB_REPO = "nunit-project-loader";
-const string DEFAULT_VERSION = "3.8.0";
+const string DEFAULT_VERSION = "3.7.1";
 const string DEFAULT_CONFIGURATION = "Release";
 
 // Load scripts after defining constants
@@ -26,7 +27,7 @@ var target = Argument("target", "Default");
 
 // Additional arguments defined in the cake scripts:
 //   --configuration
-//   --version
+//   --packageVersion
 
 //////////////////////////////////////////////////////////////////////
 // SETUP AND TEARDOWN
@@ -65,16 +66,6 @@ Task("Clean")
 		CleanDirectory(parameters.OutputDirectory);
 	});
 
-Task("CleanAll")
-	.Does<BuildParameters>((parameters) =>
-	{
-		Information("Cleaning all output directories");
-		CleanDirectory(parameters.ProjectDirectory + "bin/");
-
-		Information("Deleting object directories");
-		DeleteObjectDirectories(parameters);
-	});
-
 //////////////////////////////////////////////////////////////////////
 // INITIALIZE FOR BUILD
 //////////////////////////////////////////////////////////////////////
@@ -161,7 +152,7 @@ Task("VerifyNuGetPackage")
 	.Does<BuildParameters>((parameters) =>
 	{
 		Check.That(parameters.NuGetInstallDirectory,
-			HasFiles("CHANGES.txt", "LICENSE.txt"),
+			HasFiles("CHANGES.md", "LICENSE.txt"),
 			HasDirectory("tools").WithFile("nunit-project-loader.dll"));
 		Information("Verification was successful!");
 	});
@@ -201,7 +192,7 @@ Task("VerifyChocolateyPackage")
 	{
 		Check.That(parameters.ChocolateyInstallDirectory,
 			HasDirectory("tools").WithFiles(
-				"CHANGES.txt", "LICENSE.txt", "VERIFICATION.txt", "nunit-project-loader.dll"));
+				"CHANGES.md", "LICENSE.txt", "VERIFICATION.txt", "nunit-project-loader.dll"));
 		Information("Verification was successful!");
 	});
 
@@ -383,21 +374,6 @@ Task("CreateDraftRelease")
 		}
 	});
 
-Task("ExportDraftRelease")
-	.Description("Export draft release locally for use in updating CHANGES.md")
-	.Does<BuildParameters>((parameters) =>
-	{
-		if (parameters.IsReleaseBranch && parameters.IsLocalBuild)
-		{
-			string milestone = parameters.BranchName.Substring(8);
-
-			GitReleaseManagerExport(parameters.GitHubAccessToken, GITHUB_OWNER, GITHUB_REPO, "DraftRelease.md",
-				new GitReleaseManagerExportSettings() { TagName = milestone });
-		}
-		else
-			Error("ExportDraftRelease may only be run locally, using a release branch!");
-	});
-
 //////////////////////////////////////////////////////////////////////
 // CREATE A PRODUCTION RELEASE
 //////////////////////////////////////////////////////////////////////
@@ -455,7 +431,9 @@ Task("Appveyor")
 	.IsDependentOn("Build")
 	.IsDependentOn("Test")
 	.IsDependentOn("Package")
-	.IsDependentOn("PublishPackages");
+	.IsDependentOn("PublishPackages")
+	.IsDependentOn("CreateDraftRelease")
+	.IsDependentOn("CreateProductionRelease");
 
 Task("Default")
     .IsDependentOn("Build");

build.cake

@@ -0,0 +1,42 @@
+////////////////////////////////////////////////////////////////////
+// TARGETS FOR DEVELOPER USE ON LOCAL MACHINE
+//////////////////////////////////////////////////////////////////////
+
+using System;
+
+// Dependent task for all local targets
+Task("MustBeLocalBuild")
+	.Does<BuildParameters>((parameters) =>
+	{
+		if (!parameters.IsLocalBuild)
+			throw new Exception($"{parameters.Target} may only be run locally!");
+	});
+
+Task("CleanAll")
+	.Description("Clean both configs and all obj directories")
+	.IsDependentOn("MustBeLocalBuild")
+	.Does<BuildParameters>((parameters) =>
+	{
+		Information("Cleaning all output directories");
+		CleanDirectory(parameters.ProjectDirectory + "bin/");
+
+		Information("Deleting object directories");
+		DeleteObjectDirectories(parameters);
+	});
+
+// Download existing draft release for modification or for use in
+// updating the CHANGES.md file.
+Task("DownloadDraftRelease")
+	.Description("Download draft release for local use")
+	.IsDependentOn("MustBeLocalBuild")
+	.Does<BuildParameters>((parameters) =>
+	{
+		if (!parameters.IsReleaseBranch)
+			throw new Exception("DownloadDraftRelease requires a release branch!");
+
+		string milestone = parameters.BranchName.Substring(8);
+
+		GitReleaseManagerExport(parameters.GitHubAccessToken, GITHUB_OWNER, GITHUB_REPO, "DraftRelease.md",
+			new GitReleaseManagerExportSettings() { TagName = milestone });
+	});
+

cake/local-targets.cake

@@ -8,7 +8,7 @@ static readonly string[] OWNERS = new[] { "Charlie Poole" };
 const string DESCRIPTION = "This extension allows NUnit to create result files in the V2 format, which is used by many CI servers.";
 const string SUMMARY = "NUnit Engine extension for writing test result files in NUnit V2 format.";
 const string COPYRIGHT = "Copyright (c) 2016 Charlie Poole";
-static readonly string[] RELEASE_NOTES = new[] { "See https://raw.githubusercontent.com/nunit/nunit-v2-result-writer/main/CHANGES.txt" };
+static readonly string[] RELEASE_NOTES = new[] { "See https://raw.githubusercontent.com/nunit/nunit-v2-result-writer/main/CHANGES.md" };
 static readonly string[] TAGS = new[] { "nunit", "test", "testing", "tdd", "runner" };
 static readonly Uri PROJECT_URL = new Uri("http://nunit.org");
 static readonly Uri ICON_URL = new Uri("https://cdn.rawgit.com/nunit/resources/master/images/icon/nunit_256.png");
@@ -29,7 +29,7 @@ public void BuildNuGetPackage(BuildParameters parameters)
 {
 		var content = new List<NuSpecContent>();
 		content.Add(new NuSpecContent { Source = parameters.ProjectDirectory + "LICENSE.txt" });
-		content.Add(new NuSpecContent { Source = parameters.ProjectDirectory + "CHANGES.txt" });
+		content.Add(new NuSpecContent { Source = parameters.ProjectDirectory + "CHANGES.md" });
 		content.Add(new NuSpecContent { Source = parameters.OutputDirectory + "net20/nunit-project-loader.dll", Target = "tools" });
 
 	NuGetPack(
@@ -66,7 +66,7 @@ public void BuildChocolateyPackage(BuildParameters parameters)
 {
     var content = new List<ChocolateyNuSpecContent>();
     content.Add(new ChocolateyNuSpecContent { Source = parameters.ProjectDirectory + "LICENSE.txt", Target = "tools" });
-    content.Add(new ChocolateyNuSpecContent { Source = parameters.ProjectDirectory + "CHANGES.txt", Target = "tools" });
+    content.Add(new ChocolateyNuSpecContent { Source = parameters.ProjectDirectory + "CHANGES.md", Target = "tools" });
     content.Add(new ChocolateyNuSpecContent { Source = parameters.ProjectDirectory + "VERIFICATION.txt", Target = "tools" });
 	content.Add(new ChocolateyNuSpecContent { Source = parameters.OutputDirectory + "net20/nunit-project-loader.dll", Target = "tools" });
 

cake/packaging.cake

@@ -5,6 +5,7 @@
 #load "./test-results.cake"
 #load "./test-reports.cake"
 #load "./utilities.cake"
+#load "./local-targets.cake"
 
 using System;
 

cake/parameters.cake

@@ -23,8 +23,8 @@ public class BuildVersion
         IsReleaseBranch = BranchName.StartsWith("release-");
 
 		// TODO: Get GitVersion to work on Linux
-        string packageVersion = context.HasArgument("version")
-            ? context.Argument("version", DEFAULT_VERSION)
+        string packageVersion = context.HasArgument("packageVersion")
+            ? context.Argument("packageVersion", DEFAULT_VERSION)
             : CalculatePackageVersion();
 
 		int dash = packageVersion.IndexOf('-');

cake/versioning.cake

@@ -15,8 +15,9 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		build.cake = build.cake
 		build.ps1 = build.ps1
 		build.sh = build.sh
-		CHANGES.txt = CHANGES.txt
+		CHANGES.md = CHANGES.md
 		FailingAssembly.nunit = FailingAssembly.nunit
+		GitReleaseManager.yaml = GitReleaseManager.yaml
 		GitVersion.yml = GitVersion.yml
 		LICENSE.txt = LICENSE.txt
 		nunit-project-loader.nuspec = nunit-project-loader.nuspec
@@ -26,6 +27,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "cake", "cake", "{1E689680-AB9D-497E-8FC3-B541A9A24EEC}"
 	ProjectSection(SolutionItems) = preProject
+		cake\local-targets.cake = cake\local-targets.cake
 		cake\package-checks.cake = cake\package-checks.cake
 		cake\package-tests.cake = cake\package-tests.cake
 		cake\packaging.cake = cake\packaging.cake