commitizen/.github/workflows/links.yml at 8118df57887670bdc78b637b769932b6f3dbbc06 · commitizen-tools/commitizen · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
name: Links

on:
  repository_dispatch:
  workflow_dispatch:
  pull_request:
  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@v5

      - name: Link Checker
        id: lychee
        uses: lycheeverse/lychee-action@v2
        with:
          fail: false

      - name: Warn on broken links in PR
        if: steps.lychee.outputs.exit_code != 0 && github.event_name == 'pull_request'
        run: |
          echo "::warning::Link checker found broken links."
          if [ -f ./lychee/out.md ]; then
            echo "## 🔗 Link Checker Report" >> $GITHUB_STEP_SUMMARY
            echo "" >> $GITHUB_STEP_SUMMARY
            echo "The link checker found broken links in this pull request:" >> $GITHUB_STEP_SUMMARY
            echo "" >> $GITHUB_STEP_SUMMARY
            cat ./lychee/out.md >> $GITHUB_STEP_SUMMARY
          else
            echo "## 🔗 Link Checker Report" >> $GITHUB_STEP_SUMMARY
            echo "" >> $GITHUB_STEP_SUMMARY
            echo "The link checker found broken links. Please check the workflow logs for details." >> $GITHUB_STEP_SUMMARY
          fi

      - name: Create Issue From File
        if: steps.lychee.outputs.exit_code != 0 && github.event_name == 'schedule'
        uses: peter-evans/create-issue-from-file@v5
        with:
          title: Link Checker Report
          content-filepath: ./lychee/out.md
          labels: 'type: documentation'