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

More verbose check-links to find broken links more easily #160

Closed
jtpio opened this issue Nov 29, 2022 · 1 comment · Fixed by #161
Closed

More verbose check-links to find broken links more easily #160

jtpio opened this issue Nov 29, 2022 · 1 comment · Fixed by #161
Labels
enhancement New feature or request

Comments

@jtpio
Copy link
Member

jtpio commented Nov 29, 2022

Problem

By default the check-links action fails without too much information when there is a broken link.

Example run: https://github.com/jupyter/notebook/actions/runs/3570433572/jobs/6001397371

image

Proposed Solution

Ideally the broken link(s) should be printed in the logs so it's easier to find and fix them.

Additional context

Noticed in https://github.com/jupyter/notebook/actions/runs/3570433572/jobs/6001397371 on https://github.com/jupyter/notebook

@jtpio jtpio added the enhancement New feature or request label Nov 29, 2022
@jtpio jtpio changed the title More verbose check_links to find broken links more easily More verbose check-links to find broken links more easily Nov 29, 2022
@jtpio
Copy link
Member Author

jtpio commented Nov 29, 2022

Example run: https://github.com/jupyter/notebook/actions/runs/3570433572/jobs/6001397371

Actually for that particular run the relevant lines are where we see a second attempt made for README.md:

--------------------------------------------------------------------------------
README.md...

README.md (second attempt)...

Command '['/opt/hostedtoolcache/Python/3.10.8/x64/bin/python', '-m', 'pytest', '--noconftest', '--check-links', '--check-links-cache', '--check-links-cache-expire-after', '604800', '-raXs', '--color', 'yes', '--quiet', '-p', 'no:doctest', '-c', '_IGNORE_CONFIG', '--check-links-ignore', 'https://playwright.dev/docs/test-cli/', '--check-links-ignore', 'https://blog.jupyter.org/the-big-split-9d7b88a031a7', '--check-links-ignore', 'https://blog.jupyter.org/jupyter-ascending-1bf5b362d97e', '--check-links-ignore', 'https://github.com/.*/(pull|issues)/.*', '--check-links-ignore', 'https://github.com/search?', '--check-links-ignore', 'http://localhost.*', '--check-links-ignore', 'https://docs.github.com/.*', '--ignore-glob', 'node_modules', 'README.md', '--lf']' returned non-zero exit status 1.

However it's not clear which link in README.md causes the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant