EclipseSCADA/Release/Perform

This page is work in progress

Preface

Common stuff

All release builds are performed using the "aggregator-release" project -> https://hudson.eclipse.org/scada/job/aggregator-release/

Related pages:

• Common Build Infrastructure/Build Types

This document uses "bash" shell commands and assumes your are running a Linux system with the following tools installed:

• Git
• Java 1.7
• Maven

Naming

Release Branch: 0.1.x-release

Tags (Release): R0.1.0

Tags (Milestone): S0.1.0.M1

Settings

All commands below will make use of the following shell variables:

branch=0.1.x-release
buildType=S
version=0.1.0
qualifier=M1

repos=external utils chart protocols base core hmi ide deploy releng

release="$version"
[ ! -z "$qualifier" ] && release="$release.qualifier"

tag="$buildType$release"

Prepare new release branch

Create a new branch for each release cycle: e.g. 0.1.x-release

for i in "repos"; do
  repo="org.eclipse.scada.${i}"
  echo $repo
  git clone git://git.eclipse.org/gitroot/eclipsescada/$repo
  pushd $repo
  git branch "$branch"
  git push origin "$branch"
  popd
done

Changes on the master must be merged to the release branch during the release cycle. New features that should not be included in the release must go to separate feature branches. After the final release is performed they may be merged on the master.

If it turns out that merging on the release branch is to cumbersome we will make branches for every release tag in order to prevent merge issues.

Checkout

git clone git://git.eclipse.org/gitroot/eclipsescada/org.eclipse.scada.external.git -b "$branch"
git clone git://git.eclipse.org/gitroot/eclipsescada/org.eclipse.scada.utils.git -b "$branch"
git clone git://git.eclipse.org/gitroot/eclipsescada/org.eclipse.scada.chart.git -b "$branch"
git clone git://git.eclipse.org/gitroot/eclipsescada/org.eclipse.scada.protocols.git -b "$branch"
git clone git://git.eclipse.org/gitroot/eclipsescada/org.eclipse.scada.base.git -b "$branch"
git clone git://git.eclipse.org/gitroot/eclipsescada/org.eclipse.scada.core.git -b "$branch"
git clone git://git.eclipse.org/gitroot/eclipsescada/org.eclipse.scada.hmi.git -b "$branch"
git clone git://git.eclipse.org/gitroot/eclipsescada/org.eclipse.scada.ide.git -b "$branch"
git clone git://git.eclipse.org/gitroot/eclipsescada/org.eclipse.scada.deploy.git -b "$branch"
git clone git://git.eclipse.org/gitroot/eclipsescada/org.eclipse.scada.releng.git -b "$branch"

# checkout master branch -- for testing only

git clone git://git.eclipse.org/gitroot/eclipsescada/org.eclipse.scada.external.git
git clone git://git.eclipse.org/gitroot/eclipsescada/org.eclipse.scada.utils.git
git clone git://git.eclipse.org/gitroot/eclipsescada/org.eclipse.scada.chart.git
git clone git://git.eclipse.org/gitroot/eclipsescada/org.eclipse.scada.protocols.git
git clone git://git.eclipse.org/gitroot/eclipsescada/org.eclipse.scada.base.git
git clone git://git.eclipse.org/gitroot/eclipsescada/org.eclipse.scada.core.git
git clone git://git.eclipse.org/gitroot/eclipsescada/org.eclipse.scada.hmi.git
git clone git://git.eclipse.org/gitroot/eclipsescada/org.eclipse.scada.ide.git
git clone git://git.eclipse.org/gitroot/eclipsescada/org.eclipse.scada.deploy.git
git clone git://git.eclipse.org/gitroot/eclipsescada/org.eclipse.scada.releng.git

Generate Qualifier

In order to be able to create proper maven release builds the -SNAPSHOT qualifier must be removed. This is done by the build helper "generate qualifier" mojo from the Eclipse SCADA releng repository. It uses the tycho jgit build timestamp provider to create timestamp based qualifiers and sets the qualifiers in all maven projects and synchs it back to bundles, features and repositories.

mvn versions:set -f org.eclipse.scada.releng/superParent/pom.xml -DnewVersion=$release
mvn org.eclipse.scada.releng:build-helper:0.0.12:generate-qualifier \
  -f org.eclipse.scada.releng/aggregator/pom.xml \
  -Prpm \
  -DdefaultNameProvider=static \
  -DnameProviderMap.eclipse-plugin=timestamp \
  -DnameProviderMap.eclipse-feature=timestamp \
  -DnameProviderMap.eclipse-test-plugin=timestamp \
  -DnameProviderProperties.staticQualifier=$qualifier \
  -DnameProviderProperties.timestampProvider=jgit

Commit and Tag

Commit the changed qualifiers to the branch and tag it.

for i in "repos"; do
  repo="org.eclipse.scada.${i}"

  pushd "$repo"
  git add .
  git commit -m "Generate version qualifiers for $release"
  git tag -a "$release" -m "Tag release - $release"
  popd
done

Build the tag locally

mvn clean verify \
  -f org.eclipse.scada.releng/aggregator/pom.xml \
  -Prpm -Pdeb -Peclipse-hudson \
  -Pmilestone '-P!nightly' '-P!integration' \
  -Ddownload.root=/tmp/my-download-test \
  -Declipse.download.root=http://download.eclipse.org

Check the output

The output goes to:

/tmp/my-download-test

Unless you changed the previous command ;-)

Output from the local build is not signed

Push commit and tag

Push the commit and tag if the local build was successful.

for i in "repos"; do
  repo="org.eclipse.scada.${i}"

  pushd "$repo"
    git push origin refs/heads/$branch refs/tags/$tag
  popd
done

Perform build

Perform the build on the Eclipse SCADA Hudson instance

Job: https://hudson.eclipse.org/scada/job/aggregator-release/

Which should execute the following build command:

mvn clean verify -Prpm -Pdeb -Peclipse-sign -Peclipse-hudson -Pmilestone '-P!integration'

Test

The usual…

Promote

To be written…