check_links.yml

#
# GitHub Actions Workflow for pull request events against main
# check for problems in links.

name: Check links
on:
  pull_request:
    branches: [ main ]
  schedule:
    - cron: '23 8 * * 1'
  workflow_dispatch:

jobs:
  check_links:
    name: Check Markdown links  # TODO: Check also Asciidoc (this should take place in https://github.com/cf-convention/cf-conventions)
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Check links
        uses: lycheeverse/lychee-action@v1.8.0
        with:
          output: ./lychee/out.md
        
      - name: Upload report
        if: ${{ always() }}
        uses: actions/upload-artifact@v1
        with:
          name: Link check report
          path: ./lychee/out.md
      
      - name: Create Issue From File
        uses: peter-evans/create-issue-from-file@v4.0.0
        with:
          title: Link Checker Report
          content-filepath: ./lychee/out.md
          labels: report, automated issue