Skip to content

Latest commit

 

History

History
91 lines (70 loc) · 3.04 KB

RELEASE.adoc

File metadata and controls

91 lines (70 loc) · 3.04 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

  • Docs being released as part of the Eclipse Che Release cycle must have all previous steps to be completed.

  • All pending issues/PRs that must be included before the release must be resolved/merged.

Procedure (steps performed in the make-release.sh script)

  1. From the main branch, open and merge a PR to main to update the Che version values in antora.yml:

    Tip
    		 You can proceed to step 2 without waiting for this PR to be merged.

    1. Update the prod-…​ version values to the just released Che version:

          prod-ver-major: "7" # update this only if there is a major version change
    prod-ver-patch: "7.62.0"
    prod-ver: "7.62"

    2. Add a commit message and PR title like chore: update product version values in antora.yml to Che 7.62 and explain the changes:

      ## What does this pull request change?
Bump up the Che version to the latest release for the main branch.

## Specify the version of the product this pull request applies to
Merge to `main`

  2. From the main branch, create a release branch with a branch name in the format <major>.<minor>.x.

    Note
    		 The name of the release branch differs from the number of the release in the trailing x.

  3. In the <major>.<minor>.x branch, update the following product-version-related values in antora.yml:

    prerelease: false
version: <major>.<minor>.x # name of release branch
asciidoc:
  attributes:
    prod-ver-patch: "<major>.<minor>.0"
    prod-ver: "<major>.<minor>"
    prod-ver-major: "<major>"

  4. In the publication-builder branch, update the first branches value to the latest release branch (from step 2) in publication-builder-antora-playbook.yml.

    content:
  sources:
    - url: https://github.com/eclipse-che/che-docs
      branches:
        - 7.62.x
        - che-7-redirections
        - main
    Warning
    		 Do not remove the other branches like 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 antora.yml in the <major>.<minor>.x branch:

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