Add blog CI checks pipeline#3
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a GitHub Actions workflow intended to run CI checks for the blog on pushes and PRs targeting main.
Changes:
- Introduces a new
Check Blogworkflow triggered onpushandpull_requesttomain. - Checks out the repo, sets up Node.js, installs dependencies, and runs a Docusaurus build.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # limitations under the License. | ||
| ################################################################################ | ||
|
|
||
| # This workflow is meant for checking broken links in the blog. |
There was a problem hiding this comment.
The header comment says this workflow checks broken links, but the job only runs docusaurus build and the site config currently sets onBrokenLinks: 'warn', so broken links won't fail CI. Either update the description to match (build-only) or adjust the build/link-checking so broken links cause a failure (e.g., CI-specific onBrokenLinks: 'throw').
| # This workflow is meant for checking broken links in the blog. | |
| # This workflow is meant for validating that the blog builds successfully. |
| with: | ||
| node-version: 24 | ||
| - name: Install dependencies | ||
| run: npm install |
There was a problem hiding this comment.
CI uses npm install but the repo doesn't include a lockfile, which makes dependency resolution non-deterministic and can cause flaky builds over time. Consider committing a lockfile (package-lock.json) and switching CI to npm ci for reproducible installs (and enabling setup-node caching once a lockfile exists).
| run: npm install | |
| run: | | |
| if [ ! -f package-lock.json ]; then | |
| echo "package-lock.json is required for reproducible CI installs. Commit the lockfile and rerun." | |
| exit 1 | |
| fi | |
| npm ci |
| branches: [main] | ||
|
|
||
| jobs: | ||
| test-deploy: |
There was a problem hiding this comment.
Job id test-deploy is misleading in a workflow named "Check Blog" (it neither tests nor deploys). Renaming it to something like build/check makes the Actions UI and logs easier to interpret.
| test-deploy: | |
| check: |
No description provided.