*: check connectivity of external links via GitHub action #353
Conversation
csuzhangxc
changed the title
.github/workflows/link-check.yaml
Outdated
| - name: Link check for zh | ||
| uses: peter-evans/link-checker@v1 | ||
| with: | ||
| args: -c 4 -d /github/workspace -r -v -x http://172.* zh* |
There was a problem hiding this comment.
github 太容易被触发 Too Many Requests (HTTP error 429) 了。但这里并发已经调整到 4 了，再降低怕影响速度
There was a problem hiding this comment.
是因为查了很多 https://github.com/pingcap/dm/pull/xxx 导致 429 的吗？这类链接 404 的概率应该很小，可以考虑不查这种链接
|
@lance6716 @yikeke PTAL |
csuzhangxc
changed the title
.github/workflows/link-check.yaml
Outdated
| # but if `-c` is too large then `Too Many Requests (HTTP error 429)` may be reported from `https://github.com/*`. | ||
| # - we hardcode `--document-root` to `/github/workspace` in the container now. | ||
| # - we use `http://172.*` as sample addresses in some docs, so we need to exclude them. | ||
| - name: Link check for zh |
There was a problem hiding this comment.
新 workflow 的功能是内链（相对链接）和外链（绝对链接）都会查吗 @csuzhangxc
There was a problem hiding this comment.
内链 和 内链锚文本 的检查都已经有了，在 ci.yaml 的 Verify links 和 Verify link anchors 两个 step 中实现了。学程哥新加的这个可以配置成只检查 外链 吗
There was a problem hiding this comment.
如果方便的话，最好把检查外链的这个 action 也写到 ci.yaml 那个文件里，写成和 Verify links、Verify link anchors 并列的一个新的 step，就不要另起一个 workflow 了，怎么样？ @csuzhangxc
There was a problem hiding this comment.
想的是单开一个 workflow，不是 Required。这样检查异常时，也还是能 merge？
There was a problem hiding this comment.
嗯，这样的话也可以，就不必因为 pr 未涉及的 404 外链而 block merge 了
|
报错的信息可以过滤下不？现在成功的也会报出来，把 error 的给淹没了 |
yikeke
added
needs-cherry-pick-release-1.0
This reverts commit 81661a9.
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
|
cherry pick to release-1.0 in PR #356 |
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
|
cherry pick to release-2.0 in PR #357 |
* cherry pick #353 to release-1.0 Signed-off-by: ti-srebot <ti-srebot@pingcap.com> * Update ci.yaml * Delete maintain-dm-using-tiup.md Co-authored-by: Xuecheng Zhang <csuzhangxc@gmail.com> Co-authored-by: yikeke <yikeke@pingcap.com> Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
yikeke
changed the title
| args: -c 32 -d /github/workspace -r -x "http://172.*|https://github.com/pingcap/dm/pull/.*|.*.md" zh* | ||
|
|
||
| - name: Check external links in en files | ||
| id: lc |
There was a problem hiding this comment.
请教下，上面的「Check external links in zh files」那一步没有 id，如果只有 zh 有 error、en 没有 error，下面的 ${{ steps.lc.outputs.exit_code }} 会是 1 吗？ @csuzhangxc
What is changed, added or deleted? (Required)
use https://github.com/marketplace/actions/link-checker to check links in
zhanden.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/pingcap/dm/pull/.*|.*.mdMeaning the check will skip checking the URLs matching the above patterns.
Which DM version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?