Releasing a new version
Releasing is mostly handled by the CI:
- The version on GitHub is published automatically, including the description with the change log which is taken from the documentation.
- A PR is created automatically on the Winget repository to update to the new version.
Releases are usually made directly from the main branch.
The process is as follows:
- Edit the Documentation to add a corresponding entry in the Release notes section.
- In the root
package.json, setversionto the new version to be released. - Run
chore:update-versionto automatically update the version of the rest of thepackage.jsonfiles. - Run
pnpm ito update the package lock as well. - Commit the changes to the
package.jsonfiles and thepackage-lock.json. The commit message is usuallychore(release): prepare for v1.2.3. - Tag the newly created commit:
git tag v1.2.3 - Push the commit and the newly created tag:
git push; git push --tags. - Wait for the CI to finish.
- When the release is automatically created in GitHub, download it to make sure it works OK.