This pages sums up technical information to perform the different tasks
from the release process. Action items from the release template link here. In the following sections, the release will have the generic name: MAJOR.MINOR.PATCH.
Each number shall be replaced by the current release number.
For a release version 3.2.1, the naming convention should follow the
If it is the 2nd release candidate: OTB-3.2.1-rc2.[zip/tar.gz/tar.xz].
The management of older versions is done during the release process, so
that at each time there is at least one stable release (non RC) in the
packages directory. Older versions remain archived in:
This is a simple script to run, but it should be run from its directory.
The tool (based on codespell) will identify potential spelling errors
and suggest a replacement. The user accepts or refuses those changes
Translation for Monteverdi & Mapla
The translation is done using Qt tools. The strings to translate have a
special definition in the source code. Qt tools such as lupdate or
lrelease can parse and register them in a .ts file. This file is the
source file for translation, it contains original strings and their
translation. There is one .ts for each translation language.
Currently, OTB only has a french translation file : i18n/fr_FR.ts. To
parse again all the strings in source code and update the ts file, you
Go to a build directory of OTB with Monteverdi and Mapla enabled.
Enable the option OTB_I18N_MERGE_TS and build the target
cmake -D OTB_I18N_MERGE_TS:BOOL=ON .make i18n
It will update the ts file with the new strings detected. Take caution
because when OTB_I18N_MERGE_TS is ON, the call to make clean will
remove the TS file.
Disable OTB_I18N_MERGE_TS for safety and faster build
cmake -D OTB_I18N_MERGE_TS:BOOL=OFF .
Go to the corresponding OTB source directory
Add a translation for strings that don't have any, using a text
editor or linguist tool. Beware, the translation of the keymap is a
bit tricky (html formatted bloc).
Finally commit changes made to the TS file.
The resources for OTB website are placed in separate folders :
/var/www/doc : all resources for documentation
/var/www/archives : storage for source code, binary packages, and
/var/www/wordpress-4.0 : website architecture
A lot of resources are accessed with symlinks. The advised command to
define a symlink is :
ln -nsf target_file link_name
The SuperBuild archive is an all-in-one archive with the sources of the
different projects compiled by the SuperBuild. The versions of these
projects may vary between 2 releases, so the release number should be
visible on this archive. The MD5 sum of the archive is also supplied.
Since it is a large archive, users may need to check the download was
successful. The archives for the develop branch and the latest release
branch are produced nightly and available on the website :
These files should be copied to the OTB website in :
Old archives should be added to /var/www/archives/packages/archives/OTB/
For manual generation
Both archive and md5 sum can also be generated from a CMake target in
OTB project :
This command will try to download all sources in
OTB_BINARY_DIR/Download, and produce the output files in
OTB_BINARY_DIR. It will also report dead links.
If this archive is for a particular release, use the naming conventions
The CookBook is generated for the latest commit on release branch. The PDF and tar.gz archive should be
copied in: /var/www/archives/packages. The online html version shall be
deployed in /var/www/doc/CookBook-MAJOR.MINOR.
tar -xzf /var/www/archives/packages/ci/staging/CookBook-MAJOR.MINOR-html.tar.gz -C /var/www/doc
The symlinks in /var/www/wordpress-4.0 have to be updated :
cd /var/www/wordpress-4.0ln -nsf /var/www/doc/CookBook-MAJOR.MINOR CookBook-MAJOR.MINORln -nsf CookBook-MAJOR.MINOR CookBook
Update version list in CookBook
In the develop branch, update the file Documentation/Cookbook/_static/html/versions.html with the new version and link.
The doxygen is generated for the latest commit on release branch. The current doxygen should be copied to
cd /var/www/doctar -xjf /var/www/archives/packages/ci/staging/OTB-Doxygen-MAJOR.MINOR.tar.bz2 -C .mv html doxygen-MAJOR.MINOR
The symlinks in /var/www/wordpress-4.0 have to be updated:
cd /var/www/wordref-4.0ln -nsf ../doc/doxygen-MAJOR.MINOR doxygen-MAJOR.MINORln -nsf doxygen-MAJOR.MINOR doxygen
Wordpress content update
After a release, the “Download” page should be updated. This page can be
edited from the wordpress admin interface (look for Pages -> Download).
The front page of the website should also be updated with the last
released version and the date. From the wordpress admin interface, look
for Pages -> “Open Source processing of remote sensing images - Front
Note : In a different version of wordpress, the front page buttons were
edited through “Appearance” -> “Theme Options” -> “Header One
Standalone packages sanity check
Manually check that the packages that are about to be released as the
next OTB version are working. For a given platform, do the following:
Identify the exact file about to be released
Download that file
Follow word-for-word the official installation procedure from the
Activate Help/About... dialog and check version number