RELEASE.adoc

Releasing Eclipse Che documentation

Table of Contents

• Release workflow automation
• Releasing a major or minor version
• Releasing a patch version

Release workflow automation

The release.yml workflow implements and performs release procedures for the Eclipse Che Documentation, using the make-release.sh script.

The publication is decoupled. See Publishing Eclipse Che documentation.

Releasing a major or minor version

Prerequisites

• Define the Eclipse Che version to release: <major>.<minor>.0.

Procedure

1. Create the <major>.<minor>.x branch from the prerelease branch.

2. Edit the antora.yml file in the <major>.<minor>.x branch to define:

   prerelease: false
   version: stable
   asciidoc:
     attributes:
       prod-ver-patch: "<major>.<minor>.0"
       prod-ver: "<major>.<minor>"
       prod-ver-major: "<major>"

3. Generate the single-sourced documents:

   $ ./tools/checluster_docs_gen.sh
   $ ./tools/environment_docs_gen.sh

4. Commit and push the changes to the release branch.

5. Edit the publication-builder-antora-playbook.yml file in the publication-builder branch. Change the latest branch to "<major>.<minor>.x". Keep the other branches (7.43.x and main).

   # [...]
   content:
     sources:
       - url: https://github.com/eclipse-che/che-docs
         branches:
           - "<major>.<minor>.x"
           - "7.41.x"
           - main
   # [...]

Releasing a patch version

Prerequisites

• Define the stable <major>.<minor>.<patch> Eclipse Che version to release.

Procedure

1. Define asciidoc.attributes.prod-ver-patch in the antora.yml file in the <major>.<minor>.x branch:

   asciidoc:
     attributes:
       prod-ver-patch: "<major>.<minor>.<patch>"