v1.0.3

Update the build system dependencies and small fixes.

Migration

• Update PleOps.Cake version to 1.0.3 in the .csproj of the build orchestrator project
• Update docfx version
• Update .editorconfig to include rules for warnings IDE0057, SA1601, SA1602
• Update .NET SDK to 8.0.101
• Update version of tasks from GitHub Actions
• Update .gitignore to include launchsettings.json and *.DotSettings.user
• Set Visible="false" for the readme included in library csproj

What's Changed

• ⬆️ Update to PleOps Cake 1.0.3 by @pleonex in #35

Full Changelog: v1.0.1...v1.0.3

v1.0.1

Patch release fixing issue uploading release binaries to GitHub.

What's Changed

• ⏫ Update to recipe 1.0.1 by @pleonex in #34

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

v1.0.0 - Frosting recipe and modernized tools and docs

This release brings a new design of the Cake recipe using Cake Frosting, updated build tools and new doc modern layout.

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

Check-out the PleOps Cake release for more details

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

• Update .NET SDK to 6.0.406 in the GitHub CI workflow
• 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
• build.cake and nuget.config were updated to remove preview versions. Check the PleOps README to know how to use its preview version.
• 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.
• Dev container:
  • Migrated to Ubuntu 22.04 Focal to be compatible with latest dependencies. Update the file .devcontainer/Dockerfile.
  • Migrated VS Code extension definition to new format. Update the file .devcontainer/devcontainer.json
  • Rebuild the container
• Note that the workaround of the GitHub token explained in version 0.7.1 is no longer necessary. You can revert it to use secrets.GITHUB_TOKEN.

enhancement

• #28 ⬆️ Update to PleOps.Cake 0.8.0 (Cake 3.0)

v0.7.1

As part of this release we had 1 issue closed.

Migration steps

• Update .NET SDK to 6.0.302 in the GitHub CI workflow
• 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
• The contribution guidelines and GitHub issue templates have been updated, review and update if needed.
• Update nuget.config to use packageSourceMapping
• The list of VS extension for the dev container has been updated to include the GitHub extension GitHub.vscode-pull-request-github, add it if needed.

enhancement

• #27 ⬆️ Upgrade dependencies and contribution guidelines

v0.7.0

As part of this release we had 1 issue closed.

Migration steps

• Update dotnet-cake to 2.1 in .config/dotnet-tools.json
• Fix API docs for .NET 6 projects:
  • Replace the .csproj reference in docs/docfx.json with the DLLs. For instance, use: "MyLibrary/bin/**/MyLibrary.dll"
• It was a temporary GitHub issue. Not needed anymore 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

enhancement

• #26 ✨ Update build system for Cake v2.1

v0.6.1

As part of this release we had 1 issue closed.

Migration steps:

• Update your Dockerfile to remove the unnecessary tee command in the mono installation steps
• Update the PleOps.Cake version to 0.6.1 from build.cake

bug

• #25 Fix mono installation in dev container

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

Migration steps:

• Update the dockerfile for the dev container (.devcontainer/Dockerfile) to use the official .NET 6 image.
• Remove from the dev container config file(_.devcontainer/devcontainer.json _) the deprecated setting terminal.integrated.shell.linux
• Update your requirements in your README file.
• Update your GitHub workflow (.github/workflows/build-and-release.yml) to use the latest .NET SDK and remove .NET Core 3.1 SDK.
• Update the NuGet properties in src/Directory.Build.props to include the README: <PackageReadmeFile>README.md</PackageReadmeFile>
• Ignore the known warning from src/Directory.Build.props with <NoWarn>NETSDK1179</NoWarn>
• Pack the README file from your csproj files that creates NuGet packages:

   <None Include="../../README.md" Pack="true" PackagePath="$(PackageReadmeFile)" />

enhancement

• #24 Upgrade to .NET 6 and add README in NuGet

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

v0.5.1

As part of this release we had 1 issue closed.

Notable improvement for the release generator dependency: it's possible to do releases without milestones.

Migration steps:

• Update Cake.Tool from .config/dotnet-tools.json to version 1.3.0.
• Update PleOps.Cake to 0.5.1 from your build.cake file.

enhancement

• #23 Update to latest Cake 1.3.0, the .NET SDK for the CI and the project dependencies. Fix an issue in the Dockerfile for the dev environment.

v0.5.0

As part of this release we had 1 issue closed.

Enhancement

• #22 Migrate branch name develop to main #51