167 add support to link check #173
Conversation
jenkin
changed the title
|
I am wondering if we should add this to a github actions as well Like this one: https://github.com/marketplace/actions/markdown-link-check cc @jenkin |
|
I was asking for a pre-commit hook in the meantime, so no broken links are committed to the repo. |
|
For pre-commit hooks or github actions, be aware of links to not (yet) existing pages. We have to create them as empty files? Moreover, some remote links always fail because of bot protection systems (ie. drupal.org), so we need to actively add them to exclusion list ( Example If links validation is mandatory for commit or delivery, a clear policy for these cases should be enforced and communicated to developers, imho. |
Using [markdown-link-validator](https://github.com/jenkin/markdown-link-validator/tree/feature/sparkfabrik-enhancements) from github repo. Build the docker image and run validation with `make check`.
jenkin
force-pushed
the
167-markdown-link-validator-enhanced
branch
from
155c657 to
4129c4d
Compare
| "raneto": "0.17.3", | ||
| "gulp": "4.0.2" | ||
| "gulp": "4.0.2", | ||
| "markdown-link-validator": "github:jenkin/markdown-link-validator#feature/sparkfabrik-enhancements", |
There was a problem hiding this comment.
come mai stiamo usando un fork ? devo aver perso qualche passaggio
There was a problem hiding this comment.
@paolomainardi Ho provato alcune soluzioni già pronte (come il markdown-link-check che hai menzionato anche tu o l'originale markdown-link-validator), ma nessuna soddisfa pienamente i nostri requisiti. Vedi #167 (in particolare la sezione drawbacks).
Alla fine ho optato per forkare markdown-link-validator e aggiungere le funzionalità che ci servono.
Tutte le modifiche fatte sono retrocompatibili per quanto riguarda le API della CLI e a mio avviso di interesse abbastanza generale da poter essere anche rilasciate (ho anche corretto alcune issue ancora aperte). Ma prima di proporre eventuali PR al repo originale aspettavo di integrare il tutto nel playbook e fare più test.
See [issues/167#issuecomment-1589456767](#167 (comment)).
jenkin
force-pushed
the
167-markdown-link-validator-enhanced
branch
from
89ed165 to
ce4bb49
Compare
|
@stickgrinder Ho aggiunto il check dei link al pre-commit con husky. Per fare il commit ho dovuto creare i tre file markdown mancanti (per ora vuoti) menzionati in
|
|
This seems ok to me, the bulk of the logic here lies in the markdown link checker, so let's merge this and do some real-world testing. Thanks @jenkin |
Using markdown-link-validator from github repo.
Build the docker image and run validation with
make check.