From 12a8912f6b8a3f1785e374004ca35617a6b2eb41 Mon Sep 17 00:00:00 2001 From: Gary Ewan Park Date: Mon, 8 Aug 2022 21:19:06 +0100 Subject: [PATCH 1/2] (#894) FIx docs regarding Cake version Update to correctly show supported version of Cake for the 3.x release of Cake.Recipe. --- Source/Cake.Recipe/Cake.Recipe.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Source/Cake.Recipe/Cake.Recipe.csproj b/Source/Cake.Recipe/Cake.Recipe.csproj index 4bc517c7..554a1de8 100644 --- a/Source/Cake.Recipe/Cake.Recipe.csproj +++ b/Source/Cake.Recipe/Cake.Recipe.csproj @@ -19,7 +19,7 @@ https://cake-contrib.github.io/Cake.Recipe/docs/ -NOTE: Currently, Cake.Recipe itself is built using 0.38.4, and as a result, there is an expectation that that any project that is built using Cake.Recipe should also use 0.38.4 of Cake. Using a newer version of Cake may work, but there is no guarantee that it will. +NOTE: Currently, Cake.Recipe itself is built using 1.3.0, and as a result, there is an expectation that that any project that is built using Cake.Recipe should also use 1.3.0 of Cake. Using a newer version of Cake may work, but there is no guarantee that it will. MIT https://github.com/cake-contrib/Cake.Recipe/ From 6df404412a3e96a7b5a754b18d14b6724d0e9dc3 Mon Sep 17 00:00:00 2001 From: Gary Ewan Park Date: Mon, 8 Aug 2022 21:19:30 +0100 Subject: [PATCH 2/2] (doc) Add upgrade instructions for 3.x --- .../input/docs/overview/requirements/posix.md | 2 +- .../docs/overview/requirements/windows.md | 2 +- docs/input/docs/upgrading/2.x-to-3.x.md | 37 ++++++++++++++++++- 3 files changed, 38 insertions(+), 3 deletions(-) diff --git a/docs/input/docs/overview/requirements/posix.md b/docs/input/docs/overview/requirements/posix.md index 6aa0b34c..2e0ffad4 100644 --- a/docs/input/docs/overview/requirements/posix.md +++ b/docs/input/docs/overview/requirements/posix.md @@ -94,4 +94,4 @@ As a minimum, it is recommended that Cake.Recipe should be used in conjunction w | :-----------------: | :----------: | | 1.x | 0.32.0 | | 2.x | 0.38.4 | -| 3.x | 1.1.0 | +| 3.x | 1.3.0 | diff --git a/docs/input/docs/overview/requirements/windows.md b/docs/input/docs/overview/requirements/windows.md index d845d0e1..caf78572 100644 --- a/docs/input/docs/overview/requirements/windows.md +++ b/docs/input/docs/overview/requirements/windows.md @@ -31,4 +31,4 @@ As a minimum, it is recommended that Cake.Recipe should be used in conjunction w | :-----------------: | :----------: | | 1.x | 0.32.0 | | 2.x | 0.38.4 | -| 3.x | 1.1.0 | +| 3.x | 1.3.0 | diff --git a/docs/input/docs/upgrading/2.x-to-3.x.md b/docs/input/docs/upgrading/2.x-to-3.x.md index bc860a6f..9b658929 100644 --- a/docs/input/docs/upgrading/2.x-to-3.x.md +++ b/docs/input/docs/upgrading/2.x-to-3.x.md @@ -1 +1,36 @@ -TODO! \ No newline at end of file +--- +Order: 20 +Title: Upgrading from 2.x to 3.x +Description: Changes and suggestions needed for porting from Cake.Recipe 2.x to 3.x +--- + +In the 3.0.0 release of Cake.Recipe, there were a total of 2 breaking changes. As a result, there are only a couple of changes that have to be made to any project that is currently using a 2.x.x release of Cake.Recipe, in order to allow it to start using this release. + +There are a couple of example Pull Requests that can be used to see the type of changes that are required when moving to Cake.Recipe 3.x.x: + +- [Cake.Issues.GitRepository](https://github.com/cake-contrib/Cake.Issues.GitRepository/pull/139/files) +- [Cake.Issues.InspectCode](https://github.com/cake-contrib/Cake.Issues.InspectCode/pull/201/files) + +**NOTE:** The above PR's upgrade to an alpha version of Cake.Recipe. Now that 3.0.0 of Cake.Recipe is available, you should use that, rather than any alpha version. + +## Required Changes + +### Switch to using Cake 1.3.0 + +Cake.Recipe is now using 1.3.0 of Cake, and as such, we recommend that any build using Cake.Recipe also targets using 1.3.0 of Cake. We recommend that you follow the [upgrade instructions for Cake itself](https://cakebuild.net/docs/getting-started/upgrade#cake-0.38.x-to-cake-1.0.0), to ensure that there aren't any additional changes that you would need to make. + +### Remove any usage of DupFinder + +[JetBrains have made the decision to sunset their DupFinder application](https://blog.jetbrains.com/dotnet/2021/08/12/sunsetting-dupfinder-command-line-tool/), as a result, we are no longer going to support this application being used within Cake.Recipe. + +Any usage of the `shouldRunDupFinder` parameter will need to be removed from the recipe.cake file, as well as the `dupFinderExcludePattern` tool setting. + +### Pin to updated version of Cake + +Cake.Recipe 2.x.x was pinned to run against version 0.38.4 of Cake. In order to use Cake.Recipe 3.0.0 you will need to use at least 1.3.0. + +### Ensure correct Cake.Issues.Recipe usage + +In this release of Cake.Recipe we have upgraded to 1.3.2 of Cake.Issues.Recipe. If in your build scripts you have extended the built in usage of Cake.Issues.Recipe you may need to check the release notes to confirm if there are any additional changes that need to be made. + +[Check out the blog post here for additional information](https://cakeissues.net/news/cake-issues-v1.0.0-released).