Creating a release

The steps below describe how to release version x.y.z

• Make sure that both the branch master and CoCalc contain the version you want to release. Especially, make sure that master is merged into CoCalc. If changes were made in the spkg folder, the merge cannot be done automatically, since that folder is removed in CoCalc. Just git rm the files and then commit. Usually this workflow will consist of the following commands. (Do not forget to remove the list of conflicting files from the commit message when doing the final commit.)

$ git checkout CoCalc
$ git merge master
$ git rm spkg/README.md
$ git rm spkg/conjecturing/package-version.txt
$ git commit

• Update the version information in the folder spkg
  • Switch to the branch master
  • Change the version in spkg/README.md to x.y.z
  • Change the version in spkg/conjecturing/package-version.txt
  • Commit the changes

$ git add spkg/README.md
$ git add spkg/conjecturing/package-version.txt
$ git commit -m "Upgrading to version 0.11.1"

• Check out the branch master and tag the new version.

$ git checkout master
$ git tag -a x.y.z -m "Tagging version x.y.z"

• Check out the branch CoCalc and tag the new version.

$ git checkout CoCalc
$ git tag -a x.y.z-CoCalc -m "Tagging version x.y.z-CoCalc"

• Push all changes and tags to GitHub.

$ git push --all
$ git push --tags

• Check out master, zip the folder conjecturing in the spkg folder, and rename the file to spkg.zip.
• Go to the GitHub releases section, and check the commits to master since the latest release. Make a list of the changes. We will need this to write the release notes.
• Next click on the 'draft a new release'-link, and enter the following data:
  • Tag version: x.y.z
  • Release title: Version x.y.z
  • Description: add the list of changes as an unordered list
  • Add the spkg.zip file in the binaries section.
• Repeat these steps for the CoCalc version:
  • Tag version: x.y.z-CoCalc
  • Release title: Version x.y.z-CoCalc
  • Description: add the list of changes as an unordered list
• Update the links and text on the website as needed.