add markdown link checker #672
Conversation
Signed-off-by: liyuan <[email protected]>
Signed-off-by: liyuan <[email protected]>
|
verified it works well and revert the test commit |
Signed-off-by: liyuan <[email protected]>
|
We do development on the dev branch and then only update main branch after we do a release. What is the benefit of using the main branch instead of the dev branch as the base for the markdown check? |
| with: | ||
| max-depth: -1 | ||
| use-verbose-mode: 'yes' | ||
| check-modified-files-only: 'yes' |
There was a problem hiding this comment.
Should it be modified files only or all links? This could potentially not detect dead links in files that are never modified.
Signed-off-by: liyuan <[email protected]>
Signed-off-by: liyuan <[email protected]>
it is also ok to set the base branch to dev.
It is a good idea to check all files at the first time, since there is not much files in this repo and it will only take 26s to scan all files. fix all dead links. |
|
@parthosa could you help merge the pr? I cannot merge it due to the permission. |
|
Thanks @nvliyuan |
This PR is to add a markdown link checker to the repo.
We set check-modified-files-only=yes, and we set main as base-branch to specify when finding modified markdown files.
More details please find doc
Signed-off-by: liyuan [email protected]