search

lycheeverse / lychee-action

Github action to check for broken links in Markdown, HTML, and text files using lychee, a fast link checker written in Rust.
https://lychee.cli.rs
Apache License 2.0
292 stars 39 forks source link

add documentation on using the param when testing local files (as in… #211

Closed tgaff closed 7 months ago

tgaff commented 8 months ago

Per Issue 1265 in Lychee): Add documentation about needing to apply the --base . parameter when testing on the file-system vs. a hosted site.

I actually think this should apply to both suggested action definitions in this repo since they both test without a domain and are therefore testing on the filesystem. Neither one specifies a domain or even a localhost address.

Should I also add one that demonstrates testing against a hosted site? I imagine that was the original intent of the cron job variant.

@mre I think there's a reasonable chance I've misunderstood this behavior and your comments in 1265 - please let me know.

mre commented 8 months ago

That looks correct. You understood correctly.

I agree that we should add the parameter to the other examples. Can you do that? Also, what do you think about moving the --base parameter to the beginning? This way, if a user adds more path arguments, they are grouped together at the end.

Also, the integration tests in the .github/workflows folder need to be adjusted.

tgaff commented 8 months ago

moving the --base parameter to the beginning

done

the integration tests in the .github/workflows folder need to be adjusted.

I've added a test, but it looks like a maintainer will have to approve running them.

tgaff commented 8 months ago

I agree that we should add the parameter to the other examples. Can you do that?

I've done this for every example that already included args. I could do it for all examples, but I'll have to add full (default) args for each. What do you think?

mre commented 7 months ago

Apologies for the delays. Looks good, so I finally merged it. 😊