...
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.
...
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.
This part must be done manually by the release teamOnce 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)
When creating a releaseAt 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 when as contributors will continue to work on the doc, the latest will be rebuilt from the latest main commit each time a new PR is merged, and the CalVer version and stable will be behind latest.
...