Check links in documentation #115
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Check links in documentation | |
| on: | |
| pull_request: | |
| branches: | |
| - main | |
| # Only watch root level Markdown documentation file changes and latest analysis results | |
| paths: | |
| - 'README.md' | |
| - '.github/workflows/check-links-in-documentation.yml' # also run when this file was changed | |
| - 'analysis-results/**/latest/**' # also run when latest analysis results change | |
| schedule: | |
| - cron: "50 7 * * 1" # Every week at 07:50 AM on Monday | |
| jobs: | |
| check-links-in-documentation: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout GIT Repository | |
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6 | |
| - name: Setup node.js | |
| uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6 | |
| with: | |
| node-version-file: '.nvmrc' | |
| - name: Skip on update of AxonFramework by bot (Renovate) | |
| if: | | |
| github.event_name == 'pull_request' && | |
| startsWith(github.event.pull_request.title, 'Update dependency AxonFramework') && | |
| github.event.pull_request.user.type == 'Bot' | |
| run: | | |
| echo "Skipping link check on AxonFramework updates since the updated links to the analysis-results will only be active " | |
| echo "skip_link_check=true" >> $GITHUB_ENV | |
| - name: Check links in top level documentation Markdown files | |
| if: ${{ ! env.skip_link_check}} | |
| run: npx --yes markdown-link-check@3.14.2 --config markdown-lint-check-config.json README.md |