Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Two windows installers are built to support Windows users.:

  1. The IDP IdP installer is a thin shim on top of the standard installer

    1. It unpacks the distribution into ProgramData

    2. It collects some configuration information and captures it to properties files

    3. In It runs the standard installer using Property Driven Installation

  2. The Jetty installed installer deploys three subsystems

    1. A specific version of Jetty

    2. Procrun (a windows executable which allows java Java programs to be run as a “Service” (Windows-speak for a daemon)

    3. A version of jetty-base for Windows targetted targeted at the IdP installation

Both of these can be build using WiX4 which in turn is invoked as part of a standard maven run (on a suitable configured Windows machine) Windows Machine. These pages describe how to build a release of these installers

...

  • It must be strictly numeric.

  • It has a final digit (to allow multiple installer releases for the same IdP release). We usually use ‘99’ to mean “SNAPSHOT”.

...

If you are deploying a version with a non zero version (e.g. 5.1.2.1) you will need to rename the msi file by hand.

Building a Release of the Jetty

...

Installer

There are two parts to releasing the jetty-base Jetty installer:

  • Updating the jetty-base tree to reflect any changes in jetty

  • Building and publishing the msi file

Updating Jetty Base

The following is for Jetty12Jetty 12.x

For jetty-Jetty 12, we track the project version of jetty-base. The Branch branch we build from is currently named dev/IDP12-2285windows

Preparation

  • Clone and checkout the correct branch:

    Code Block
    git clone -b dev/IDP12-2285windows git@git.shibboleth.net:java-idp-jetty-base
    cd java-idp-jetty-base
  • Merge (not rebase) forward to the latest changes on the 12branch

    Code Block
    getgit merge 12
  • Update the pom to reflect the jettty and procrun versions

Code Block
<version>12.0.9.0-SNAPSHOT</version>

<properties>
  <jetty.version>12.0.9</jetty.version>
  <procrun.version>1.3.4</procrun.version>
...
  • Review the 12 version of src\main\resourcs\jetty-base\start.d\idp.ini and make any required changes to src\main\resourcs\jetty-base\start.d.dist\idp-system.ini

  • Commit the changes.

Building the Jetty

...

Installer

First set the revision (4th digit) of the installer version in the property file. This is usually 0, but if another version of the installer for the same jetty versio Jetty version is required it should be adjusted:

Code Block
        <jetty.revision>0</jetty.revision>

...

Code Block
cd %GIT_REPO%
git clone git@git.shibboleth.net:java-idp-jetty-base
cd java-idp-jetty-base
git checkout -b 1112-windows origin/1112-windows
mvn clean install -Dmaven.repo.local=%MAVEN_REPO%

Smoke Test the

...

Installer

Perform the release

  • Edit pom.xml to remove SNAPSHOT from versions.

  • Tag:

Code Block
SET JETTY_TAG=1112.0.188.3-WINDOWS
git add -A
git commit -m "Update files to be tagged for release"
git tag -s -m "Tag %JETTY_TAG%" %JETTY_TAG%
  • Edit pom.xml to change the the version, adding -SNAPSHOT Make sure that there is alignment between the version and the version properties

Code Block
<version>11<version>12.0.188.3-SNAPSHOT</version>
<jetty.version>11version>12.0.18<8</jetty.version>
<jetty.revision>3</jetty.revision>

...

Code Block
git checkout %JETTY_TAG%
mvn -Dmaven.repo.local=%MAVEN_REPO% clean install

Commit the

...

Work

Push to nexus using the gpg:sign-and-deploy-file plugin. For:

Code Block
ssh -L 1581:127.0.0.1:1581 -N build.shibboleth.net -f
REM or use Putty
set JETTY_VERSION=1112.0.208
set JETTY_REVISION=03
set VERSION=%JETTY_VERSION%.%JETTY_REVISION%

set NEXUS_URL=http://127.0.0.1:1581/nexus/content/repositories/releases
set REPO_ID=release

SET CL1=mvn -Dmaven.repo.local=%MAVEN_REPO% gpg:sign-and-deploy-file -Durl=%NEXUS_URL% -DrepositoryId=%REPO_ID%
SET CL2=-Dfile=target/shibboleth-jetty-base-x64-%VERSION%.msi -DgroupId=net.shibboleth.idp -DartifactId=idp-jetty-base-windows
SET CL3=-Dversion=%VERSION% -DgeneratePom=false -Dclassifier=msi

Set SIGN_AND_DEPLOY=%CL1% %CL2% %CL3%

%SIGN_AND_DEPLOY%

Push changes to git:

Code Block
git checkout 1112-windows
git push origin 1112-windows
git push origin %JETTY_TAG%

...

TAG% 

There are two batch files src\main\bin\setrepos.bat and src\main\bin\setvariables.bat which set things up.

...