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

🌱 Split MD link checker into periodic and PR focused #6853

Conversation

killianmuldoon
Copy link
Contributor

Signed-off-by: killianmuldoon [email protected]

This PR changes the MD link checker action to only work on files modified by the PR. This will hopefully reduce disruption from MD link checker flakes on PRs. This commit also adds a periodic link-checker action that should scan all MDs on a weekly schedule and identify broken links across the repo more widely.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 7, 2022
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jul 7, 2022
on:
schedule:
- cron: "0 9 * * 1"
paths:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think we need branches here, but I'm not sure if this will actually scan every branch on the repo (that could be a good thing to pick up broken links in older versions of the book)

@killianmuldoon killianmuldoon force-pushed the actions/split-md-link-checker branch from 09791bf to c9bfb40 Compare July 7, 2022 10:10
@killianmuldoon killianmuldoon changed the title 🌱 Split MD link checker into periodic and PR focused {WIP] 🌱 Split MD link checker into periodic and PR focused Jul 7, 2022
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 7, 2022
@killianmuldoon
Copy link
Contributor Author

/hold

Still figuring out the right syntax for the cronjob.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 7, 2022
@killianmuldoon killianmuldoon force-pushed the actions/split-md-link-checker branch 2 times, most recently from e75fdeb to ffd080d Compare July 7, 2022 10:23
@killianmuldoon killianmuldoon changed the title {WIP] 🌱 Split MD link checker into periodic and PR focused 🌱 Split MD link checker into periodic and PR focused Jul 7, 2022
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 7, 2022
@killianmuldoon
Copy link
Contributor Author

/remove-hold

This should run weekly on a Thursday once merged.

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 7, 2022
Copy link
Member

@chrischdi chrischdi left a comment

Choose a reason for hiding this comment

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

/lgtm

Great idea 👍

How do we get notified for a failing weekly gh action? Normally we track this via testgrid which is obviously not possible using gh actions I think?!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 7, 2022
@killianmuldoon
Copy link
Contributor Author

How do we get notified for a failing weekly gh action? Normally we track this via testgrid which is obviously not possible using gh actions I think?!

I think we'll get a notification (if you have failing actions turned on in github notifications)

@sbueringer
Copy link
Member

How do we get notified for a failing weekly gh action? Normally we track this via testgrid which is obviously not possible using gh actions I think?!

I think we'll get a notification (if you have failing actions turned on in github notifications)

Yup we should.

@killianmuldoon killianmuldoon force-pushed the actions/split-md-link-checker branch from ffd080d to 9ef2afd Compare July 7, 2022 11:11
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 7, 2022
@sbueringer
Copy link
Member

sbueringer commented Jul 7, 2022

/lgtm

/cherry-pick release-1.2

(the link to microsoft.com is just too flaky to not cherry-pick into all supported releases)

Thx @killianmuldoon !

@k8s-infra-cherrypick-robot

@sbueringer: once the present PR merges, I will cherry-pick it on top of release-1.2 in a new PR and assign it to you.

In response to this:

/lgtm

/cherry-pick release-1.2
/cherry-pick release-1.1

(the link to microsoft.com is just too flaky to not cherry-pick into all supported releases)

Thx @killianmuldoon !

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@sbueringer
Copy link
Member

/cherry-pick release-1.1

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 7, 2022
@k8s-infra-cherrypick-robot

@sbueringer: once the present PR merges, I will cherry-pick it on top of release-1.1 in a new PR and assign it to you.

In response to this:

/cherry-pick release-1.1

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Copy link
Member

@vincepri vincepri left a comment

Choose a reason for hiding this comment

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

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vincepri

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 7, 2022
@k8s-ci-robot k8s-ci-robot merged commit 03f62b1 into kubernetes-sigs:main Jul 7, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.3 milestone Jul 7, 2022
@k8s-infra-cherrypick-robot

@sbueringer: new pull request created: #6869

In response to this:

/cherry-pick release-1.1

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-infra-cherrypick-robot

@sbueringer: new pull request created: #6870

In response to this:

/lgtm

/cherry-pick release-1.2

(the link to microsoft.com is just too flaky to not cherry-pick into all supported releases)

Thx @killianmuldoon !

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants