Skip to content

Tigl Release Guide

Tobias Stollenwerk edited this page Mar 18, 2015 · 7 revisions

Creating TiGL releases guide

A guide for making TiGL releases

  • Testing!!!
  • Update the ChangeLog file. The following command will prepend a draft of change logs to the ChangeLog file
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..

  • Convert the updated ChangeLog to Google code wiki syntax and upload it to Last Changes

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

  • Log into the DLR jenkins site. Call following jobs (if they didn't run automatically) and download the binary packages (win32.exe and win64.exe)

  • Chameleon_tigl_win32

  • Chameleon_tigl_win64

  • Chameleon_tigl_api_doxygen (this creates and uploads the new documentation)

  • Create source code package using

make package_source

Note, that everything that is inside the source directory will be also in the source package. Thus you should work with a separate build directory outside the source. Therefore its recommended to use a fresh clone and build outside of the source directory. For example:

mkdir release
cd release
git clone git@github.com:DLR-SC/tigl.git 
cd tigl
mkdir build
cd build
cmake-gui ../tigl
make package_source
  • Upload packages (source and binaries) to sourceforge:
  • Create new subfolder on sourceforge e.g. Files/Releases/2.1.1/
  • Upload e.g.
scp TIGL-2.1.1-Source.tar.gz TIGL-2.1.1-win32.exe TIGL-2.1.1-win64.exe <sourceforge-username>,tigl@frs.sourceforge.net:/home/frs/project/tigl/Releases/2.1.1/
  • Add new realease in the Github releases page and upload the 4 windows binaries (win32.exe, win32.zip, win64.exe, win64.zip).

  • Do the openSUSE-build-service build (works best on Ubuntu)

  • On an Ubuntu 13.10 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 [- If you do this for the first time, sign in to openSUSE build service at https://build.opensuse.org/ and connect by typing

osc   

then, get the TIGL directory form openSUSE build service

osc checkout home:martinsiggel/TIGL
  • Go into the TIGL directory of the osc project
cd home:martinsiggel/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.

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