Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatic broken link checking #360

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
61 changes: 61 additions & 0 deletions .github/workflows/link-checker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: Link Checker

on:
workflow_dispatch:
schedule:
- cron: "00 18 * * *"

jobs:
linkChecker:
runs-on: ubuntu-latest
permissions:
issues: write
steps:
- uses: actions/checkout@v4


- name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.1'
bundler-cache: true
cache-version: 0


- name: Install dependencies
run: |
bundle install
- name: Build with Jekyll
# Outputs to the './_site' directory by default
run: |
bundle exec jekyll build
env:
PAGES_REPO_NWO: ${{ github.repository }}
JEKYLL_BUILD_BRANCH: ${{ github.ref_name }}
JEKYLL_ENV: production
JEKYLL_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Link Checker
id: lychee
uses: lycheeverse/[email protected]
with:
# Check all markdown, html and reStructuredText files in repo (default)
args: _site/ --fallback-extensions html --exclude '^https://github\.com'
# Don't fail action on broken links
fail: false
lycheeVersion: v0.17.0

- name: Add page URL
run: |
DEPLOY_URL="https://www.infectious-diseases-toolkit.org/" && \
sed -i "s|\\#\\#\\# Errors in _site\/|\\#\\#\\# Errors in ${DEPLOY_URL}|g" ./lychee/out.md && \
cat ./lychee/out.md

- 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: bug, automated issue
issue-number: 380
Loading