Skip to content
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

Merged
merged 23 commits into from
Mar 18, 2022

Conversation

nvliyuan
Copy link
Collaborator

@nvliyuan nvliyuan commented Mar 7, 2022

add github action to check broken markdown links on dev-branch 22.04
related to #4906

nvliyuan added 5 commits March 7, 2022 17:49
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>
@nvliyuan
Copy link
Collaborator Author

nvliyuan commented Mar 7, 2022

please found the detail information about this pr in #4906

@nvliyuan nvliyuan changed the title Branch 22.04 add markdown action Branch 22.04 add markdown action[skip ci] Mar 7, 2022
@nvliyuan nvliyuan marked this pull request as draft March 7, 2022 10:46
@sameerz sameerz added documentation Improvements or additions to documentation build Related to CI / CD or cleanly building labels Mar 8, 2022
@nvliyuan nvliyuan marked this pull request as ready for review March 10, 2022 02:42
@nvliyuan nvliyuan self-assigned this Mar 10, 2022
@jlowe jlowe added this to the Feb 28 - Mar 18 milestone Mar 10, 2022
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>
Signed-off-by: liyuan <yuali@nvidia.com>
Signed-off-by: liyuan <yuali@nvidia.com>
@@ -0,0 +1,35 @@
# Copyright (c) 2020-2022, NVIDIA CORPORATION.
Copy link
Collaborator

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.

Copy link
Collaborator Author

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:
Copy link
Collaborator

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

Copy link
Collaborator Author

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?

Copy link
Collaborator

@pxLi pxLi Mar 16, 2022

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

Copy link
Collaborator

Choose a reason for hiding this comment

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

image
after changing to pull_request, you can see result in this PR's check status

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>
Copy link
Collaborator

@pxLi pxLi left a 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

@pxLi pxLi changed the title Branch 22.04 add markdown action[skip ci] Branch 22.04 add markdown action [skip ci] Mar 18, 2022
@pxLi pxLi changed the title Branch 22.04 add markdown action [skip ci] Add markdown check action [skip ci] Mar 18, 2022
@pxLi pxLi changed the title Add markdown check action [skip ci] Add markdown check action Mar 18, 2022
@pxLi
Copy link
Collaborator

pxLi commented Mar 18, 2022

build

@pxLi pxLi merged commit d50e120 into NVIDIA:branch-22.04 Mar 18, 2022
@nvliyuan nvliyuan deleted the branch-22.04-add-markdown-action branch March 22, 2023 05:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Related to CI / CD or cleanly building documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants