Skip to content

Commit

Permalink
Add GitHub Action for automated link checking on PRs
Browse files Browse the repository at this point in the history
  • Loading branch information
shawnthompson committed Aug 23, 2024
1 parent ece2001 commit 895b050
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 0 deletions.
46 changes: 46 additions & 0 deletions .github/workflows/link-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Link Checker

# Trigger the workflow on pull requests to the main or develop branches
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@v2

# Step 2: Set up Node.js environment
- name: Set up Node.js
uses: actions/setup-node@v2
with:
node-version: '20' # Specify Node.js 20.x

# Step 3: Install dependencies
- name: Install dependencies
run: npm install

# Step 4: Build the site and serve it on a dynamic port
- name: Build and serve the site
run: npm run serve-only &

- name: Wait for server to start
run: sleep 10 # Adjust as needed based on server start time

# Step 5: Run the link checker
- name: Run link checker
run: npm run link-check

# Step 6: Upload broken links report if broken links are found
- name: Upload broken links report
if: failure()
uses: actions/upload-artifact@v2
with:
name: broken-links-report
path: broken-links.json
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"newPage": "node scripts/create-new-page.js",
"link-check": "node scripts/link-checker.js",
"serve:port": "node scripts/serve-with-port.js",
"serve-only": "npx @11ty/eleventy --serve --port=8080 --quiet --formats=html,css,js",
"test": "echo \"Error: no test specified\" && exit 1",
"spellcheck": "cspell --no-progress -u \"src/en/**/*.html\" \"src/en/**/*.md\" \"src/fr/**/*.html\" \"src/fr/**/*.md\"",
"eleventy": "npx eleventy",
Expand Down

0 comments on commit 895b050

Please sign in to comment.