Add Markdown link checking of this project's Markdown files
What does this MR do and why?
Adds link checking of this project's Markdown files to this project.
Lychee dependency is handled with Brew. We could later add something like these for Linux distributions:
- https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/main/packages_arch.txt?ref_type=heads
- https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/main/packages_debian.txt?ref_type=heads
- https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/main/packages_fedora.txt?ref_type=heads
- https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/main/packages_ubuntu.txt?ref_type=heads
Here's the passing job: https://gitlab.com/gitlab-org/technical-writing-group/gitlab-docs-hugo/-/jobs/6567982137.
How to set up and validate locally
Numbered steps to set up and validate the change are strongly suggested.
-
Configure a local GitLab Docs environment: https://gitlab.com/gitlab-org/technical-writing-group/gitlab-docs-hugo/-/blob/main/doc/setup.md. -
Check out this branch. -
Run make setup
. -
Break an internal link in README.md
. For example, line 12. -
Run make test
. You should get an error. -
Commit the change to the branch. -
Run yarn run lefthook run pre-push
. You should get an error. -
Drop the commit that made the change that introduced the break. -
Run make test
. You should get no error.
Merge request acceptance checklist
This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.
-
I have evaluated the MR acceptance checklist for this merge request.
Edited by Evan Read