{"repo":"lycheeverse/lychee-action","free":true,"listed":false,"github":"https://github.com/lycheeverse/lychee-action","clone":"git clone https://github.com/lycheeverse/lychee-action.git","description":"Github action to check for broken links in Markdown, HTML, and text files using lychee, a fast link checker written in Rust.","language":"Shell","stars":508,"topics":["link-checker","action","github-actions","continuous-integration"],"license":"Apache-2.0","category":"workflow-automation","readme_excerpt":"lychee link checking action Quickly check links in Markdown, HTML, and text files using [lychee]. When used in conjunction with [Create Issue From File], issues will be opened when the action finds link problems (make sure to specify the issues: write permission in the workflow or the job). Usage Here is a full example of a GitHub workflow file: It will check all repository links once per day and create an issue in case of errors. Save this under .github/workflows/links.yml : Passing arguments This action uses [lychee] for link checking. lychee arguments can be passed to the action via the args parameter. On top of that, the action also supports some additional arguments. Argument Examples Description ---------------- ----------------------- --------------------------------------------------------------------------------------- args --cache , --insecure See [lychee's documentation][lychee-args] for all arguments and values debug false Enable debug output in action (set -x). Helpful for troubleshooting fail false Fail workflow run on error (i.e. when [lychee exit code][lychee-exit] is not 0) failIfEmpty false Fail entire pipeline if no links were found format markdown , json Summary output format jobSummary false Write GitHub job summary (on Markdown output only) lycheeVersion v0.15.0 , nightly Overwrite the lychee version to be used output lychee/results.md Summary output file path token \"\" Custom GitHub token to use for API calls workingDirectory . , path/to/subdir/ Custom w","default_branch":null,"files":null,"tree":[],"storefront":"/r/lycheeverse","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/lycheeverse/lychee-action/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."}