move build steps into Makefile, call make check from CI

Author: LauraLangdon

.github/workflows/deploy.yml

@@ -25,28 +25,7 @@ jobs:
           node-version: 20
           cache: npm
 
-      - run: npm ci
-
-      - run: npx myst build --html
-
-      - run: node scripts/generate-feed.js
-
-      - run: npx linkinator ./_build/html/
-
-      - name: Accessibility check
-        # pa11y-ci needs a running server to crawl the built site.
-        # Chromium requires --no-sandbox on GitHub Actions runners (see .pa11yci).
-        run: |
-          npx serve _build/html -p 4117 &
-          SERVER_PID=$!
-          # Ensure the server is killed even if pa11y-ci fails, so the
-          # background process doesn't linger until the job times out.
-          trap "kill $SERVER_PID" EXIT
-          # Wait for server to be ready (more reliable than a fixed sleep)
-          timeout 30 bash -c 'until curl -s http://localhost:4117 > /dev/null; do sleep 1; done'
-          npx pa11y-ci --sitemap http://localhost:4117/sitemap.xml \
-            --sitemap-find 'http://localhost:[0-9]+' \
-            --sitemap-replace 'http://localhost:4117'
+      - run: make check
 
       - uses: peaceiris/actions-gh-pages@v4
         with:

.github/workflows/pr.yml

@@ -24,27 +24,7 @@ jobs:
           node-version: 20
           cache: npm
 
-      - run: npm ci
-
-      - run: npx myst build --html
-
-      - run: node scripts/generate-feed.js
-
-      - run: npx linkinator ./_build/html/
-
-      - name: Accessibility check
-        # pa11y-ci needs a running server to crawl the built site
-        run: |
-          npx serve _build/html -p 4117 &
-          SERVER_PID=$!
-          # Ensure the server is killed even if pa11y-ci fails, so the
-          # background process doesn't linger until the job times out.
-          trap "kill $SERVER_PID" EXIT
-          # Wait for server to be ready (more reliable than a fixed sleep)
-          timeout 30 bash -c 'until curl -s http://localhost:4117 > /dev/null; do sleep 1; done'
-          npx pa11y-ci --sitemap http://localhost:4117/sitemap.xml \
-            --sitemap-find 'http://localhost:[0-9]+' \
-            --sitemap-replace 'http://localhost:4117'
+      - run: make check
 
       # continue-on-error because fork PRs don't have write access to push
       # the preview to gh-pages. The build check above still validates the PR.

Makefile

@@ -1,20 +1,38 @@
-.PHONY: help install html serve clean
+.PHONY: help install html serve clean lint a11y check
 .DEFAULT_GOAL := help
 
 help:
 	@grep ": ##" Makefile | grep -v grep | tr -d '#'
 
 install: ## Install Node dependencies (mystmd)
-	npm install
+	npm ci
 
 html: ## Build MyST site in ./_build/html
 html: install
-	npx myst build --html && node scripts/generate-feed.js
+	npx myst build --html
+	node scripts/generate-feed.js
 
 serve: ## Serve MyST site locally (live reload)
 serve: install
 	npx myst start
 
+lint: ## Check for broken links in the built site
+lint: html
+	npx linkinator ./_build/html/
+
+a11y: ## Run accessibility checks against the built site
+a11y: html
+	npx serve _build/html -p 4117 & \
+	SERVER_PID=$$!; \
+	trap "kill $$SERVER_PID" EXIT; \
+	timeout 30 bash -c 'until curl -s http://localhost:4117 > /dev/null; do sleep 1; done'; \
+	npx pa11y-ci --sitemap http://localhost:4117/sitemap.xml \
+		--sitemap-find 'http://localhost:[0-9]+' \
+		--sitemap-replace 'http://localhost:4117'
+
+check: ## Run full build + lint + accessibility (same as CI)
+check: lint a11y
+
 clean: ## Remove built files
 clean:
 	rm -rf _build