Skip to content

[How To] Release a new version

Jump to bottom
Steven Giesel edited this page Jan 19, 2025 · 1 revision

This page describes how to release a new version of NCronJob.

The overall setup is done via the create-release action.

image

There are two options:

  • Version: This is a semantic version that ideally have three digits. A major, minor and patch version.
  • Prerelease: This flag indicates whether or not the release will have a preview suffix and will therefore be considered not stable by NuGet.

Also if prerelease == false, everything under the ## UNRELEASED part of the CHANGELOG.md will be taken and put into the release notes of the release (published on the GitHub page). The action will fail if there is no entry in that file. The action will also automatically move everything inside the CHANGELOG.md so that the ## UNRELEASED section will be empty afterward!

If prerelease == true then this will not happen. No changelog entry will be moved, nor will there be a new release on GitHub. It will just release a preview version to NuGet.

Ideally:

  • New features without breaking change should increase the minor version
  • Smaller bug fixes without changing the overall API surface will result in a patch version
  • Breaking changes will result in a major version (which will need documentation and migration guides)

Until now now prerelease and "real" release have the same version number. Therefore (even if the content is the same), increment at least the patch number from a prerelease to a release.

Clone this wiki locally