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

Add github workflow to check links and open issues reporting them #1028

Merged
merged 1 commit into from
Dec 11, 2021
Merged

Add github workflow to check links and open issues reporting them #1028

merged 1 commit into from
Dec 11, 2021

Conversation

micalevisk
Copy link
Contributor

@micalevisk micalevisk commented Dec 5, 2021

My first attempt on use https://github.com/lycheeverse/lychee-action to automatically create an issue reporting all bad links. Here's an example of that issue: https://github.com/micalevisk/coding-interview-university/issues/1 This issue will be created only if there's some bad link on README.md file or in any .md on translations dir

Besides that, this workflow will find the last open issue with the label 'report' and update it instead of creating a new one. Or will close it if there's no bad link found.

Not sure if you guys are looking for something like this, tho.

@jwasham
Copy link
Owner

jwasham commented Dec 6, 2021

Pretty cool. It looks like it needs to be slowed down a bit, it's getting throttled and causing 429s.

@jwasham
Copy link
Owner

jwasham commented Dec 9, 2021

Thanks Micael. Has the throttling issue been fixed?

@micalevisk
Copy link
Contributor Author

I didn't face this issue in my tests with GH Actions, tbh. Also, I don't believe we can do something as a users of lychee tool :/

Looks like they didn't fixed it yet: lycheeverse/lychee#367

@micalevisk
Copy link
Contributor Author

actually, I think we could use --max-concurrency (maximum number of concurrent network requests) option to circunvemt this, but I don't know which value will be good. The default is 128

@jwasham
Copy link
Owner

jwasham commented Dec 10, 2021

Because this is hitting a lot of the same domains, try setting it to 5. It doesn't need to be fast, so if there's a delay of a minute or so before a PR comes in, that's ok.

@micalevisk
Copy link
Contributor Author

micalevisk commented Dec 10, 2021

this workflow was intended to run on a scheduled basis (once in a month) or manually. Do you think another one for open PRs is worth it? I'll need to figure out how can I run the checks only in the links added in the PR then (actually I'm already look into this because I need this feat in another project)

@jwasham
Copy link
Owner

jwasham commented Dec 10, 2021

Nope, you're right. i don't know why I was thinking that. Once a month is fine.

@jwasham jwasham merged commit 99044e6 into jwasham:main Dec 11, 2021
@jwasham
Copy link
Owner

jwasham commented Dec 11, 2021

Thank you! Looking forward to the results!

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

Successfully merging this pull request may close these issues.

2 participants