peter-evans / link-checker

A GitHub action for link checking repository Markdown and HTML files
MIT License
49 stars 11 forks source link

Issue description is empty #8

Closed ch264 closed 4 years ago

ch264 commented 4 years ago

I have implemented the link checker and it runs and also creates an issue, but the description in the issue is empty.

Expected would be to see the error link in the description.

peter-evans commented 4 years ago

Hi @ch264

I'm looking at your workflow here: https://github.com/ch264/Gatsby_site/blob/linkchecker/.github/workflows/brokenlink.yml

The problem is that the following line is not correct. By default, link-checker outputs its results to a file at the path ./link-checker/out.md.

ISSUE_CONTENT_FILEPATH: ./example-content/output.md

Change the above line to this:

ISSUE_CONTENT_FILEPATH: ./link-checker/out.md

Note that you don't need to create an empty file at that path. The file is just created and used during the actions run.

ch264 commented 4 years ago

Hi @peter-evans,

Thanks for your fast reply. I changed the code and the issues are still empty https://github.com/ch264/Gatsby_site/issues/52

I saw that an out.md file has now been created and it is also empty. I assume that is why the description is empty?

peter-evans commented 4 years ago

Now the problem is that an empty out.md file was committed to the repository. https://github.com/ch264/Gatsby_site/blob/master/link-checker/out.md

You need to delete that file. It's existence means that the create-issue-from-file action always finds it and creates a blank issue.

peter-evans commented 4 years ago

By the way, I'm not sure if this is what you expect, but the current test link you have won't be detected as "broken." You can see the output here. The link is marked "OK."

image

The reason for this is that the site is redirecting to a 404 page and actually seems to be returning a 403 Forbidden. Liche, the tool this action uses, doesn't count this as broken.

ch264 commented 4 years ago

Oh ok I understand. I though there was complete log of all scanned links being output into the description instead of only broken link. Thank you very much for clarifying 😄

peter-evans commented 4 years ago

No problem. Closing this issue for now.