bolts icon indicating copy to clipboard operation
bolts copied to clipboard

fix broken link

Open antonilol opened this issue 3 years ago • 13 comments

again lol

antonilol avatar Jun 14 '22 13:06 antonilol

these are honestly all over the place in my experience, any way we can lint these?

instagibbs avatar Jun 14 '22 13:06 instagibbs

i had some idea to list all links in the documents and all possible destinations and compare them (or something like this)

antonilol avatar Jun 14 '22 13:06 antonilol

this is about what i imagined, it does not work yet and has bugs it prints every link that points to something not found in any markdown file (*.md)

antonilol avatar Jun 14 '22 14:06 antonilol

I agree with the automatic check, but I disagree on the custom script, we should automate this process, and check with a Github action like this https://github.com/gaurav-nelson/github-action-markdown-link-check

We should ran this action periodically, maybe 1 time each month?

vincenzopalazzo avatar Jun 14 '22 15:06 vincenzopalazzo

I agree with the automatic check, but I disagree on the custom script, we should automate this process, and check with a Github action like this https://github.com/gaurav-nelson/github-action-markdown-link-check

oh lol i did not search before making the script, but anyway it was fun to make

We should ran this action periodically, maybe 1 time each month?

i would suggest with every pull request

antonilol avatar Jun 14 '22 15:06 antonilol

i would suggest with every pull request

for sure, but also the url can be broken after X period of time, once the PR is landed (with valid URL) on the master

vincenzopalazzo avatar Jun 14 '22 15:06 vincenzopalazzo

i would suggest with every pull request

for sure, but also the url can be broken after X period of time, once the PR is landed (with valid URL) on the master

ok yeah, a bit of an edge case, but good to also check those. i set it to every month and every pull request now

antonilol avatar Jun 14 '22 15:06 antonilol

are actions disabled in this repo?

antonilol avatar Jun 14 '22 15:06 antonilol

wow, there's a script for this already? :D glad I asked

instagibbs avatar Jun 14 '22 15:06 instagibbs

more people had issues with broken links before

antonilol avatar Jun 14 '22 15:06 antonilol

I think that the PR need to be merged before, otherwise creating a fake PR that trigger the CI can put down the Github action.

I had an attack like these in one of my repo, while a go now github disable it

vincenzopalazzo avatar Jun 14 '22 15:06 vincenzopalazzo

ok i will merge it on my fork then to test it

testing it here: https://github.com/antonilol/bolts/pull/1

antonilol avatar Jun 14 '22 16:06 antonilol

it did not catch the error...

antonilol avatar Jun 14 '22 16:06 antonilol