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