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

[ci] move link checking to a cron job #3890

Merged
merged 12 commits into from
Feb 2, 2021
Merged

[ci] move link checking to a cron job #3890

merged 12 commits into from
Feb 2, 2021

Conversation

jameslamb
Copy link
Collaborator

@jameslamb jameslamb commented Feb 2, 2021

Based on the conversation in #3785, this PR proposes moving linkchecker checks to a cron job.

The link checking part of check-docs is one of the most common sources of instability in LightGBM. In my experience, failures in this job are almost always temporary disruptions like a server complaining about rate limits, and those failures are almost always solved by just re-running it.

Moving this task to a cron job, instead of running it on every commit to master or a PR, lessens the burden on maintainers of manually re-running this task and improves the contributor experience by removing a check that might fail in ways unrelated to their contributions. It also reduces the load that LightGBM puts on those servers that serve the things we link to.

Testing

Ok after a few small changes, this appears to have worked.

Notes for Reviewers

This new workflow can be triggered on the "Actions" tab in the GitHub UI, but only after this PR has been merged to master: https://github.community/t/workflow-dispatch-event-not-working/128856/2.

@jameslamb jameslamb marked this pull request as ready for review February 2, 2021 02:59
.ci/test.sh Show resolved Hide resolved
docs/.linkcheckerrc Outdated Show resolved Hide resolved
Copy link
Collaborator

@StrikerRUS StrikerRUS left a comment

Choose a reason for hiding this comment

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

Thanks for doing this!
Just two minor comments.

.github/workflows/linkchecker.yml Outdated Show resolved Hide resolved
.github/workflows/linkchecker.yml Outdated Show resolved Hide resolved
@StrikerRUS StrikerRUS merged commit 1c18ad3 into master Feb 2, 2021
@StrikerRUS StrikerRUS deleted the ci/linkchecker branch February 2, 2021 20:31
@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity since it was closed. To start a new related discussion, open a new issue at https://github.com/microsoft/LightGBM/issues including a reference to this.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 24, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants