Project-Books / book-project

Book tracker web app for book lovers
https://project-books.github.io/
GNU General Public License v3.0
482 stars 456 forks source link

Check for broken links in README, contributing and Code of Conduct #950

Closed knjk04 closed 2 years ago

knjk04 commented 2 years ago

To ensure we are correctly linking to our own documentation site, where we do update links frequently, we should find a way to routinely check for any broken links. One possible approach would be to find a way using GitHub actions.

We want this to run regularly (e.g. once a day). However, we don't want this to be triggered on every commit (too frequent and this may slow down our CI build time) or when we only change markdown files (may not be frequent enough).

Additional context

If you need help with anything, we'll be happy to help you over a GitHub Q&A discussion or our Slack workspace

knjk04 commented 2 years ago

See https://github.com/gaurav-nelson/github-action-markdown-link-check

knjk04 commented 2 years ago

Implemented in https://github.com/Project-Books/book-project/commit/3794dfd0582ef594f3acd698b76e1bc89a36de54