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”.

...

This is done using maven, on an appropriate windows machine in . You need to run the idp-msi fileand the idp-bom projects only.

Code Block
mvn clean install -frf :idp-msi
Note

Make sure that the bom project runs - this will run the “m2 enforcer”.

Sign and deploy the msi file

...

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.98.0-SNAPSHOT</version>

<properties>
  <jetty.version>12.0.9<8</jetty.version>
  <procrun.version>1.3.4</procrun.version>
...
  • Commit the changes

Building the Jetty-Base 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 is required it should be adjusted

...

  • 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

  • Set revision to zero (f needed)

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

Checkout and Test Build

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

Smoke Test the installer.

...

  • test build and smoke test

  • Commit the changes.

Building the Jetty Installer

Set up tag point (and tag if possible)

  • Edit pom.xml to remove SNAPSHOT from versions.

  • Tag (this may be deferred if running on a GPG deficient build machine)

Code Block
SET JETTY_TAG=1112.0.188.30-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<revision>0</jetty.revision>
  • Commit

Code Block
git add -A
git commit -m "Bump version after release"

Build the release version

Code Block
git checkout %JETTY_TAG% (or HEAD~1)
mvn -Dmaven.repo.local=%MAVEN_REPO% clean install

Test the released version

Commit the Work

(this assumed that the build was done on a GPG-deficient machine)

  • Push the work done above (on the build machine)

  • Move msi to GPG machine

  • Checkout to the build point and tag

    Code Block
    git pull 12-windows
    git checkout 12-windows~1
    # CHECK at correct point
    git tag -s -m "Tag %JETTY_TAG%" %JETTY_TAG%
  • Clean git reposuitory and move the test msi file into target

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

...

  • :

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=0
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.

...