{"repo":"ruzickap/action-my-broken-link-checker","free":true,"listed":false,"github":"https://github.com/ruzickap/action-my-broken-link-checker","clone":"git clone https://github.com/ruzickap/action-my-broken-link-checker.git","description":"A GitHub Action for checking broken links","language":"Shell","stars":50,"topics":["broken-links","github-actions","github-action","actions","website","checker","links","link-checker","url-checker","link-checking"],"license":"Apache-2.0","category":"workflow-automation","readme_excerpt":"GitHub Actions: My Broken Link Checker ✔ This is a GitHub Action to check for broken links in your static files or web pages. It uses muffet for the URL checking task. See the basic GitHub Action example to run periodic checks (weekly) against mkdocs.org: Check out the real demo: This deploy action can be combined with Static Site Generators (Hugo, MkDocs, Gatsby, GitBook, mdBook, etc.). The following examples expect the web pages to be stored in the ./build directory. A caddy web server is started during the tests, using the hostname from the URL parameter and serving the web pages (see details in entrypoint.sh). Do you want to skip the Docker build step? OK, script mode is also available: Parameters Environment variables used by ./entrypoint.sh script. Variable Default Description -------------------- -------------------------------------------------------------------- ----------------------------------------------------------------------------------------- INPUT CMD PARAMS --buffer-size=8192 --max-connections=10 --color=always --verbose Command-line parameters for the URL checker muffet INPUT DEBUG false Enable debug mode for the ./entrypoint.sh script ( set -x ) INPUT PAGES PATH Relative path to the directory containing local web pages INPUT URL ( Mandatory / Required ) URL that will be checked Example of Periodic checks Pipeline for periodic link checking: Full example GitHub Action example: Best practices Let's try to automate the creation of web pages as much as possib","default_branch":null,"files":null,"tree":[],"storefront":"/r/ruzickap","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/ruzickap/action-my-broken-link-checker/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}