Skip to content

add Linkcheck to doc ci #3012

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.

Sign up for GitHub

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

Jump to bottom
Merged
Bibo-Joshi merged 7 commits into from
May 9, 2022
Merged

add Linkcheck to doc ci #3012

Bibo-Joshi merged 7 commits into from
May 9, 2022

Conversation

@Bibo-Joshi
Copy link
Member

@Bibo-Joshi Bibo-Joshi commented May 8, 2022 •
edited
Loading

closes #2974

runs the job every 2nd month. Ignores a number of URLs where it makes sense IMO. Also fixes a bunch.
Doesn't run on PRs for now. If we want that, we have two options:

  • run on all files. After I ignored all the gh pr/issue links, that's actually not too bad performance wise. Would be okay with doing that.
  • if we want to run only on changed files, we'd have to somehow map changed files to the corresponding rst files. IMO not worth the trouble.

Example for a failing test at https://github.com/python-telegram-bot/python-telegram-bot/runs/6339916713?check_suite_focus=true

  • remove the on: push config from the workflow which is currently just there for demo purposes

@Bibo-Joshi Bibo-Joshi added ⚙️ documentation affected functionality: documentation ⚙️ tests affected functionality: tests labels May 8, 2022
@Bibo-Joshi Bibo-Joshi requested a review from Poolitzer May 8, 2022 08:57
github-actions[bot]
github-actions bot reviewed May 8, 2022
View reviewed changes
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hey! Looks like you edited README.rst or README_RAW.rst. I'm just a friendly reminder to apply relevant changes to both of those files :)

@Poolitzer
Copy link
Member

Poolitzer commented May 8, 2022

I don't think checking every link in every PR is going to help, potentially loads of checking at once. Just the month run would be fine. We shall see if that gets/is rate limited already anyway.

harshil21
harshil21 reviewed May 8, 2022
View reviewed changes
harshil21
harshil21 reviewed May 8, 2022
View reviewed changes
@Bibo-Joshi
Copy link
Member Author

Bibo-Joshi commented May 9, 2022

If the two of you are okay with the rest of the changes, I'll remove the on: push and merge :)

harshil21
harshil21 approved these changes May 9, 2022
View reviewed changes
Copy link
Member

@harshil21 harshil21 left a comment

Choose a reason for hiding this comment

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

looks good!

Poolitzer
Poolitzer approved these changes May 9, 2022
View reviewed changes
Copy link
Member

@Poolitzer Poolitzer left a comment

Choose a reason for hiding this comment

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

LGTM

@Bibo-Joshi Bibo-Joshi merged commit d755d0b into doc-fixes May 9, 2022
@Bibo-Joshi Bibo-Joshi deleted the linkcheck branch May 9, 2022 19:34
@Bibo-Joshi Bibo-Joshi mentioned this pull request May 9, 2022
Merged
5 tasks
@github-actions github-actions bot locked and limited conversation to collaborators May 17, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@Poolitzer Poolitzer Poolitzer approved these changes

@harshil21 harshil21 harshil21 approved these changes

Assignees

No one assigned

Labels

⚙️ documentation affected functionality: documentation ⚙️ tests affected functionality: tests

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@Bibo-Joshi @Poolitzer @harshil21