You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The link workflows download the shared PingCAP .lycheeignore, which already excludes encoded tidb_operator_version template URLs. This PR appends the matching encoded tidb_operator_release_branch template URL pattern before running lychee in both the scheduled full link check and the pull-request fail-fast link check.
This keeps the documentation source using the release-branch variable while preventing lychee from treating the unrendered template placeholder as a real raw GitHub branch.
Source proof:
Current variables.json sets tidb_operator_release_branch to release-2.0.
The rendered target https://raw.githubusercontent.com/pingcap/tidb-operator/refs/heads/release-2.0/hack/get-grafana-dashboards.sh returns HTTP 200.
The unrendered encoded placeholder URL reported by Broken Link Detected #3157 returns HTTP 404 before the new ignore pattern.
Duplicate PR search before work and before PR creation returned no open PRs for Broken Link Detected #3157 / get-grafana-dashboards.sh / tidb_operator_release_branch.
Which TiDB Operator version(s) do your changes apply to? (Required)
main (the latest development version for v2.x)
v2.0 (TiDB Operator 2.0 versions)
release-1.x (the latest development version for v1.x)
RED: lychee -E -i -n -t 45 --root-dir "$PWD" -- en/monitor-a-tidb-cluster.md zh/monitor-a-tidb-cluster.md failed with the two tidb_operator_release_branch raw URL 404s from Broken Link Detected #3157.
GREEN: same focused lychee command after simulating the workflow append returned 0 Errors, 8 Excluded.
python3 + PyYAML parsed .github/workflows/link.yml and .github/workflows/link-fail-fast.yaml successfully.
This pull-request has been approved by: Once this PR has been reviewed and has the lgtm label, please assign kissmydb for approval. For more information see the Code Review Process. Please ensure that each of them provides their approval before proceeding.
The full list of commands accepted by this bot can be found here.
Details
Needs approval from an approver in each of these files:
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You have signed the CLA already but the status is still pending? Let us recheck it.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
contributionThis PR is from a community contributor.first-time-contributorIndicates that the PR was contributed by an external member and is a first-time contributor.missing-translation-statusThis PR does not have translation status info.size/XSDenotes a PR that changes 0-9 lines, ignoring generated files.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What is changed, added, or deleted? (Required)
Fixes #3157.
The link workflows download the shared PingCAP
.lycheeignore, which already excludes encodedtidb_operator_versiontemplate URLs. This PR appends the matching encodedtidb_operator_release_branchtemplate URL pattern before running lychee in both the scheduled full link check and the pull-request fail-fast link check.This keeps the documentation source using the release-branch variable while preventing lychee from treating the unrendered template placeholder as a real raw GitHub branch.
Source proof:
variables.jsonsetstidb_operator_release_branchtorelease-2.0.https://raw.githubusercontent.com/pingcap/tidb-operator/refs/heads/release-2.0/hack/get-grafana-dashboards.shreturns HTTP 200.get-grafana-dashboards.sh/tidb_operator_release_branch.Which TiDB Operator version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
Verification
lychee -E -i -n -t 45 --root-dir "$PWD" -- en/monitor-a-tidb-cluster.md zh/monitor-a-tidb-cluster.mdfailed with the twotidb_operator_release_branchraw URL 404s from Broken Link Detected #3157.0 Errors,8 Excluded.python3+ PyYAML parsed.github/workflows/link.ymland.github/workflows/link-fail-fast.yamlsuccessfully.git diff --check