How to create a release
Release Guide
The following list describes the steps that need to be taken in order to release a new version of rationally.
- Increase the version number in the files
RationallyAddin.cs
and product.wxs
. The version number should follow semantic versioning guidelines.
- Commit and push latest changes.
- Assert that the
setup-project
contains the latest templates and stencils.
- Assert that the version number in
RationallyAddin.cs
and product.wxs
are the same.
- Build the msi.
- Assert that the msi was built in
RELEASE
mode (not DEBUG).
- Add the version number to the name of the msi. (e.g., rationally_v0-1-2.msi)
- Sign the msi using the Microsoft signtool
- Create a release on Github.
- The release should have the same version number as the msi.
- Add release notes.
- Upload the msi file.
We use a simplified semantic versioning scheme consisting of major.minor.build, e.g., 2.3.4. The version indicator should only contain numbers, otherwise users are not automatically informed about a new release.