-
Notifications
You must be signed in to change notification settings - Fork 19
Add lychee link checker #135
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
base: master
Are you sure you want to change the base?
Conversation
dlebauer
left a comment
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.
@cnaples79 thanks for this contribution! I added a few components from the version in the SIPNET repository. Need to confirm that this works before merging; feel free to remove problematic args that I suggested.
| - name: Run lychee | ||
| uses: lycheeverse/lychee-action@v1.10.0 | ||
| with: | ||
| args: "--verbose --no-progress --exclude-mail" |
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.
These settings were helpful in the SIPNET link checker
| args: "--verbose --no-progress --exclude-mail" | |
| args: >- | |
| --verbose --no-progress --exclude-mail | |
| --include-fragments | |
| --no-progress | |
| --verbose | |
| --timeout 20 | |
| --max-redirects 10 | |
| --max-retries 3 | |
| --retry-wait-time 2 | |
| --format markdown | |
| --exclude '^https://doi\.org/' | |
| . | |
| fail: true |
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.
remove --include-fragments initially (or add exclusions). if problematic.
| with: | ||
| args: "--verbose --no-progress --exclude-mail" | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
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.
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Upload lychee report | |
| if: ${{ always() }} | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: lychee-report | |
| path: lychee |
remove extra blank line
dlebauer
left a comment
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.
@cnaples79 I ran the workflow (without my suggestions) and it passed. But we have three current issues open that reported broken links: #60, #136, and #137.
Do you know why this would be or what the fix would be?
This PR should fix those broken link issues and close #135
Thanks again for your help with this!
Summary
Rationale
Automated link checking helps catch broken links early without relying on manual checks.
Changes
Test Plan
Fixes #134