Creating a release

This document describes the suggested steps to release a new stable version using the Cake.Recipe script.

Please note that the following steps assume you're using Cake.Recipe on GitHub and with a GitFlow workflow. Both are not requirements though and you can adopt the steps to other environments.

  1. Create a release branch (eg. release/1.2.3).
  2. Make sure that a GitHub milestone exists for this release.
  3. Make sure there were issues for all changes with the appropriate labels and the correct milestone set.
  4. Make sure that you have the following environment variables set in your local development environment:
  5. Create a GitHub release draft by running:
    • On Windows: .\build.ps1 --target=releasenotes
    • On MacOS/Linux: ./build.sh --target=releasenotes
  6. Check the generated release notes and make required manual changes.
  7. If release is ready finish release (merge back into master and develop) but don't tag the release yet.
  8. Publish the draft release on GitHub.

The last step will tag the release and trigger another build including the publishing. The build will automatically publish the build artifacts to the GitHub release, publish to NuGet and notify about the new release through Twitter (by default, but it is also possible to add notifications to Microsoft Teams and email), based on your specific settings.

GitHub