Release
Milestones:
- use milestones to track what's about to be released (merged PRs)
- Title:
- when there is no milestone, create a new one called
vNext
- once there are issues/PRs assigned to a milestone, keep the version up to date according to SemVer
- when there is no milestone, create a new one called
- Description: use a milestone's description to keep track of fixed issues and breaking changes (to be used later when releasing a new version)
- Title:
Releasing a new version:
Once you're happy with the state of the master
branch and want to release a new version:
- Go to Releases
- Draft a new release
- Tag: version according to SemVer, e.g.
4.0.0
orv4.0.0
- both will work - Title: can be a version number or a version number with a codename
4.0.0 - Cannonball
- Description: copy & past new features, bugfixes, and breaking changes from the milestone's description
- Pre-release: check if the release is a pre-release and contains a pre-release suffix
- Tag: version according to SemVer, e.g.
- Publish the release
- GitHub Actions will build the source using the
Release
configuration and upload the resulting artifacts to NuGet (and to the GitHub Release) - Close the current milestone and create a new one called
vNext