Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lycheeverse/lychee-action
Github action to check for broken links in Markdown, HTML, and text files using lychee, a fast link checker written in Rust.
https://github.com/lycheeverse/lychee-action
action continuous-integration github-actions link-checker
Last synced: about 9 hours ago
JSON representation
Github action to check for broken links in Markdown, HTML, and text files using lychee, a fast link checker written in Rust.
- Host: GitHub
- URL: https://github.com/lycheeverse/lychee-action
- Owner: lycheeverse
- License: apache-2.0
- Created: 2020-12-12T21:41:36.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-27T08:17:00.000Z (about 2 months ago)
- Last Synced: 2024-10-29T17:28:57.250Z (about 1 month ago)
- Topics: action, continuous-integration, github-actions, link-checker
- Language: Shell
- Homepage: https://lychee.cli.rs
- Size: 221 KB
- Stars: 321
- Watchers: 6
- Forks: 47
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
Awesome Lists containing this project
- project-awesome - lycheeverse/lychee-action - Github action to check for broken links in Markdown, HTML, and text files using lychee, a fast link checker written in Rust. (Shell)
README
# lychee link checking action
[](https://github.com/marketplace/actions/lychee-broken-link-checker)
[](https://github.com/lycheeverse/lychee-action/actions/workflows/links.yml)
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](https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#permissions) or the [job](https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idpermissions)).
## 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`:
```yaml
name: Links
on:
repository_dispatch:
workflow_dispatch:
schedule:
- cron: "00 18 * * *"
jobs:
linkChecker:
runs-on: ubuntu-latest
permissions:
issues: write # required for peter-evans/create-issue-from-file
steps:
- uses: actions/checkout@v4
- name: Link Checker
id: lychee
uses: lycheeverse/lychee-action@v2
with:
fail: false
- name: Create Issue From File
if: steps.lychee.outputs.exit_code != 0
uses: peter-evans/create-issue-from-file@v5
with:
title: Link Checker Report
content-filepath: ./lychee/out.md
labels: report, automated issue
```
## 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 |
See [action.yml](./action.yml) for a full list of supported arguments and their default values.
### Passing arguments
Here is how to pass the arguments.
```yml
- name: Link Checker
uses: lycheeverse/lychee-action@v2
with:
# Check all markdown, html and reStructuredText files in repo (default)
args: --base . --verbose --no-progress './**/*.md' './**/*.html' './**/*.rst'
# Use json as output format (instead of markdown)
format: json
# Use different output file path
output: /tmp/foo.txt
# Use a custom GitHub token, which
token: ${{ secrets.CUSTOM_TOKEN }}
# Don't fail action on broken links
fail: false
```
(If you need a token that requires permissions that aren't available in the
default `GITHUB_TOKEN`, you can create a [personal access
token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)
and pass it to the action via the `token` parameter.)
## Utilising the cache feature
In order to mitigate issues regarding rate limiting or to reduce stress on external resources, one can setup lychee's cache similar to this:
```yml
- name: Restore lychee cache
uses: actions/cache@v4
with:
path: .lycheecache
key: cache-lychee-${{ github.sha }}
restore-keys: cache-lychee-
- name: Run lychee
uses: lycheeverse/lychee-action@v2
with:
args: "--base . --cache --max-cache-age 1d ."
```
It will compare and save the cache based on the given key.
So in this setup, as long as a user triggers the CI run from the same commit, it will be the same key. The first run will save the cache, subsequent runs will not update it (because it's the same commit hash).
For restoring the cache, the most recent available one is used (commit hash doesn't matter).
If you need more control over when caches are restored and saved, you can split the cache step and e.g. ensure to always save the cache (also when the link check step fails):
```yml
- name: Restore lychee cache
id: restore-cache
uses: actions/cache/restore@v4
with:
path: .lycheecache
key: cache-lychee-${{ github.sha }}
restore-keys: cache-lychee-
- name: Run lychee
uses: lycheeverse/lychee-action@v2
with:
args: "--base . --cache --max-cache-age 1d ."
- name: Save lychee cache
uses: actions/cache/save@v4
if: always()
with:
path: .lycheecache
key: ${{ steps.restore-cache.outputs.cache-primary-key }}
```
## Excluding links from getting checked
Add a `.lycheeignore` file to the root of your repository to exclude links from
getting checked. It supports regular expressions. One expression per line.
## Fancy badge
Pro tip: You can add a little badge to your repo to show the status of your
links. Just replace `org` with your organisation name and `repo` with the
repository name and put it into your `README.md`:
```
[](https://github.com/org/repo/actions/workflows/links.yml)
```
It will look like this:
[](https://github.com/lycheeverse/lychee-action/actions/workflows/links.yml)
## Troubleshooting and common problems
See [lychee's Troubleshooting Guide][troubleshooting] for solutions to common
link-checking problems.
## Performance
A full CI run to scan 576 links takes approximately 1 minute for the
[analysis-tools-dev/static-analysis](https://github.com/analysis-tools-dev/static-analysis)
repository.
## Security and Updates
It is recommended to pin lychee-action to a fixed version [for security
reasons][security]. You can use dependabot to automatically keep your GitHub
actions up-to-date. This is a great way to pin lychee-action, while still
receiving updates in the future. It's a relatively easy thing to do.
Create a file named `.github/dependabot.yml` with the following contents:
```yml
version: 2
updates:
- package-ecosystem: "github-actions"
directory: ".github/workflows"
schedule:
interval: "daily"
```
When you add or update the `dependabot.yml` file, this triggers an immediate check for version updates.
Please see [the documentation][dependabot] for all configuration options.
### Security tip
For additional security when relying on automation to update actions you can pin
the action to a SHA-256 rather than the semver version so as to avoid tag
spoofing Dependabot will still be able to automatically update this.
For example:
```yml
- name: Link Checker
uses: lycheeverse/lychee-action@7da8ec1fc4e01b5a12062ac6c589c10a4ce70d67 # for v2.0.0
```
## Credits
This action is based on the deprecated [peter-evans/link-checker] and uses
[lychee] (written in Rust) instead of liche (written in Go) for link checking.
## License
lychee is licensed under either of
- [Apache License, Version 2.0] ([LICENSE-APACHE](./LICENSE-APACHE))
- [MIT License] ([LICENSE-MIT](./LICENSE-MIT))
at your option.
[lychee]: https://github.com/lycheeverse/lychee
[lychee-args]: https://github.com/lycheeverse/lychee#commandline-parameters
[lychee-exit]: https://github.com/lycheeverse/lychee#exit-codes
[troubleshooting]: https://github.com/lycheeverse/lychee/blob/master/docs/TROUBLESHOOTING.md
[security]: https://francoisbest.com/posts/2020/the-security-of-github-actions
[dependabot]: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
[peter-evans/link-checker]: https://github.com/peter-evans/link-checker
[create issue from file]: https://github.com/peter-evans/create-issue-from-file
[apache license, version 2.0]: https://www.apache.org/licenses/LICENSE-2.0
[mit license]: https://choosealicense.com/licenses/mit