From 72bff930cccc13c50c1e607d0735044e513651a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Suzanne=20Dup=C3=A9ron?= Date: Tue, 23 Jun 2020 20:44:00 +0100 Subject: [PATCH 1/3] Update URL to tezos documentation (the /mainnet/ path component was removed) --- .../docs/tutorials/get-started/tezos-taco-shop-payout.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gitlab-pages/docs/tutorials/get-started/tezos-taco-shop-payout.md b/gitlab-pages/docs/tutorials/get-started/tezos-taco-shop-payout.md index 7887eec35..be97c038d 100644 --- a/gitlab-pages/docs/tutorials/get-started/tezos-taco-shop-payout.md +++ b/gitlab-pages/docs/tutorials/get-started/tezos-taco-shop-payout.md @@ -72,7 +72,7 @@ const current_purchase_price : tez = ### Replacing *spendable* Smart Contracts However, due to the -[recent protocol upgrade](http://tezos.gitlab.io/mainnet/protocols/004_Pt24m4xi.html) +[recent protocol upgrade](http://tezos.gitlab.io/protocols/004_Pt24m4xi.html) of the Tezos `mainnet`, Pedro cannot access the tokens stored in his shop's contract directly. This was previously possible via *spendable smart contracts*, which are no longer available in the new From 2b790b0ebc2e3600d5667e4765a5228ec9b294e3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Suzanne=20Dup=C3=A9ron?= Date: Tue, 23 Jun 2020 21:48:21 +0100 Subject: [PATCH 2/3] Disable remote link checks and use static version of xrefcheck because it's faster to install than the whole Haskell environment --- .gitlab-ci.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 0a5b31e42..d76883544 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -77,8 +77,10 @@ xrefcheck: # Should be replaced with # nix run github:serokell/xrefcheck # Once flakes roll out to stable - - nix run -f https://github.com/serokell/xrefcheck/archive/v0.1.1.2.tar.gz -c xrefcheck - + # - nix run -f https://github.com/serokell/xrefcheck/archive/v0.1.1.2.tar.gz -c 'xrefcheck local-only' + - curl -L https://github.com/serokell/xrefcheck/releases/download/v0.1.1/release.tar.gz | tar -zxf - xrefcheck/bin/xrefcheck + # TODO: for now use --mode=local-only because we cannot configure the timeout and some Tezos documentation URLs take a while to reply. + - xrefcheck/bin/xrefcheck --mode=local-only # Strange race conditions, disable for now .webide-e2e: From 5cbeab0a3bfd61b1142749b2abd7a76763076bdf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Suzanne=20Dup=C3=A9ron?= Date: Tue, 23 Jun 2020 21:55:08 +0100 Subject: [PATCH 3/3] Use xrefcheck's config to increase the timeout --- .gitlab-ci.yml | 3 +-- .xrefcheck.yaml | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+), 2 deletions(-) create mode 100644 .xrefcheck.yaml diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index d76883544..39c87f000 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -79,8 +79,7 @@ xrefcheck: # Once flakes roll out to stable # - nix run -f https://github.com/serokell/xrefcheck/archive/v0.1.1.2.tar.gz -c 'xrefcheck local-only' - curl -L https://github.com/serokell/xrefcheck/releases/download/v0.1.1/release.tar.gz | tar -zxf - xrefcheck/bin/xrefcheck - # TODO: for now use --mode=local-only because we cannot configure the timeout and some Tezos documentation URLs take a while to reply. - - xrefcheck/bin/xrefcheck --mode=local-only + - xrefcheck/bin/xrefcheck # Strange race conditions, disable for now .webide-e2e: diff --git a/.xrefcheck.yaml b/.xrefcheck.yaml new file mode 100644 index 000000000..adde381e8 --- /dev/null +++ b/.xrefcheck.yaml @@ -0,0 +1,49 @@ +# SPDX-FileCopyrightText: 2019 Serokell +# +# SPDX-License-Identifier: Unlicense + +# Parameters of repository traversal. +traversal: + # Files and folders which we pretend do not exist + # (so they are neither analyzed nor can be referenced). + ignored: + # Git files + - .git + - xrefcheck + +# Verification parameters. +verification: + # On 'anchor not found' error, how much similar anchors should be displayed as + # hint. Number should be between 0 and 1, larger value means stricter filter. + anchorSimilarityThreshold: 0.5 + + # When checking external references, how long to wait on request before + # declaring "Response timeout". + externalRefCheckTimeout: 60s + + # Prefixes of files, references in which should not be analyzed. + notScanned: + # GitHub-specific files + - .github/pull_request_template.md + - .github/issue_template.md + - .github/PULL_REQUEST_TEMPLATE + - .github/ISSUE_TEMPLATE + + # GitLab-specific files + - .gitlab/merge_request_templates/ + - .gitlab/issue_templates/ + + # Glob patterns describing the files which do not physically exist in the + # repository but should be treated as existing nevertheless. + virtualFiles: + # GitHub pages + - ../../../issues + - ../../../issues/* + - ../../../pulls + - ../../../pulls/* + + # GitLab pages + - ../../issues + - ../../issues/* + - ../../merge_requests + - ../../merge_requests/*