Release

This page describes how to create a new Kore release. We create new releases every two weeks, at the conclusion of an iteration. We increase the version number to match the iteration number and write changelog entries for any significant user-facing changes. These steps facilitate communication with our users: they get insight into the project from the changelog, and we can field bug reports more easily with the ever-changing version number.

1. In your local copy of the Kore repository, switch to the master branch and pull the latest changes:

git switch master
git pull upstream master  # 'upstream' is the name I use for the kframework/kore remote

2. Create a new branch for the release pull request:

git switch -C release--0.47.0.0

You can name this branch any way you like, of course.

3. Update the version: field in kore.cabal.
4. Update CHANGELOG.md. Add a new section for the new version, with the date. Use the Unreleased section at the top of the file as a template.
5. Commit the changes:

git commit -am 'kore-0.47.0.0'

6. Push the new branch to kframework/kore:

git push -u upstream kore-0.47.0.0

You should not push the branch to a fork because the GitHub Actions to update the Nix files will only run on the main repository.

7. Open a new pull request.
8. After the tests pass and the pull request is updated by GitHub Actions, pull the changes and push an empty commit:

git pull
git commit --allow-empty -m 'Trigger workflows'
git push

This is required because GitHub Actions modified the pull request automatically, but only manual commits are allowed to trigger the tests (for safety).

9. Squash and merge. (Get a review if you don't have admin access.) Delete the default extended commit description because it's only noise.
10. Immediately go to the main repository page on GitHub and create a new release. Give the tag vW.X.Y.Z and title the release kore-W.X.Y.Z.