ci: audit and update PR preview workflows

[ishwar170695]

Notes for Reviewers

This PR audits and updates the PR preview workflows for academy-theme following the workflow review checklist shared by Lenox Wiltshire.

Summary

• Pin GitHub Actions to immutable commit SHAs while preserving each workflow's existing major version.
• Expand preview workflow path filters to include all Hugo sources that affect rendered output.
• Align the minimum Hugo version in hugo.yaml with the hugo-extended version in package.json.
• Remove obsolete Hugo CLI and Dart Sass setup steps from the preview build workflow.
• Add wait-for-pages-deployment: false to the preview deployment workflow.
• Update the preview deployment comment to the standardized format with the GitHub Pages deployment tracking link.

Verification

• Verified all pinned SHAs against upstream Git tags using git ls-remote --tags.
• Confirmed Hugo version alignment (0.158.0) between hugo.yaml and package.json.
• Successfully built the site locally with npm run build:preview (Hugo v0.158.0).
• Ran git diff --check to ensure there are no whitespace or formatting issues.

Signed commits

• Yes, I signed my commits.

Summary by CodeRabbit

• Chores
  • Improved documentation preview builds by detecting changes across additional content and configuration files.
  • Updated workflow tooling for more reliable and secure preview builds and deployments.
  • Enhanced deployment status messages with a link for tracking progress.
  • Simplified preview deployment behavior to reduce unnecessary waiting.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 946bc063-d4fe-48f6-81f9-d7a2c29fde00

📥 Commits

Reviewing files that changed from the base of the PR and between 437c919 and 84695a3.

📒 Files selected for processing (1)

• .github/workflows/build-docs-preview.yml

---

📝 Walkthrough

Walkthrough

The documentation preview workflows now monitor more site and dependency paths, use updated pinned GitHub Actions, remove obsolete installation comments, and post revised preview deployment messages without waiting for Pages deployment.

Changes

Documentation preview workflows

Layer / File(s)	Summary
Preview build triggers and actions .github/workflows/build-docs-preview.yml	The build workflow watches additional site and dependency paths. It removes obsolete Hugo and Dart Sass installation comments, updates pinned actions, and retains failure behavior when no artifact files are found.
Preview deployment actions and messaging .github/workflows/deploy-docs-preview.yml	The deployment workflow updates pinned action references, disables waiting for Pages deployment, and posts a message with a refresh note and Pages workflow link.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related issues

• layer5io/academy-theme#231 — This issue concerns standardizing the documentation preview build and deployment workflows updated here.

Possibly related PRs

• layer5io/academy-theme#239 — This PR directly updates the same documentation preview workflow files.
• layer5io/academy-theme#245 — This PR also modifies the build workflow and removes obsolete Hugo and Dart Sass installation steps.

Suggested reviewers: banana-three-join

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the audit and updates to the PR preview workflows.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[banana-three-join]

Please keep the scope of the audit only to the Build Site Preview and the Site Preview Post-Build workflows. Revert on the changes made to any of the other workflows.

[banana-three-join]

Regression in version

[banana-three-join]

Regression in version

[banana-three-join]

Regression in version

[banana-three-join]

Regression in version

[ishwar170695]

Please keep the scope of the audit only to the Build Site Preview and the Site Preview Post-Build workflows. Revert on the changes made to any of the other workflows.

The scope has been restricted and v7 pins have been restored. Please review when you have time.