-
Notifications
You must be signed in to change notification settings - Fork 224
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 a workflow checking links in plaintext and HTML files #634
Conversation
6078a31
to
b906cee
Compare
0b42baa
to
b268e7e
Compare
a9384e1
to
b344db5
Compare
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.
Haven't checked too closely but I trust your Github Actions skills 😄 Only one minor comment but you can ignore it if it's too much work to do.
- name: Create Issue From File | ||
uses: peter-evans/create-issue-from-file@v2.3.2 | ||
with: | ||
title: Link Checker Report |
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.
Would be nice to have a unique Issue title (e.g. "Link Checker Report on 28 Feb 2021"), but not essential.
…pingTools#634) This PR adds a workflow to check external links in plaintext and HTML files, using action lycheeverse/lychee-action. - External links in the ReST, Markdown and Python files in the master branch are checked - External links in the dev documentation (pygmt.org/dev) are checked - Internal links are NOT checked, but when we build the documentation, we should see the warnings if internal links are broken. - Links to PRs and issues are excluded, because they are unlikely to be broken The workflow runs weekly. If broken links (404) are detected, it will report an issue (see GenericMappingTools#927 for an example, in which I added a broken link pygmt.org/abc/def for testing).
Description of proposed changes
This PR adds a workflow to check external links in plaintext and HTML files, using action https://github.com/lycheeverse/lychee-action.
FYI, the workflow takes 50 seconds to check >1000 links. See the workflow runs in https://github.com/GenericMappingTools/pygmt/runs/1931775335?check_suite_focus=true.
Fixes #535
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.