improved link-checker #14
Workflow file for this run
This file contains 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: Link Checker | |
| on: | |
| pull_request: | |
| branches: | |
| - main | |
| - develop | |
| jobs: | |
| link-check: | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Step 1: Check out the repository code | |
| - name: Check out code | |
| uses: actions/checkout@v4 | |
| # Step 2: Set up Node.js environment | |
| - name: Set up Node.js | |
| uses: actions/[email protected] | |
| with: | |
| node-version: '20' | |
| # Step 3: Install dependencies | |
| - name: Install dependencies | |
| run: npm install | |
| # Step 4: Create a temporary .eleventy-port file | |
| - name: Create a temporary .eleventy-port file | |
| run: echo "8080" > .eleventy-port | |
| # Step 5: Build and serve the site | |
| - name: Build and serve the site | |
| run: npm run serve-only & | |
| # Step 6: Wait for the server to start | |
| - name: Wait for server to start | |
| run: sleep 10 | |
| # Step 7: Run the link checker | |
| - name: Run link checker | |
| id: link-check # Add ID to reference outputs | |
| run: npm run link-check | |
| # Step 8: Upload broken links report regardless of link check result | |
| - name: Upload broken links report | |
| if: always() # This runs regardless of the result of the previous step | |
| uses: actions/[email protected] | |
| with: | |
| name: broken-links-report | |
| path: broken-links.json | |
| # Step 9: Post a comment on the PR with the broken links details | |
| - name: Post comment with broken links | |
| if: failure() # This runs only if broken links were found | |
| uses: peter-evans/create-or-update-comment@v4 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| issue-number: ${{ github.event.pull_request.number }} | |
| body: | | |
| ## :warning: Broken Links Detected | |
| The following broken links were found during the build process: | |
| ```json | |
| ${{ toJSON(steps.link-check.outputs.brokenLinks) }} | |
| ``` |