[x] Run the Prereqs.ps1 file, using the following as an example .\Prereqs.ps1 -GithubUsername devlead (use your own username). This will clone a new version of all required repositories.
Let people know that things are happening...
[x] Go to the Gitter room for Cake and inform people that a release is away to happen. Use a message similar to the following @/all We will soon start preparing for the [3.0.0 release](https://github.com/cake-build/cake/milestone/81?closed=1) of Cake. So this is a friendly reminder to pin your Cake version! :pushpin: :cake:
[x] Go to the Gitter room for Cake-Contrib and inform people that a release is away to happen. Use a message similar to the following @/all We will soon start preparing for the [3.0.0 release](https://github.com/cake-build/cake/milestone/81?closed=1) of Cake. So this is a friendly reminder to pin your Cake version! :pushpin: :cake:
[x] Go to the General Channel in the Slack Team for Cake-Contrib and inform people that a release is away to happen. Use a message similar to the following @channel We will soon start preparing for the [3.0.0 release](https://github.com/cake-build/cake/milestone/81?closed=1) of Cake. So this is a friendly reminder to pin your Cake version! :pushpin: :cake:
[x] Using the Cake Twitter account, tweet to let people know that the release is away to happen. Use something like the following We are starting to prepare our next release, 3.0.0 (https://github.com/cake-build/cake/milestone/81?closed=1). This is your friendly reminder that if you haven't pinned to a specific version of Cake, you should do it now :-) š š° https://cakebuild.net/docs/writing-builds/reproducible-builds/
[x] Retweet the above from the cake-contrib twitter account
GitHub Issues Pre-requisites
[x] Make sure all issues within the milestone are tagged with either Bug, Feature, Improvement, Documentation, Breaking change, or Build
[x] Make sure all issues associated with the milestone are closed
[x] Make sure that all issues only have 1 label associated with them
[x] Raise an issue in the Cake.AddinDiscoverer repo if there are any breaking changes so the discoverer can be modified to generate a new markdown report and also Excel report to track which addins are compatible with this new release of Cake.
When doing a release
[x] Create branch locally to match the name of the release, for example git checkout -b release/3.0.0 develop
[x] Update ReleaseNotes.md to include next version number as a placeholder and save the file
[x] Create release notes on GitHub using the ReleaseNotes task (.\build.ps1 --target=ReleaseNotes)
[x] Update ReleaseNotes.md with generated content (making sure to keep the formatting the same)
[x] Build everything (./build.ps1) to make sure it works.
[x] Commit the changes to ReleaseNotes.md and SolutionInfo.cs. Use comment like (build) Updated version and release notes
[x] At this point, if you want to share the work to date, and validate something, push the local release branch to GitHub
[x] Assuming everything is ok, switch to main branch (git checkout main)
[x] Merge release branch to the maingit merge --no-ff release/3.0.0
[x] Build everything (./build.ps1) to make sure it works (we can never be too sure).
[x] Push main branch.
[x] Make sure that both all builds succeed before going any further.
[x] Assuming that everything went ok, go to the draft release in GitHub and click Edit
[x] Click the Publish Release button
[x] This will trigger another build in AppVeyor, but this time with a tag.
[x] Switch to develop branch git checkout develop
[x] Merge release branch into develop git merge --no-ff release/3.0.0
[x] Resolve any merge conflicts
[x] Bump the Cake Tool Version number in .config\dotnet-tools.json to the latest released version, i.e. the version you just released
[x] Build everything (./build.ps1) to make sure it works.
[x] Commit the changes to .config\dotnet-tools.json. Use commit message like (build) Updated Cake Tool to version 3.0.0
[x] Push develop branch.
[x] Delete the local release branch that was created git branch -d release/3.0.0 (and the remote one, if pushed to GitHub git push origin --delete release/3.0.0)
After a release/hotfix
[x] Make sure that everything has pushed correctly to nuget
[x] Create a branch for a new blog post git checkout -b 3.0.0-Blog-Post master
[x] You can get draft blog post using the console secrets\Processes\FetchContributors
dotnet restore
dotnet run -- "cake-build" "cake" "v2.3.0" "02aaa086f62edc032ea505c45a2038a552828054" "../../../../cake-build/website/input/blog/" v3.0.0
[x] Bump the Cake Tool Version number in .config\dotnet-tools.json to the latest released version, i.e. the version you just released
[x] Commit changes to .config\dotnet-tools.json file using message similar to (build) Updated Cake tool to version 3.0.0
[x] Commit blog post using message similar to v3.0.0 Blog Post
[x] Push branch and submit pull request
[x] Have someone else verify the contents
[x] Merge the Pull Request
[x] Go to develop.cakebuild.net once you receive the Azure notification in Slack to say that the development site is deployed. Make sure that it works as expected.
[x] Go to cakebuild.net once you receive the Azure notification in Slack to say that the development site is deployed. Make sure that it works as expected.
[x] Go to the Cake-Contrib Gitter Room and let people know that it was released. Use something like @/all Version 3.0.0 of the Cake has just been released, https://www.nuget.org/packages/Cake.Tool :cake: :rocket:
[x] Go to the Cake-Contrib Slack Team and in the General Room let people know that it was released. Use something like @channel Version 3.0.0 of the Cake has just been released, https://www.nuget.org/packages/Cake.Tool :cake: :rocket:
Useful information
Repository Pre-requisites
Automated Approach
Prereqs.ps1file, using the following as an example.\Prereqs.ps1 -GithubUsername devlead(use your own username). This will clone a new version of all required repositories.Let people know that things are happening...
@/all We will soon start preparing for the [3.0.0 release](https://github.com/cake-build/cake/milestone/81?closed=1) of Cake. So this is a friendly reminder to pin your Cake version! :pushpin: :cake:@/all We will soon start preparing for the [3.0.0 release](https://github.com/cake-build/cake/milestone/81?closed=1) of Cake. So this is a friendly reminder to pin your Cake version! :pushpin: :cake:@channel We will soon start preparing for the [3.0.0 release](https://github.com/cake-build/cake/milestone/81?closed=1) of Cake. So this is a friendly reminder to pin your Cake version! :pushpin: :cake:We are starting to prepare our next release, 3.0.0 (https://github.com/cake-build/cake/milestone/81?closed=1). This is your friendly reminder that if you haven't pinned to a specific version of Cake, you should do it now :-) š š° https://cakebuild.net/docs/writing-builds/reproducible-builds/GitHub Issues Pre-requisites
When doing a release
git checkout -b release/3.0.0 developReleaseNotes.mdto include next version number as a placeholder and save the fileReleaseNotestask (.\build.ps1 --target=ReleaseNotes)ReleaseNotes.mdwith generated content (making sure to keep the formatting the same)./build.ps1) to make sure it works.ReleaseNotes.mdandSolutionInfo.cs. Use comment like(build) Updated version and release notesmainbranch (git checkout main)maingit merge --no-ff release/3.0.0./build.ps1) to make sure it works (we can never be too sure).mainbranch.developbranchgit checkout developgit merge --no-ff release/3.0.0.config\dotnet-tools.jsonto the latest released version, i.e. the version you just released./build.ps1) to make sure it works..config\dotnet-tools.json. Use commit message like(build) Updated Cake Tool to version 3.0.0developbranch.git branch -d release/3.0.0(and the remote one, if pushed to GitHubgit push origin --delete release/3.0.0)After a release/hotfix
N/ACake (deprecated with v2.0.0)N/ACake.CoreCLR (deprecated with v2.0.0).config\dotnet-tools.jsonto the latest released version, i.e. the version you just released./build.ps1or./build.sh) to make sure it works.(build) Updated Cake tool to version 3.0.0dotnet-tool/.config/dotnet-tools.jsonfile(build) Updated Cake tool to version 3.0.0git pushUpdate Cake to version 3.0.0git checkout -b feature/gh-xxx develop./build.ps1or./build.sh) to make sure it works.(GH-xxx) Updated Cake tool to version 3.0.0git checkout -b 3.0.0-Blog-Post mastersecrets\Processes\FetchContributorsdotnet run -- "cake-build" "cake" "v2.3.0" "02aaa086f62edc032ea505c45a2038a552828054" "../../../../cake-build/website/input/blog/" v3.0.0.config\dotnet-tools.jsonto the latest released version, i.e. the version you just released.config\dotnet-tools.jsonfile using message similar to(build) Updated Cake tool to version 3.0.0v3.0.0 Blog Post@/all Version 3.0.0 of the Cake has just been released, https://www.nuget.org/packages/Cake.Tool :cake: :rocket:@channel Version 3.0.0 of the Cake has just been released, https://www.nuget.org/packages/Cake.Tool :cake: :rocket:https://www.reddit.com/r/cakebuild/...https://www.reddit.com/r/dotnet/...https://www.reddit.com/r/csharp/...https://www.reddit.com/r/devops/...DevOpsCsharpRelease NotesDotnetContinuous IntegrationPublish Now