TechWiz-3 / linksafe

🔗 Scan links in your repo to ensure they are valid. Works in private repos!
GNU General Public License v3.0
7 stars 2 forks source link

linksafe should add the column to the output #11

Open koppor opened 2 years ago

koppor commented 2 years ago

Limit to 10 failed links

Similar to reviewdog action or https://github.com/errata-ai/vale-action

grafik

TechWiz-3 commented 2 years ago

So the workflow will make a PR removing broken links?

koppor commented 2 years ago

The use-case is that there might be external. They do not have write-request to the repository. They use the feature of GitHub's pull request to contribute. For GitHub pull requests, some "fancy" interaction possibilities exist. I like the one for commenting on the concrete lines.

koppor commented 2 years ago

Maintainers of a repository still can decide whether they want to use the PR method or just commit to the main branch. I think, it really depends on the repository. For instance, at JabRef, we have >400 external contributors, whereas in my own "toy projects", I am the single one contributor and work differently.

koppor commented 1 month ago

TL;DR: linksafe should add the column to the output


I think, what would help there is to use errorformat for output. ({file}:{line number}:{column number}: {message})

Current output is:

==== Failed links ====
In ./README.md on line 113, link: https://github.com/search?utf8=%E2%9C%93&q=label%3Ahacktoberfest+state%3Aopen+type%3Aissue+language%3ADart&type=Issues&ref=advsearch&l=React&l=
In ./README.md on line 125, link: https://github.com/search?utf8=%E2%9C%93&q=label%3Ahacktoberfest+state%3Aopen+type%3Aissue+language%3ATypescript&type=Issues&ref=advsearch&l=Typescript

Having errorformat in place, one could use other tools for commenting on PRs (such as reviewdog).


One could also configure reviewdog to follow the format of linksave

reviewdog -efm="In %f on line %l, %m" -diff="git diff FETCH_HEAD"

I need to test whether the column is a required input.

Independent of that, linksafe should add the column to the output


For direct posting: Google results: