Skip to content

ci: ignore templated release branch links#3159

Open
JSap0914 wants to merge 1 commit into
pingcap:mainfrom
JSap0914:fix/ignore-release-branch-template-link-3157
Open

ci: ignore templated release branch links#3159
JSap0914 wants to merge 1 commit into
pingcap:mainfrom
JSap0914:fix/ignore-release-branch-template-link-3157

Conversation

@JSap0914

@JSap0914 JSap0914 commented Jul 5, 2026

Copy link
Copy Markdown

What is changed, added, or deleted? (Required)

Fixes #3157.

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)
  • v1.6 (TiDB Operator 1.6 versions)
  • v1.5 (TiDB Operator 1.5 versions)
  • v1.4 (TiDB Operator 1.4 versions)
  • v1.3 (TiDB Operator 1.3 versions)

What is the related PR or file link(s)?

Verification

  • 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.
  • git diff --check

Copilot AI review requested due to automatic review settings July 5, 2026 06:53
@ti-chi-bot

ti-chi-bot Bot commented Jul 5, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

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:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@ti-chi-bot ti-chi-bot Bot added contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. labels Jul 5, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jul 5, 2026

Copy link
Copy Markdown

Welcome @JSap0914!

It looks like this is your first PR to pingcap/docs-tidb-operator 🎉.

I'm the bot to help you request reviewers, add labels and more, See available commands.

We want to make sure your contribution gets all the attention it needs!



Thank you, and welcome to pingcap/docs-tidb-operator. 😃

@ti-chi-bot ti-chi-bot Bot added the missing-translation-status This PR does not have translation status info. label Jul 5, 2026
@pingcap-cla-assistant

Copy link
Copy Markdown

CLA assistant check
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.

@ti-chi-bot ti-chi-bot Bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jul 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Broken Link Detected

2 participants