document pipeline from the perspective of ocaml.org #48
Conversation
sabine
force-pushed
the
document_pipeline_upgrade_process
branch
from
12de7e9
to
79d2813
Compare
sabine
force-pushed
the
document_pipeline_upgrade_process
branch
from
79d2813
to
f8703da
Compare
|
PR: #51 probably needs to be merged and this one rebased afterwards to run smoothly |
|
@cuihtlauac Thank you. That is very helpful! |
| 1. live: `https://docs-data.ocaml.org/live/p/{PACKAGE_NAME}/{PACKAGE_VERSION}/` (manually-promoted live version), and | ||
| 2. current: `https://docs-data.ocaml.org/current/p/{PACKAGE_NAME}/{PACKAGE_VERSION}/` (always follows the `live` branch of `voodoo`). | ||
|
|
||
| The pipeline checks daily for updates to the `live` branch of this repository. When it finds new commits, the pipeline starts to build the package documentation using the new commits. It takes around 24-48h to complete the build. The resulting data appears in the `current` folder. |
There was a problem hiding this comment.
The pipeline checks daily for updates to the
livebranch of this repository
Why does the pipeline need to re-build for git changes to voodoo?
There was a problem hiding this comment.
The pipeline caches the build artifacts (package documentation data) for the different voodoo "tools" (prep, do, gen) based on the respective folder's most recent commit id.
When the commit id of prep, do, or gen changes, the pipeline starts a fresh build of all packages in the current folder.
(Also: what I wrote here refers to a live branch that doesn't exist yet, and we also don't have the ability to build documentation using "two versions of voodoo" in parallel.)
In order to make the process of deploying new voodoo versions more transparent and deliberate, we are changing the pipeline to listen to the
livebranch of this repository here: ocurrent/ocaml-docs-ci#91.This patch adds documentation about the pipeline aimed at https://github.com/ocaml/ocaml.org/ developers.
@TheLortex since you provided the original instructions in ocurrent/ocaml-docs-ci#89 (comment), please review when you find the time, and, if possible, clarify step 2 in "How to safely and seamlessly upgrade ocaml.org on breaking changes". (Or if step 2 happens automatically, we just remove it from these instructions.)