-
Notifications
You must be signed in to change notification settings - Fork 240
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.
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
Add markdown check action #4907
Add markdown check action #4907
Conversation
Signed-off-by: liyuan <yuali@nvidia.com>
Signed-off-by: liyuan <yuali@nvidia.com>
Signed-off-by: liyuan <yuali@nvidia.com>
Signed-off-by: liyuan <yuali@nvidia.com>
Signed-off-by: liyuan <yuali@nvidia.com>
please found the detail information about this pr in #4906 |
.github/workflows/markdown-links-check/markdown-links-check-config.json
Outdated
Show resolved
Hide resolved
Signed-off-by: liyuan <yuali@nvidia.com>
Signed-off-by: liyuan <yuali@nvidia.com>
Signed-off-by: liyuan <yuali@nvidia.com>
Signed-off-by: liyuan <yuali@nvidia.com>
Signed-off-by: liyuan <yuali@nvidia.com>
Signed-off-by: liyuan <yuali@nvidia.com>
Signed-off-by: liyuan <yuali@nvidia.com>
Signed-off-by: liyuan <yuali@nvidia.com>
.github/workflows/markdown-links-check/markdown-links-check-config.json
Outdated
Show resolved
Hide resolved
Signed-off-by: liyuan <yuali@nvidia.com>
Signed-off-by: liyuan <yuali@nvidia.com>
Signed-off-by: liyuan <yuali@nvidia.com>
@@ -0,0 +1,35 @@ | |||
# Copyright (c) 2020-2022, NVIDIA CORPORATION. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# Copyright (c) 2022, NVIDIA CORPORATION.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks, updated
name: Check Markdown links | ||
|
||
on: | ||
pull_request_target: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pull_request_target
-> pull_request
to checkout the "refs/pull/:prNumber/merge"
otherwise the
- uses: actions/checkout@master
will check out the BASE ref here (branch-22.04)
FYI we use pull_request_target in signoff-check is only because that the check is based on BASE branch instead of relying on developer's feature branch
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks and good to know that, one question is that do we need a GITHUB_TOKEN when we use pull_request
?
If we don't add a GITHUB_TOKEN, will we hit Error: Parameter token or opts.auth is required
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GITHUB_TOKEN is the default token of repo and is maintained by github action itself as ENV.
If we don't add a GITHUB_TOKEN, will we hit Error: Parameter token or opts.auth is required?
For actions/checkout, no.
I am not sure where you did get this error, if the some specific action require adding specific arg, then you can try add
with:
token: ${{ secrets.GITHUB_TOKEN }}
above was just an example, this really arg naming depends on the action provider, if they require extra tokens (or access), they should have documented somewhere in their repo
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Signed-off-by: liyuan <yuali@nvidia.com>
Signed-off-by: liyuan <yuali@nvidia.com>
Signed-off-by: liyuan <yuali@nvidia.com>
Signed-off-by: liyuan <yuali@nvidia.com>
Signed-off-by: liyuan <yuali@nvidia.com>
Signed-off-by: liyuan <yuali@nvidia.com>
Signed-off-by: liyuan <yuali@nvidia.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Let's merge this first and let it run for several days before marking it as a required check
build |
add github action to check broken markdown links on dev-branch 22.04
related to #4906