link-checker: exclude private URLs like localhost

[egpbos]

• I followed the CONTRIBUTING guidelines.

Below, describe what this Pull Request adds:

One of the links that failed the link-checker are a localhost reference. Links like that should never be checked and lychee has an option for that. This PR adds that option.

[egpbos]

Oh weird, lychee.toml also includes this option already. Is lychee.toml actually used by the GH Action?

[bouweandela]

I had a look at the github action code and I think it should do that.

[egpbos]

Perhaps it doesn't recognize localhost:4000 as a private address then? That's the one that's tripping the link checker currently.

[bouweandela]

Would it make sense to enable the link-checker.yml action on the branch of this pull request to see if it actually solves the issue?

[egpbos]

Can't seem to get it to work on CI...

I've also tried some localhost things on my laptop, with different ports, https/http, etc., but lychee always seems to fail on localhost, even if the Guide is hosted on localhost, kinda weird. However, --exclude-all-private does work, also with the localhost:4000 address, so it should work on CI too.

[egpbos]

Oh, I think the issue is that the lychee action has a default value for the args parameter: --verbose --no-progress './**/*.md' './**/*.html'. If you don't add that stuff, especially the latter two patterns or something similar, the whole action doesn't run.

[egpbos]

Force push with another fix to the check...

[egpbos]

Ok, so apparently the config file is not read, because adding --exclude-all-private does work. I'll now try with an explicit -c lychee.toml...

[egpbos]

Aha, Error: Error while loading config file "lychee.toml": Failed to parse configuration file...

[egpbos]

Fixed! The problem was that the lychee.toml syntax was changed, I think, since we added the file. Anyway, it works now, I will make a new commit...

[egpbos]

Removed the unnecessary commits, now only the lychee.toml fix remains (which was effectively already the case after the 4051326 commit, which undid all the others).

[egpbos]

Please review @bouweandela

[bouweandela]

Thanks!