Failed to read file

[Sh3Rm4n]

Hey first of, thank you for this awesome tool. It is definitely quicker than the alternatives with comparable feature sets.

I'm really not sure, if the bug / issue I'm describing is part of lychee-action or the lychee repo, so feel free to move the issue, if this is not the right place.

I'm currently trying to get lychee-actions working here: stm32-rs/stm32f3xx-hal#188

Now I've tried a bit and stumbled upon #10

You can see my attempts here:

• stm32-rs/stm32f3xx-hal@9accce3
• stm32-rs/stm32f3xx-hal@6821cea
• stm32-rs/stm32f3xx-hal@36936e7

I've tried around, because I wasn't sure, if lychee is getting the arguments right. I've run these commands locally with the newest lychee version from master, and they work as expected.
Now stm32-rs/stm32f3xx-hal@36936e7 is particularly interesting, because it fails like that:

+ lychee --verbose --output /tmp/lychee/out.md
Error: Failed to read file: `README.md`

Caused by:
    No such file or directory (os error 2)

(https://github.com/stm32-rs/stm32f3xx-hal/runs/2010954174)

which does hint towards a right direction: This invocation and the ones before do nothing, because no matching file was found in the repo. In this case an explicit error is return, because lychee defaults to README.md if no file-name is given.

I've no clue, why github-action does not find any valid files, so I assume this is a github-actions issue and more so a configuration issue of lychee-action?

Maybe I'm wrong though, and it is an issue on my side, but I can't see it.

Also, even though the exit code is 1 the check is marked as successfully passed.

[pawroman]

Hi,

I think you're missing the checkout step. GitHub Actions requires an explicit checkout to have the code available in further CI steps.

Please see an example of a working setup in my repo here: https://github.com/pawroman/links/blob/master/.github/workflows/main.yml#L14-L27

[Sh3Rm4n]

Thank you very much @pawroman, your suggestion did the trick.
In hindsight, it's obvious that the checkout step was missing.

Have I fully read the README, the solution is right there: https://github.com/lycheeverse/lychee-action/blob/master/README.md#receiving-issues-containing-the-error-report

But to be honest, I've only read until this header: https://github.com/lycheeverse/lychee-action/blob/master/README.md#detailed-arguments-args-information

Maybe adding

    steps:
      - uses: actions/checkout@v2

to the first example in the README could help, so others do not make the same mistake as myself? 🙈

[mre]

Fair point. Then again people can have an arbitrarily complex pipeline and lychee might only come up somewhere down the pipe. The first two snippets in the README.md wouldn't be complete with the checkout step either. The other two examples in the README.md are complete, but would probably have to be adapted for each project anyway.

The action is based on https://github.com/peter-evans/link-checker, which has the same layout. (Doesn't mean that it's great, but I liked that it was quite straightforward when I read it for the first time. Might be biased, though. 😆)

For the sake of simplicity, I'd opt for keeping the initial examples short to highlight the single additional step required to run lychee in any pipeline.
Thanks for using lychee, though. 👍

[Sh3Rm4n]

For the sake of simplicity, I'd opt for keeping the initial examples short to highlight the single additional step required to run lychee in any pipeline.

I'm fine with this decision. My suggestion was mostly to cover up my mistake 😆

[mre]

I like your sense of humor. 😄