CAS 5.3.x Release Process

This page documents the steps that a release engineer should take for cutting a CAS server release.

Account Setup

  • You will need to sign up for a Sonatype account and must ask to be authorized to publish releases to the org.apereo package by creating a JIRA. Once you have, you may be asked to have one of the current project members vouch for you.
  • You will need to generate your own PGP signatures to sign the release artifacts prior to uploading them to a central repository.

Environment Review

  • Load your SSH key and ensure this SSH key is also referenced in GitHub.
  • Adjust $GRADLE_OPTS to initialize the JVM heap size, if necessary.
  • Load your ~/.gradle/gradle.properties file with the following as an example:
1
2
3
4
5

signing.keyId=7A24P9QB
signing.password=P@$$w0rd
signing.secretKeyRingFile=/Users/example/.gnupg/secring.gpg
org.gradle.daemon=false
org.gradle.parallel=false
  • Checkout the CAS project: git clone git@github.com:apereo/cas.git cas-server
  • Make sure you have the latest version of JDK 8 installed via java -version.

Preparing the Release

Apply the following steps to prepare the release environment. There are a few variations to take into account depending on whether a new release branch should be created.

Create Branch

1
2

# Replace $BRANCH with CAS version (i.e. 5.3.x)
git checkout -b $BRANCH
Remember

You should do this only for major or minor releases (i.e. 4.2.x, 5.0.x). If there already exists a remote tracking branch for the version you are about to release, you should git checkout that branch, skip this step and move on to next section to build and release.

Travis CI

  • Change .travis.yml to only build the newly-created release branch.

Do not forget to commit all changes and push changes upstream, creating a new remote branch to track the release.

Build

  • In the project’s gradle.properties, change the project version to the release version. (i.e. 5.0.0-RC1).
  • Ensure NPM is installed:
1

./gradlew npmInstall
  • Then build the project using the following command:
1

./gradlew clean assemble -x test -x check -DpublishReleases=true -DskipNodeModulesCleanUp=true -DskipNpmCache=true

Release

Release the project using the following commands:

1

./gradlew uploadArchives -DpublishReleases=true -DsonatypeUsername=<UID> -DsonatypePassword=<PASSWORD> -DskipNodeModulesCleanUp=true -DskipNpmCache=true -Dorg.gradle.internal.http.socketTimeout=160000 -Dorg.gradle.internal.http.connectionTimeout=160000

Performing the Release

Follow the process for deploying artifacts to Maven Central via Sonatype OSS repository.

  • Log into https://oss.sonatype.org.
  • Click on “Staged Repositories” on the left and find the CAS release artifacts at the bottom of the list.
  • “Close” the repository via the toolbar button and provide a description. This step may take a few minutes. Follow the activity and make sure all goes well.
  • “Release” the repository via the toolbar button and provide a description. The step is only enabled if the repository is successfully closed.

Finalizing the Release

  • Create a tag for the released version, commit the change and push the tag to the upstream repository. (i.e. v5.0.0-RC1).

If you did create a new release branch, you should also switch back to master and follow these steps:

  • In the project’s gradle.properties, change the project version to the next development version (i.e. 5.0.0-RC2-SNAPSHOT).
  • Push your changes to the upstream repository.

Housekeeping

Remember

When updating the release description, try to be keep consistent and follow the same layout as previous releases.

  • Mark the release as pre-release, when releasing RC versions of the project.
  • Send an announcement message to @cas-announce, @cas-user and @cas-dev mailing lists, linking to the new release page.

Update Overlays

Update the following overlay projects to point to the newly released CAS version. You may need to move the current master branch over to a maintenance branch for each of the below overlay projects, specially if/when dealing with major/minor releases and if the release process here had you create a new branch.

Update Documentation

Remember

You should do this only for major or minor releases (i.e. 4.2.x, 5.0.x).

  • Configure docs to point current to the latest available version here.
  • Update this page and add the newly released version.
  • Update the project’s README.md page as necessary.
  • Update this page to include any needed information on how to build the new release.

Update Maintenance Policy

Remember

You should do this only for major or minor releases (i.e. 4.2.x, 5.0.x).

Update the Maintenance Policy to note the release schedule and EOL timeline.

Optional

The following tasks are considered optional and may be done at the time of the release or later.

Update Demos

A number of CAS demos today run on Heroku and are tracked in dedicated branches inside the codebase. Take a pass and updated each, when relevant.

Docker Image

Release a new CAS Docker image. This task is only relevant when dealing with GA official releases, regardless of release calibre. All major/feature/patch releases qualify for a Docker release.