Skip to content

Tigl Release Guide

Martin Siggel edited this page Jul 23, 2020 · 7 revisions

Creating TiGL releases guide

A guide for making TiGL releases

cd misc/createChangeLog
python createChangeLog.py -o <old-version> -n <new-version> 
  • Manually edit the ChangeLog file. In the course of this, make sure to repect the syntax (cf. the logs of older versions):
  • The change log must be written in RST format. In particular use a newline above each indented block within a listing.
  • There is one exception to the above rule: Do not include a newline after the main items "Changed API", "General Changes", etc..
python changeLogToWikiAndDoc.py
  • Bump Version number in main CMakeLists.txt

  • Push updated ChangeLog file

  • Create a git tag using the version number as a tag name and prepend a "v". For example v2.0.2. Push the tag to github. This will automatically create and upload all build artifacts (documentation, windows, mac). Wait to finish.

  • Doublecheck the changelog for the new release on the github release page.

Linux releases with the openSUSE-build-service

  • On an Ubuntu 16.04 virtual machine you need
sudo apt-get install osc devscripts fakeroot cdbs rpm rpm2cpio python-urlgrabber python-m2crypto python-rpm

Moreover, download and install all packages from here. If you do this for the first time, sign in to openSUSE build service at https://build.opensuse.org/ and connect to it by typing

osc   

then, get the TIGL directory form openSUSE build service

osc checkout science:dlr/TiGL
  • Go into the TIGL directory of the osc project
cd science:dlr/TiGL
  • Update your local copy using
osc up
  • Run
make_release.sh <oldversion> <newversion>

This command changes the build files for rpms and debs and makes two test builds.

  • Commit the local changes to open build service using
osc commit -m "updated tigl to version x.y.z"