Skip to content

Commit

Permalink
Add workflow to check for example links and broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
szepeviktor authored and jeromegamez committed Nov 19, 2023
1 parent ad6645f commit 8f28a99
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Docs

on:
push:
tags-ignore:
- '**'
pull_request:
workflow_dispatch:

jobs:
links:
name: Links
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Run Lychee
uses: lycheeverse/lychee-action@v1
with:
args: "--verbose --no-progress './**/*.md' './**/*.html' './**/*.rst'"
output: ${{ runner.temp }}/lychee/out.md
fail: true
7 changes: 7 additions & 0 deletions .lycheeignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
^https://[^/]+\.example/
\S+@domain\.example$
^https://example\.page\.link/
^https://[^/]+\.firebaseio\.com/
^https://www\.googleapis\.com/
^https://oauth2\.googleapis\.com/
^project-id-xyz@beste-firebase\.iam\.gserviceaccount\.com$

0 comments on commit 8f28a99

Please sign in to comment.