[go: up one dir, main page]

CI/Docs: build only [dynamic] binaries for documentation jobs

Bruno Brequested to merge
8169-dynamic-bins-documentation-daily into master

What

Closes #8169 (closed).

Similarly to !20206 (merged) but for documentation.daily pipelines, we use dynamic Octez binaries instead of static ones to build the Octez developer documentation.

We can then remove all static build jobs in documentation pipelines, which leads to the cleaning of some code.

Why

  1. We need octez-snoop to build the full doc and this binary is not provided by the static build job.
  2. Using the same build jobs everywhere simplifies the codebase. Furthermore it means that documentation.daily tests exactly what happens during the documentation.update pipeline (the latter being used to update the public facing Octez developer documentation).

How

  1. The first commit is similar to the second commit of !20206 (merged) but for documentation.daily.
  2. The second commit removes the machinery used in docs/ci to select either dynamic or static binaries, since we now only use dynamic ones.
  3. The third and last commit removes the ad-hoc documentation:manuals_static.sh script used for static binaries.

Manually testing the MR

  1. Review CI code diff:
  • make -C ci check should pass
  • for the yaml diff, you may want to use ciaodiff to convince yourself that the diff in {before_merging|merge_train|documentation.update}.yml is just job reorderings
  • in documentation.daily.yml observe that static build job has been replaced with dynamic build jobs.
make -C ci
dune exec ci/ciaodiff/main.exe -- --origin HEAD^ before_merging
dune exec ci/ciaodiff/main.exe -- --origin HEAD^ merge_train
dune exec ci/ciaodiff/main.exe -- --origin HEAD^ documentation.daily
dune exec ci/ciaodiff/main.exe -- --origin HEAD^ documentation.update
  1. Review test pipelines to see that octez-snoop is now available.

There are two documentation.daily test pipelines:

NB: documentation.linkcheck failed but that it is independent of the MR (cf. the run in the latest documentation.daily pipeline: https://gitlab.com/tezos/tezos/-/jobs/12397497798).

Compare the documentation.manuals jobs and observe that

  1. Check that the manual is available for octez-snoop:
  1. Review the doc diff:

Given the nature of the changes (similar to !20206 (merged) and for a test pipeline), I'm not sure if it is completely necessary to do a full comparison as we did in !20206 (merged)

I can of course re-run the script if requested by a reviewer.

Checklist

  • Document the interface of any function added or modified (see the coding guidelines)
  • Document any change to the user interface, including configuration parameters (see node configuration)
  • Provide automatic testing (see the testing guide).
  • For new features and bug fixes, add an item in the appropriate changelog (docs/protocols/alpha.rst for the protocol and the environment, CHANGES.rst at the root of the repository for everything else).
  • Select suitable reviewers using the Reviewers field below.
  • Select as Assignee the next person who should take action on that MR
Edited by Bruno B

Merge request reports