This page collect and organize operations to be performed when releasing IG.

Step-by-step guide

Branching

  1. Kindly ask the Release Engineering Team for permissions to directly push on the main repository
  2. Execute maven release plugin to handle branching:

    1. When branching of the master, without touching the master's version

      mvn release:branch \
    -Pproduction-backstage-connect-build \
    -DbranchName=6.1 \
    -DupdateBranchVersions=true \
    -DupdateWorkingCopyVersions=false \
    -DautoVersionSubmodules=true \
    -DreleaseVersion=6.1.0-SNAPSHOT

    2. When branching the master, updating version on the master branch only

      mvn release:branch \
    -Pproduction-backstage-connect-build \
    -DbranchName=6.5 \
    -DupdateWorkingCopyVersions=true \
    -DautoVersionSubmodules=true \
    -DdevelopmentVersion=7.0.0-SNAPSHOT


  3. You can also copy and paste or drag and drop images into your instructions.

Updating dependencies to expected version

  1. Verify IG is using the appropriate openig-toolkit
  2. Verify that IG is using the appropriate forgerock-bom (COMMONS)
  3. Update, commit and merge
  4. Check versions in jenkins-scripts/modules/functional-tests-linux.groovy

Manual copyright checking

  1. Such as footers in HTML pages (sample app, welcome page, studio)

Release

  1. Open IG Release's Pipeline (https://ci.forgerock.org/view/OpenIG/job/openig-release/)
  2. Select the branch you want to release
    1. If it doesn't appear, execute "Scan Multibranch Pipeline Now", the release branch should show up some time later

  3. When on the branch page, execute "Build with Parameters"

       When about to release version x.y.z :

    1. Release Version: Name of the tag and released version, should be of the form x.y.z or x.y.z-RCi  (example : 6.1.0-RC2)

    2. Next Dev Version: Next version (usually, the same version that you are about to release) ending with -SNAPSHOT (ex: 6.1.0-SNAPSHOT)

    3. Doc Env: Choose QA for intermediate builds (milestones and RCs), that's the default, choose backstage for the real release only

    4. Doc Version: short version name ie x or x.y (example : 6 for 6.0.0 and  6.1 for 6.1.0)

Documentation

The IG documentation is separated from the project codebase (different lifecycle), but has a dependency on it (extract some files from the project archive).

  1. Verify that softwareVersion property is set to the associated IG maven-release version

  2. Verify doc version properties (pay attention, some of them are also declared in forgerock-release profile)

    <softwareVersion>6.5.0-SNAPSHOT</softwareVersion>
<softwareFullDisplayVersion>6.5.0</softwareFullDisplayVersion>
<docReleaseVersion>6.5</docReleaseVersion>
<platform.vers>6.0.0-SNAPSHOT</platform.vers>
<ig.vers>${platform.vers}</ig.vers>
<am.vers>${platform.vers}</am.vers>
<ds.vers>${platform.vers}</ds.vers>
<jpa.vers>3.5</jpa.vers>
<amster.vers>${platform.vers}</amster.vers>
  3. Go to the Jenkins doc pipeline (https://ci.forgerock.org/view/Docs/job/docs-pipelines/)
  4. Depending if you want to do an intermediate release or a final one, select either product-docs-qa-release or product-docs-release (respectively)
    1. As in IG release pipeline, execute Build with Parameters
      1. Select the appropriate Doc Set (product name + expected version)
        1. If the doc-set does not exist yet, ask Mark Craig
      2. Use the appropriate doc version number (6.1.0 or 6.1.0-1 for subsequent fix releases)

Related articles

Related articles appear here based on the labels you select. Click to edit the macro and add or change labels.

Related issues