Skip to content

Latest commit

 

History

History
67 lines (48 loc) · 1.83 KB

RELEASE.adoc

File metadata and controls

67 lines (48 loc) · 1.83 KB
Raw

Releasing Eclipse Che Documentation

Table of Contents

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. 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 master).

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

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>"