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

Improve link checker reporting #937

Open
andrewmarx opened this issue Jan 31, 2022 · 1 comment
Open

Improve link checker reporting #937

andrewmarx opened this issue Jan 31, 2022 · 1 comment

Comments

@andrewmarx
Copy link
Collaborator

Currently, when the link checker is run, it ignores any errors produced by missing links and returns success. I set this behavior because failing pull requests due to unrelated external links breaking seemed like a bad idea. However, as a result, finding out if there are any missing links requires manually going into the Actions tab and checking the output there.

Is there a way to improve the reporting process from the link checker so that the results are more visible? I'm pretty sure there is, but I'm not familiar enough with Github Actions yet to actually implement it.

@ethanwhite
Copy link
Member

I set this behavior because failing pull requests due to unrelated external links breaking seemed like a bad idea.

I'm not overly worried about this since we can always go link in the event that the build fails, so I'd be OK with failing here but understand the desire not to.

Is there a way to improve the reporting process from the link checker so that the results are more visible?

You can use peter-evans/create-issue-from-file to have the checker comment on the PR. I had a version of this working in my link checking attempt. See the bottom of https://github.com/datacarpentry/semester-biology/pull/920/files#. You'll need the output from the link checker in a markdown file.

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

No branches or pull requests

2 participants