Page History

...

This is written primarily for Apache Tomcat release managers although it may also be of interest to anyone looking to validate and/or replicate the release process. This page uses Tomcat 9 as an example but the same process applies to later versions as well.

Pre-requisites

• A git client installed and on your path
• Apache Ant installed and on your path (see BUILDING.txt in the root of the code repository for version requirements)
• The latest release of the minimum Java version that the Tomcat version runs on installed and on your path
• Operating system
  • Windows just works
  • Linux also requires wine (standard package manager version should be fine)
  • MacOS also requires wine (see below)
• GnuPG installed
• A public key that is part of the Apache web of trust
• A reasonable internet connection (you will need to upload ~100MB)

The above can be accomplished on a Windows 10 Virtual Machine from Microsoft's Edge Development resources. Download + unpack the archive for your VM software and launch the VM. Login, open a PowerShell.exe window as Administrator, and installed Chocolatey:

PS C:\Users\IEUser> Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))

Once Chocolatey is installed, you can install all the above prerequisites at once:

PS C:\Users\ISUser> choco install git svn adoptopenjdk11 ant gnupg sed xsltproc

This command will run for a while, and ask you repeatedly if it's okay to run "chocolateyInstall.ps1", which you will have to do to proceed. Once the above command has completed, you have all the software prerequisites installed and on your PATH. Well, once you quit PowerShell and launch a new CMD.EXE or PowerShell window, of course

wine on MacOS

This is for 11.x.x (Big Sur)

You will need to install homebrew if you haven't already.

Then install wine-crossover from https://github.com/Gcenx/homebrew-wine

Configure a 32-bit wine environment using:

WINEARCH=win32 WINEPREFIX=~/.wine32 winecfg

Then before you start the release ensure the following environment variables are set:

export WINEARCH=win32
export WINEPREFIX=~/.wine32

Please ensure that you have an environment that is set up properly for a release build, plus that you are using the latest versions of toolchain components (specifically, the JDK and ant).

Preliminary checks

• Check that the version numbers have been incremented after the previous release, as expected. (e.g. https://github.com/apache/tomcat/commit/cec14f9c33af9da271c9681bf6b343c61b6d055a)
• Check that the changelog file mentions your login name as release manager for this release (e.g. "Tomcat 9.0.94 (markt)").
• Check whether the KEYS file differs from https://dist.apache.org/repos/dist/release/tomcat/tomcat-9/KEYS one. The latter one will be replaced after you do a release. Check that the KEYS file contains your public key.
• Check that the full build still works (ant release, preferably). Check that Buildbot builds (https://tomcat.apache.org/ci.html#Buildbot) are green.
• Prepare your build environment:
  
  • Add a build.properties file (or, better yet, keep this file in your ~/build.properties if you have a dedicated build machine) with the following configuration (adjust paths for your environment)

  • 
    

    No Format

    execute.validate=true execute.test.bio=true execute.test.nio=true execute.test.apr=true test.haltonfailure=true gpg.exec=C:/Program Files (x86)/GNU/GnuPG/gpg2.exe #gpg.exec=/usr/bin/gpg base.path=C:/temp/libs #base.path=~/tomcat-libs # Enable the following if the DigiCert ONE magic is all set up, including ~/.digicertone/pkcs11properties.cfg codesigning.storepass=apikey|keystorepath|keystorepassword do.codesigning=true

    
    

...

• Perform an git clone and switch to the correct branch
  • git clone https://github.com/apache/tomcat /c/releases/asf-tomcat or git clone -b 9.0.x git clone https://github.com/apache/tomcat /c/releases/asf-tomcat
  • cd /c/releases/asf-tomcat
  • git checkout 9.0.x
  • git pull
• (Hint: using ant pre-release  may save you the following step, plus steps 2-3 in the Maven release process.)

• Edit "build.properties.default" and change the lines after "# ----- Reproducible builds -----" to a new value. (NOTE: this is done by 'ant pre-release')

  • Note that the value of ant.tstamp.now property is in seconds (unlike the value returned by System.currentTimeMillis() method which is milliseconds, see bug 65527 for how this happened for Tomcat 8.5.70).
    The value can be printed in a Bash shell with the following command:
    date +%s
    To print seconds since epoch, and date and time in human-readable format in UTC time zone:
    date -u '+%s %Y-%m-%d %H:%M:%S %Z'

• Edit "build.properties.default" and change the line version.dev=-dev to version.dev= (NOTE: this is done by 'ant pre-release')

  • This can be done with sed -i.bak "s/^version.dev=.*/version.dev=/" build.properties.default
• Edit "webapps/docs/changelog.xml" and replace rtext="in development" with rtext="Release in progress" for the version being released (NOTE: this is done by 'ant pre-release')
  
  • Remember that notepad.exe will remove UTF-8 Byte-Order Marks (BOMs). Use write.exe or Notepad++ instead.
• Build the release

  • ant release

• Commit these changes

  • git add --all (to pick-up the repeatable build artifacts in addition to the content-changes from above ; is this necessary with commit --all?)

  • git commit --all --message "Tag 9.0.94"
  • git tag 9.0.94
  • git push origin 9.0.94
• Check the diff mailed to the dev list

...

• Reset to the 9.0.x branch (git reset HEAD~ && git checkout build.properties.default && git checkout webapps/docs/changelog.xml && rm -f build.properties.release res/maven/mvn.properties.release res/install-win/Uninstall.exe.sig res/install-win/tomcat-installer.exe.sig)

I found it simplest to keep this clone for tagging to ensure no other edits found their way into the tag.

...