You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Releasing a new stable version of the documentation is to be done when the software new version is released.

The process is composed of 1 manual action and 2 automatically triggered actions:

  1. Manually create a release on Github.
  2. Automatically build the newly released doc.
  3. Automatically activate newly released doc version.

Github repository release manual actions

Documentation versioning follows the exact same Calendar Versioning (CalVer) pattern as the software, to enable users to find the documentation matching their software version easily.

This is done by creating a release on the Github documentation repository : https://github.com/hyperledger/besu-docs/releases

The Github release creation process creates a tag on the main branch in the Git repository and a Github release that will trigger the build of the new documentation version on Besu Read The Docs project.

Once this step is done (manually), the rest of the process is automatic (steps outlined below).

Read The Docs automatic webhook triggered build

Read The Docs (RTD) will generate the following versions when a new tag is detected on the besu repository main branch:

  • Latest: corresponds to the latest commit in the main branch of the doc repos
  • CalVer version (for example: "21.1.4"): corresponds to the tag on the main branch that was created during the release
  • Stable: corresponds to the last created tag on the main branch (for example 21.1.4)

At the time the release is created, RTD will build 3 versions : latest, CalVer version and stable and they will all show the same content from the same commit.

But then as contributors continue to work on the doc, the latest will be rebuilt each time a new PR is merged, and the CalVer version and stable will be behind latest.

Read The Docs version automatic activation

RTD is setup to activate CalVer numbered versions automatically once built: https://readthedocs.org/dashboard/hyperledger-besu/rules/

You can check the history of activations on this page as a maintainer.


NOTE: Besu doc repository default branch is now named main.

  • No labels