Skip to content

release

Jump to bottom
ftilde edited this page Oct 29, 2024 · 1 revision

How to release a new Voreen version

Testing

  • Run regression test suite on Windows/Linux/(Mac) Nvidia/ATI/(Intel)
  • Check public workspaces (resource/workspaces)
  • Check Python scripts (resource/scripts)

Preparations

  • Update Changelog.txt
  • Update version number in various files (use grep "$CURRENT_VERSION" to find them).
  • Update logo.txt using genlogo.sh in tools/ (e.g.: tools/genlogo.sh standard "voreen 5.1.0" logo.txt, figlet must be installed, font doom see below)
  • Update copyright (if year has changed): header.txt, ext/tgt/header.txt (then run tools/update-headers.pl), LICENSE.txt, LICENSE-academic.txt, Website
  • Update Tutorial Slides
  • Check: CREDITS.txt, readme.txt
  • Update snapshot script: tools/snapshot/snapshot-*.txt
  • Configure Windows binary deployment
  • framework resources to be deployed are specified in cmake/install.cmake
  • module resources to be deployed are specified in the respective module cmake files

Create Snapshot Archives

Voreen Deployment

Deployment is currently supported for both, Linux and Windows builds. The following guide will help you create a deployment build:

  • Configure CMake to include all modules to be included in the deployment build
  • Set CMAKE_INSTALL_PREFIX to the location the deployment build should be created at
  • Set VRN_DEPLOYMENT to ON (this will set VRN_ADD_INSTALL_TARGET to ON internally, therefore you can but don't need to enable it explicitly)
  • Generate CMake files
Linux
  • Ensure the correct build type is set (Release, Debug,..). For a deployment, preferably use Release which is set by default
  • Trigger the deployment using nice make -jN install where N is the number of processing cores of your system
  • The previously selected install/deployment location now will contain a VoreenVE.tar.gz archive including an AppImage of Voreen and all related resources
  • Simply ship the archive and tell the recipient to run the VoreenVe-AppImage
  • (!) The deployment is known to have runtime linker problems with the efsw library whose r-path doesn't seem to be set correctly by cmake (!)
Windows
  • Open the generated project with Visual Studio
  • Switch to Release Build
  • Trigger the deployment by build the install target
  • The previously selected install/deployment directory now will contain the executables and all related resources
  • Simply ship the install/deployment directory (or .zip it, optionally) and tell the recipient to execute the contained voreenve-executable

Update Wikipedia

http://en.wikipedia.org/wiki/Voreen

Clone this wiki locally