From 2855a85482f31b7d6ec199b759a312fce1ffb792 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 19 Sep 2024 10:14:41 +0200 Subject: [PATCH 1/3] doc,ci: linkcheck gets artifacts from manuals and docgen --- .gitlab/ci/pipelines/before_merging.yml | 4 ++++ .gitlab/ci/pipelines/merge_train.yml | 4 ++++ .gitlab/ci/pipelines/schedule_extended_test.yml | 4 ++++ ci/bin/code_verification.ml | 2 ++ ci/bin/common.ml | 9 +++++++-- 5 files changed, 21 insertions(+), 2 deletions(-) diff --git a/.gitlab/ci/pipelines/before_merging.yml b/.gitlab/ci/pipelines/before_merging.yml index 76cc6fb9d270..c2f5947048f6 100644 --- a/.gitlab/ci/pipelines/before_merging.yml +++ b/.gitlab/ci/pipelines/before_merging.yml @@ -4244,9 +4244,13 @@ documentation:linkcheck: allow_failure: true needs: - oc.docker:ci:amd64 + - documentation:manuals + - documentation:docgen - documentation:build_all dependencies: - oc.docker:ci:amd64 + - documentation:manuals + - documentation:docgen - documentation:build_all allow_failure: true timeout: 60 minutes diff --git a/.gitlab/ci/pipelines/merge_train.yml b/.gitlab/ci/pipelines/merge_train.yml index 76cc6fb9d270..c2f5947048f6 100644 --- a/.gitlab/ci/pipelines/merge_train.yml +++ b/.gitlab/ci/pipelines/merge_train.yml @@ -4244,9 +4244,13 @@ documentation:linkcheck: allow_failure: true needs: - oc.docker:ci:amd64 + - documentation:manuals + - documentation:docgen - documentation:build_all dependencies: - oc.docker:ci:amd64 + - documentation:manuals + - documentation:docgen - documentation:build_all allow_failure: true timeout: 60 minutes diff --git a/.gitlab/ci/pipelines/schedule_extended_test.yml b/.gitlab/ci/pipelines/schedule_extended_test.yml index 429edcffe615..d8cc55464a4a 100644 --- a/.gitlab/ci/pipelines/schedule_extended_test.yml +++ b/.gitlab/ci/pipelines/schedule_extended_test.yml @@ -2782,9 +2782,13 @@ documentation:linkcheck: - when: on_success needs: - oc.docker:ci:amd64 + - documentation:manuals + - documentation:docgen - documentation:build_all dependencies: - oc.docker:ci:amd64 + - documentation:manuals + - documentation:docgen - documentation:build_all allow_failure: true timeout: 60 minutes diff --git a/ci/bin/code_verification.ml b/ci/bin/code_verification.ml index 9e44e324a444..41bb5d45d6f8 100644 --- a/ci/bin/code_verification.ml +++ b/ci/bin/code_verification.ml @@ -1595,6 +1595,8 @@ let jobs pipeline_type = in let job_documentation_linkcheck : tezos_job = Documentation.job_linkcheck + ~job_manuals + ~job_docgen ~job_build_all ~rules: (make_rules diff --git a/ci/bin/common.ml b/ci/bin/common.ml index 208872efbfe8..eb4f1f02e123 100644 --- a/ci/bin/common.ml +++ b/ci/bin/common.ml @@ -1493,8 +1493,13 @@ module Documentation = struct ["make -C docs -j sphinx"] (** Create a [documentation:linkcheck] job. *) - let job_linkcheck ~job_build_all ?dependencies ?rules () : tezos_job = - let dependencies = mk_artifact_dependencies ?dependencies [job_build_all] in + let job_linkcheck ~job_manuals ~job_docgen ~job_build_all ?dependencies ?rules + () : tezos_job = + let dependencies = + mk_artifact_dependencies + ?dependencies + [job_manuals; job_docgen; job_build_all] + in job ~__POS__ ~name:"documentation:linkcheck" -- GitLab From d0c806ae9dab87950c30b60559c37a6c9c12f595 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 19 Sep 2024 15:46:11 +0200 Subject: [PATCH 2/3] doc: fix or tolerate more broken links --- docs/conf.py | 9 +++++++-- docs/developer/long-tezts.rst | 4 ++-- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index dc9a93a4a441..6519f066fecb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -239,14 +239,19 @@ texinfo_documents = [ linkcheck_anchors = False linkcheck_ignore = [ # links which may fail for lack of access rights: - 'https://gitlab.com/nomadic-labs/tezos/-/merge_requests/', + r'https://gitlab\.com/nomadic-labs/tezos/-/merge_requests/', r'http(s)?://localhost:\d+/?', + r'^https://grafana\.nomadic-labs\.cloud/', # local files, e.g. ../api/api-inline.html#*', \.\./CHANGES.html#version-* # (interpreted by linkcheck as external links, generating false positives) r'^\.\./', # flaky servers, to remove one day if they got more predictable r'^https://opentezos\.com/', - r'^https://crates.io/crates/tezos-smart-rollup', + r'^https://crates\.io/crates/tezos-smart-rollup', + r'^https://rpc\.ghostnet\.teztnets\.com/chains/main/blocks/', + r'^https://gitlab\.com/tezos/tezos/-/merge_requests/2771', + r'^https://gitlab\.com/tezos/tezos/-/merge_requests/3225', + r'^https://gitlab\.com/tezos/tezos/-/merge_requests/3267', ] linkcheck_allowed_redirects = dict( [ diff --git a/docs/developer/long-tezts.rst b/docs/developer/long-tezts.rst index 9bdcaf6c4d3d..73f2d342aadc 100644 --- a/docs/developer/long-tezts.rst +++ b/docs/developer/long-tezts.rst @@ -84,7 +84,7 @@ previous runs, and send an alert if the difference is too large. The ``Long_test`` module also provides function ``update_grafana_dashboard`` called in :src:`tezt/long_tests/main.ml` with a specification to create/overwrite a dashboard -in `Nomadic Labs' Grafana `_. +in `Nomadic Labs' Grafana `__ (restricted access). Default is named ``Long Tezts`` but you can add additional dashboards using the ``Long_test.update_grafana_dashboard`` function. To add a dashboard for your tests, define it next to your test (in the same file), and declare it in the call to @@ -101,7 +101,7 @@ needs. And of course you can contribute to improve them. Automated long tezts logs are available in `Nomadic Labs' public S3 bucket browser `_. In case of InfluxDB issues, you can inspect -metrics in the `InfluxDB dashboard `_. +metrics in the `InfluxDB dashboard `__ (restricted access). InfluxDB itself is private and direct access via CLI is restricted to administrators. Example -- GitLab From 6c62eed56e69ccb1d5598f47a27851726963028b Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 20 Sep 2024 10:47:48 +0200 Subject: [PATCH 3/3] doc: quote all dots in web links within conf.py --- docs/conf.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 6519f066fecb..2565a12ea243 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -239,8 +239,8 @@ texinfo_documents = [ linkcheck_anchors = False linkcheck_ignore = [ # links which may fail for lack of access rights: - r'https://gitlab\.com/nomadic-labs/tezos/-/merge_requests/', - r'http(s)?://localhost:\d+/?', + r'^https://gitlab\.com/nomadic-labs/tezos/-/merge_requests/', + r'^http(s)?://localhost:\d+/?', r'^https://grafana\.nomadic-labs\.cloud/', # local files, e.g. ../api/api-inline.html#*', \.\./CHANGES.html#version-* # (interpreted by linkcheck as external links, generating false positives) @@ -270,8 +270,8 @@ linkcheck_allowed_redirects = dict( r'https://github\.com/serokell/tezos-packaging/releases/tag/.*', ), ( - r'https://www.reddit.com/r/tezos/', - r'https://www.reddit.com/r/tezos/[?]rdt=[0-9]+', + r'https://www\.reddit\.com/r/tezos/', + r'https://www\.reddit\.com/r/tezos/[?]rdt=[0-9]+', ), ( r'https://ocaml\.org/api/.*', -- GitLab