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

Table of Contents

style	none

Prerequisites (one-off)

The Windows machine you will use to do the build Installation box must have the following installed

...

Building a Release of the Jetty Base installer

There are two parts to releasing the jetty-base installer

...

Note
in progress

WTFM

Updating the jetty-base to reflect any changes in jetty
Building and publishing the msi file

Updating Jetty Base

The following is for a minor version change. Major version changes usually involved new contents and potentially manipulation of the idp.ini file (the only user configurable part of this install.

The following is for Jetty11

Preparation

Checkout the source of the relevant jetty version

Code Block
git checkout jetty-11.0.20

Update the pom to reflect the jettt and procrun versions

Code Block
<procrun.version>1.3.4</procrun.version> <jetty.version>11.0.20</jetty.version>

Logback and SLF4J Version

The versions are specified in the top level pom file of the jetty project

Code Block
<logback.version>1.4.14</logback.version> <slf4j.version>2.0.9</slf4j.version>

This changes have to be mirrored in the pom file for the jetty base project and the src/main/resources/jetty-base/start.d.dist/idp-system.ini file

Code Block
logback.version=1.4.14 slf4j.version=2.0.9

etc/jetty-ssl-context.xml

The is the most complex change and potentially the most fragile. Charges are needed if either of these two files have changed in Jetty

jetty-server/src/main/config/etc/jetty-ssl-context.xml
jetty-util/src/main/java/org/eclipse/jetty/util/ssl/SslContextFactory.java

You can check this with a command like this

Code Block

git diff jetty-11.0.18 jetty-11.0.20 jetty-server/src/main/config/etc/jetty-ssl-context.xml 
git diff jetty-11.0.18 jetty-11.0.20 jetty-util/src/main/java/org/eclipse/jetty/util/ssl/SslContextFactory.java

The explicit changes are:

Code Block

--- a/jetty-server/src/main/config/etc/jetty-ssl-context.xml
+++ b/jetty-server/src/main/config/etc/jetty-ssl-context.xml
@@ -5,25 +5,10 @@
     <Arg>
       <New id="sslContextFactory" class="org.eclipse.jetty.util.ssl.SslContextFactory$Server">
         <Set name="Provider" property="jetty.sslContext.provider" />
-        <Set name="KeyStorePath">
-          <Call name="resolvePath" class="org.eclipse.jetty.xml.XmlConfiguration">
-            <Arg><Property name="jetty.base"/></Arg>
-            <Arg><Property name="jetty.sslContext.keyStorePath" deprecated="jetty.sslContext.keyStoreAbsolutePath,jetty.keystore" default="etc/keystore.p12" /></Arg>
-          </Call>
-        </Set>
+        <Set name="KeyStorePath"><Property name="jetty.sslContext.keyStorePath" deprecated="jetty.sslContext.keyStoreAbsolutePath,jetty.keystore" default="etc/keystore.p12" /></Set>
         <Set name="KeyStorePassword"><Property name="jetty.sslContext.keyStorePassword" /></Set>
         <Set name="KeyStoreType" property="jetty.sslContext.keyStoreType" />
         <Set name="KeyStoreProvider" property="jetty.sslContext.keyStoreProvider" />
-        <Set name="KeyManagerPassword"><Property name="jetty.sslContext.keyManagerPassword" /></Set>
-        <Set name="TrustStorePath">
-          <Call name="resolvePath" class="org.eclipse.jetty.xml.XmlConfiguration">
-            <Arg><Property name="jetty.base"/></Arg>
-            <Arg><Property name="jetty.sslContext.trustStorePath" deprecated="jetty.sslContext.trustStoreAbsolutePath,jetty.truststore" /></Arg>
-          </Call>
-        </Set>
-        <Set name="TrustStorePassword" property="jetty.sslContext.trustStorePassword" />
-        <Set name="TrustStoreType" property="jetty.sslContext.trustStoreType" />
-        <Set name="TrustStoreProvider" property="jetty.sslContext.trustStoreProvider" />
         <Set name="EndpointIdentificationAlgorithm" property="jetty.sslContext.endpointIdentificationAlgorithm" />
         <Set name="NeedClientAuth" property="jetty.sslContext.needClientAuth" />
         <Set name="WantClientAuth" property="jetty.sslContext.wantClientAuth" />

Deconstructed this change is

Remove the prefixing of KeyStorePath with ${Jetty.base},this allows absolute paths to be used. Procrun is setup to allow relative paths to use this shortcut.
Remove the explicit setting of 5 bean properties, allowing the Java defaults to take over.. These can be checked in jetty-util\src\main\java\org\eclipse\jetty\util\ssl\SslContextFactory.java
- KeyManagerPassword This is used in getKeyManagers(). Having it not set means it defaults to the KeyStorePassword
- TrustStore reading the loadTrustStore will show that if these three properties are not set then the keystore is used.

With Jetty12 we will try to get around these issues

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

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.

Perform the release

Edit pom.xml to remove SNAPSHOT from versions.
Tag

Code Block
SET JETTY_TAG=11.0.18.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.0.18.3-SNAPSHOT</version> <jetty.version>11.0.18</jetty.version> <jetty.revision>3</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% 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=11.0.20
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 11-windows git push origin 11-windows git push origin %JETTY_TAG%

Versions Compared

Old Version 2

New Version 3

Key

Prerequisites (one-off)

Building a Release of the Jetty Base installer

Updating Jetty Base

Preparation

Update the pom to reflect the jettt and procrun versions

Logback and SLF4J Version

etc/jetty-ssl-context.xml

Building the Jetty-Base Installer

Checkout and Test Build

Smoke Test the installer.

Perform the release

Build the release version

Commit the work

Page Comparison

Versions Compared

Old Version 2

New Version 3

Key

Prerequisites (one-off)

Building a Release of the Jetty Base installer

Updating Jetty Base

Preparation

Update the pom to reflect the jettt and procrun versions

Logback and SLF4J Version

etc/jetty-ssl-context.xml

Building the Jetty-Base Installer

Checkout and Test Build

Smoke Test the installer.

Perform the release

Build the release version

Commit the work