v1.0.3

Fixes issue deploying projects to GitHub with no binary artifacts.

Migration

1. Update the version of PleOps.Cake in your build orchestrator .csproj
2. Update the GitHub Action task versions in your workflow file

What's Changed

• 🐛 Do not fail uploading binaries to the GitHub release if there are none by @pleonex in #81
• ⬆️ Update artifacts GitHub Action tasks by @pleonex in #82

Full Changelog: v1.0.2...v1.0.3

v1.0.2

This patch release brings additional fixes on the publication of artifacts to GitHub release and documentation improvements.

What's Changed

• 🐛 Fix GitHub binary upload using dotnet-tools by @pleonex in #78
• 📚 Add missing steps to setup GitHub Pages and other small doc fixes by @pleonex in #80

Full Changelog: v1.0.1...v1.0.2

v1.0.1

Patch release fixing a missing dependency in the task UploadReleaseBinariesTask to restore GitReleaseManager and doc improvements.

What's Changed

• 📖 Improve NuGet readme and document doc protection tag by @pleonex in #76
• 🐛 Missing dependency to restore GitReleaseManager when uploading binaries by @pleonex in #77

Full Changelog: v1.0.0...v1.0.1

v1.0.0 - Frosting recipe and documentation

This release brings a new design of the Cake recipe using Cake Frosting and full project documentation.

Due to the amount of changes, to migrate consider following the setup guide.

Documentation

Find the new documentation in https://www.pleonex.dev/PleOps.Cake. It includes:

• Detailed setup guide
• Checklist
• Pipeline workflows
• Strategies for versioning and gitflow
• Full recipe documentation with task description and build context properties.

Cake recipe

The previous NuGet is deprecated and there won't be new releases. The new Frosting based recipes can be found in the NuGet: Cake.Frosting.PleOps.Recipe. To use the recipe create a regular C# console application or use dotnet-script. Instructions in the new docs.

This new recipe brings the following changes:

• Support .NET 8 and Cake 4
• Project setup/definition (previous task Define-Project) now it happens in the build lifetime setup class
• New build context extensible
• New tasks grouped per technology
• Added incremental build concept to prevent cleaning artifacts dir each time
• New task to restore dotnet tools
• New task to set the version from GitVersion
• Deliveries paths are serialized into a json file to get deterministic behavior instead of folder and extension conventions
• Upgrade to new DocFx dotnet-tool CLI
• Publish .NET apps from user provided information in build context rather parsing .csproj
• Pack .NET libraries now from solution, customizable via <IsPackable> tags in .csproj instead of specifying projects manually
• New task to restore .NET dependencies
• GitHub repo info is read from environment variable rather parsing git remote

Limitations

• It doesn't generate preview release notes unless there is a draft GitHub release
• It doesn't create anymore draft releases
• It doesn't rename or close GitHub milestones
• It doesn't push docs to GitHub page. Use the official GitHub Action task

What's Changed

• ✨ New recipe design with Cake Frosting by @pleonex in #67, #68
• ✨ New documentation theme and format by @pleonex in #69
• ⬆️ Review and update C# style and coding rules by @pleonex in #70
• 🔼 Migrate to .NET 8.0 by @pleonex in #71
• 🔧 Refactor workflow into reusable files by @pleonex in #72
• 📚 Document project by @pleonex in #73, #75
• 🐛 Small fixes and improvements by @pleonex in #74

Full Changelog: v0.8.0...v1.0.0

v0.8.0 - Cake v3.0!

As part of this release we had 1 issue closed.

Migration steps

• Update cake.tool to 3.0 in .config/dotnet-tools.json. You can also run dotnet tool update cake.tool
• Update the PleOps.Cake version to 0.8.0 from build.cake
• If using VS Code Remote Containers, pull and rebuild the container
• Note that this version upgrades some third-party dependencies that use native libraries. They may no longer run in older versions of Linux OS that use libc < 2.33 like Ubuntu Focal or Debian 11.

enhancement

• #61 ⬆️ Upgrade to Cake 3.0 and bump dependencies

v0.7.1

As part of this release we had 3 issues closed.

Migration steps

• Update dotnet-cake to 2.2 in .config/dotnet-tools.json
• Update the PleOps.Cake version to 0.7.1 from build.cake
• If using VS Code Remote Containers, pull and rebuild the container

bugs

• #59 ☔ Test code coverage, fix dependency for .NET dev container and generate release notes on CI devs builds
• #60 🐛 Skip release notes on dev builds

enhancement

• #58 Update dependencies

v0.7.0 - Cake v2

✨ Migration to Cake 2.1!

As part of this release we had 2 issues closed.

Migration steps

• Update dotnet-cake to 2.1 in .config/dotnet-tools.json
• Fix tokens for release notes (it seems a temporary issue in GitHub):
  1. Create a custom token with the repo permissions.
  2. Add the token to the secrets repository/organization variables
  3. Replace secrets.GITHUB_TOKEN with secrets.<VAR_NAME> in .github/workflows/build-and-release.yml

bug

• #57 Replace GitHub token to access release notes

enhancement

• #56 Migrate to Cake v2

v0.6.1

As part of this release we had 1 issue closed.

bug

• #55 Fix Push-Doc was not pushing the documentation

v0.6.0

As part of this release we had 1 issue closed.

The dependencies to run the build system has changed:

• .NET 6 is now required to use the build system.
• .NET Core 3.1 is no longer required.
• Mono is still required for Linux and MacOS

enhancement

• #54 Update dependencies to support .NET 6

Full Changelog: v0.5.1...v0.6.0

v0.5.1

As part of this release we had 1 issue closed.

enhancement

• #53 Update to Cake 1.3 and dependencies
  • The latest version of GitReleaseManager allows to create a release without milestones.