Skip to content

.github: check connectivity of external links via GitHub action #4464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 23 commits into from
Nov 2, 2020
Merged

.github: check connectivity of external links via GitHub action #4464

merged 23 commits into from
Nov 2, 2020

Conversation

@yikeke
Copy link
Contributor

@yikeke yikeke commented Sep 9, 2020 •
edited
Loading

What is changed, added or deleted? (Required)

A migration from pingcap/docs-dm#353

Note this external link check isn't required to pass, in order to prevent false alarms from blocking PR merge.

The current regex exclusions is:

http://172.*|https://github.com/.*/pull/.*|https://github.com/.*/issues/.*|https://github.com/[^.\n]*$|http://127.0.0.1.*|http://localhost.*|http://.*:.*|https://static.googleusercontent.com/media/research.google.com/.*|.*.md

Meaning the check will skip checking the URLs matching the above patterns.

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v4.0 (TiDB 4.0 versions)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)

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

  • This PR is translated from:
  • Other reference link(s):

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Have version specific changes
  • Might cause conflicts

@yikeke yikeke added needs-cherry-pick-3.1 translation/doing This PR’s assignee is translating this PR. labels Sep 9, 2020
@yikeke yikeke self-assigned this Sep 9, 2020
@yikeke yikeke changed the title .github: check connectivity of external links via GitHub action [WIP] .github: check connectivity of external links via GitHub action Sep 9, 2020
@yikeke yikeke requested a review from csuzhangxc September 9, 2020 07:27
@yikeke
Copy link
Contributor Author

yikeke commented Sep 9, 2020

除了这个问题，又发现了个问题：目前报的有些链接有些是 false alarms，比如 http://127.0.0.1:2379/dashboard/#/cluster_info/instance、https://github.com/$user/docs-cn 之类的链接，这些都是已知的、特意用 <> 扩起来的链接。liche 这个工具支持 exclude 掉包裹在 <> 的链接吗？还是只能用 regex 挨个过滤掉这些特定的链接呢？ @csuzhangxc

@csuzhangxc
Copy link
Member

除了这个问题，又发现了个问题：目前报的有些链接有些是 false alarms，比如 http://127.0.0.1:2379/dashboard/#/cluster_info/instance、https://github.com/$user/docs-cn 之类的链接，这些都是已知的、特意用 <> 扩起来的链接。liche 这个工具支持 exclude 掉包裹在 <> 的链接吗？还是只能用 regex 挨个过滤掉这些特定的链接呢？ @csuzhangxc

只能用 regex

@yikeke
Copy link
Contributor Author

yikeke commented Nov 2, 2020

The external-link-check found two 404s. Could you help replace the two figma links? @CaitinChen
image

@yikeke yikeke requested a review from CaitinChen November 2, 2020 07:42
@yikeke yikeke changed the title [WIP] .github: check connectivity of external links via GitHub action .github: check connectivity of external links via GitHub action Nov 2, 2020
@yikeke yikeke removed the request for review from csuzhangxc November 2, 2020 07:44
@yikeke yikeke added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR’s assignee is translating this PR. labels Nov 2, 2020
@yikeke yikeke mentioned this pull request Nov 2, 2020
Merged
9 tasks
@ti-srebot ti-srebot added the status/LGT1 Indicates that a PR has LGTM 1. label Nov 2, 2020
@yikeke yikeke merged commit 17b0422 into pingcap:master Nov 2, 2020
ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Nov 2, 2020
@yikeke @ti-srebot
cherry pick pingcap#4464 to release-2.1
7630806 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot mentioned this pull request Nov 2, 2020
Merged
9 tasks
@ti-srebot
Copy link
Contributor

cherry pick to release-2.1 in PR #4783

@yikeke
Copy link
Contributor Author

yikeke commented Nov 2, 2020

/run-cherry-picker

ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Nov 2, 2020
@yikeke @ti-srebot
cherry pick pingcap#4464 to release-3.0
13ad39b 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot mentioned this pull request Nov 2, 2020
Merged
9 tasks
@ti-srebot
Copy link
Contributor

cherry pick to release-3.0 in PR #4784

ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Nov 2, 2020
@yikeke @ti-srebot
cherry pick pingcap#4464 to release-3.1
324566e 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot mentioned this pull request Nov 2, 2020
Merged
9 tasks
@ti-srebot
Copy link
Contributor

cherry pick to release-3.1 in PR #4785

ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Nov 2, 2020
@yikeke @ti-srebot
cherry pick pingcap#4464 to release-4.0
e834344 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot mentioned this pull request Nov 2, 2020
Merged
9 tasks
@ti-srebot
Copy link
Contributor

cherry pick to release-4.0 in PR #4786

yikeke added a commit that referenced this pull request Nov 2, 2020
@ti-srebot @yikeke
cherry pick #4464 to release-4.0 (#4786)
3150e41 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
yikeke added a commit that referenced this pull request Nov 3, 2020
@ti-srebot @yikeke
.github: check connectivity of external links via GitHub action (#4464)…
c0e4c5f 
… (#4784)

* cherry pick #4464 to release-3.0

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

* Update sql-statement-admin.md

* set timeout to 10s

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-authored-by: yikeke <yikeke@pingcap.com>
yikeke added a commit that referenced this pull request Nov 3, 2020
@ti-srebot @yikeke
.github: check connectivity of external links via GitHub action (#4464)…
b101d88 
… (#4785)

* cherry pick #4464 to release-3.1

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

* Update sql-statement-admin.md

* set timeout to 10s

* Update link-check.yaml

* timeout 10s

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-authored-by: yikeke <yikeke@pingcap.com>
This was referenced Nov 3, 2020
Merged
Merged
Merged
Merged
yikeke added a commit that referenced this pull request Nov 3, 2020
@ti-srebot @yikeke
.github: check connectivity of external links via GitHub action (#4464)…
f14f9de 
… (#4783)

* cherry pick #4464 to release-2.1

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

* Update sql-statement-admin.md

* Update tune-operating-system.md

* test

* timeout 10s

* Update tune-operating-system.md

* Update tidb-faq.md

* timeout 60s

* timout 20s

* Update tidb-faq.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-authored-by: yikeke <yikeke@pingcap.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lilin90 lilin90 Awaiting requested review from lilin90

@TomShawn TomShawn Awaiting requested review from TomShawn

1 more reviewer

@CaitinChen CaitinChen CaitinChen approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@yikeke yikeke

Labels

status/LGT1 Indicates that a PR has LGTM 1. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@yikeke @csuzhangxc @ti-srebot @CaitinChen