Skip to content

ADD TO: basic QA / add link checker #29

ADD TO: basic QA / add link checker

ADD TO: basic QA / add link checker #29

Workflow file for this run

name: CS
on:
# Run on all pushes and on all pull requests.
push:
pull_request:
# Allow manually triggering the workflow.
workflow_dispatch:
# Do NOT cancels all previous workflow runs for the same branch that have not yet completed.
concurrency:
# The concurrency group contains the workflow name and the branch name.
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: false
jobs:
markdownlint:
name: 'Lint Markdown'
uses: PHPCSStandards/.github/.github/workflows/reusable-markdownlint.yml@main
yamllint:
name: 'Lint Yaml'
uses: PHPCSStandards/.github/.github/workflows/reusable-yamllint.yml@main
with:
strict: true
linkcheck:
name: "Check links"
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Restore lychee cache
uses: actions/cache@v4
with:
path: .lycheecache
key: cache-lychee-${{ github.sha }}
restore-keys: cache-lychee-
- name: Link Checker
uses: lycheeverse/lychee-action@v2
with:
# Check all markdown, html and reStructuredText files in repo (default)
args: --cache --max-cache-age 1w --verbose './**/*.md'
format: markdown
# Use different output file path
output: /tmp/foo.txt
token: ${{ secrets.GITHUB_TOKEN }}
fail: true
# Run lychee in a different directory.
# Note: This changes the lychee output directory as well.
workingDirectory: website/subdir