Skip to content

Preparing a new release

Jump to bottom
Zeex edited this page Aug 24, 2018 · 1 revision

Below are some guidelines on publishing a new release of the compiler (feel free to update).

  1. Update the version variables in source/compiler/CMakeLists.txt 
set(VERSION_MAJOR 3)
set(VERSION_MINOR 10)
set(VERSION_BUILD 8)
  1. Commit the updated CMakeLists.txt
git add source/compiler/CMakeLists.txt
git commit -m v3.10.8
  1. Create an annotated tag with the new version number, for example:
git tag v3.10.8 -m v3.10.8

Annotated tags are better because git describe uses them by default to display the current version, e.g. v3.10.8-33-g2f04b12 (it ignores non-annotated tags unless told otherwise).

  1. Push everything to GitHub
git push origin master --tags
  1. Merge master back into dev
git checkout dev
git merge master
git push origin master

  1. Wait for Travis CI and AppVeyor to finish building and uploading archives with binaries to GitHub

    Both of them will create a draft release with uploads attached, most likely it will be two different drafts so you will have to delete one of them and assign your new release tag to the other one.

  2. Add release description - list of noticeable changes, e.g. which bugs have been fixed and what new features have been added (preferably with references to corresponding issues if they exist)

Clone this wiki locally