Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
UDig/Release
Contents
How to create a release
Pre-Check
- Are versions in
docs/common.py
set correctly ? - Is it required to have a What is New page (
docs/user/en/what_is_new
) ? - Is it neccessary to update Eclipse Help TOC (Table of content -
docs/user/toc.xml
andplugins/org.locationtech.udig.help/toc.xml
) ?
How to set/update versions
mvn tycho-versions:set-version -DnewVersion=<version> -Dtycho.mode=maven -Pproduct,sdk,docs,test -Dall
where `<version>` can have the following patterns:
- e.g. 1.5.0 for final RELEASE
- e.g. 1.6.0-SNAPSHOT for Development-Version
- e.g. 1.5.0.RC1 for Release-Candiates
NOTEs:
* Its important to build with listed profiles to update versions in all maven modules * Its required to have Major-, Minor- and Patch-Version (1.5.0 instead 1.5 to be OSGi complaint - otherwise maven build will fail)
Release-Procedure
Create a Release-Branch
e.g. for 1.5.x Release serie create a branch from master (feature freeze) create a branch and checkout it:
git checkout -b 1.5.x
Update from Development-Version to Release(candidate)
Just set `<version>` to prefered release version, e.g. 1.5.0 or 1.5.0.RC1
Release-Build with maven
Its required to have Sphinx installed to make docs auf or Restructured Text.
mvn clean install -Pproduct,sdk,docs
create installable artifacts
Navigate into deploy folder:
cd deploy
To prepare update version.sh and set version for the release to package. Change the following two lines:
export SERIES=1.5 export VERSION=1.5.0.RC1
Afterwards, start packaging with:
./all.sh
NOTE: To create dmg packages for Mac OSX its required to have a Mac OSX Environment
Update next Development-Version on Release-Branch
Set Version from 1.5.0 to 1.5.1-SNAPSHOT
Update next Development-Version on Master-Branch
Set Version from e.g. 1.5.0-SNAPSHOT to 1.6.0-SNAPSHOT