Fix GitHub Pages deployment workflow for Hugo documentation site

[Copilot]

Fixes the broken GitHub Pages deployment workflow that was preventing the Hugo documentation site from building and publishing correctly.

Issues Fixed

The existing gh-pages.yml workflow had several critical issues:

1. Broken submodule initialization: The Hugo theme hugo-theme-relearn wasn't being loaded because the workflow used fetch-depth: 1 which is insufficient for submodules, and submodules: true instead of the more robust submodules: recursive.

2. Outdated GitHub Actions: Used deprecated actions/checkout@v2 and obsolete ubuntu-20.04 runner which could cause compatibility issues.

3. Missing manual deployment option: No way to trigger deployments on-demand without making commits.

4. Insufficient permissions: Missing required GitHub Pages permissions for modern deployment workflows.

Changes Made

• Updated GitHub Actions: Upgraded to actions/checkout@v4 and ubuntu-latest runner
• Fixed submodule handling: Changed to submodules: recursive with fetch-depth: 0 to ensure the Hugo theme loads properly
• Added manual deployment: Included workflow_dispatch trigger for on-demand deployments
• Added required permissions: Specified pages: write and id-token: write permissions for GitHub Pages deployment
• Cleaned up build artifacts: Updated .gitignore to exclude Hugo's .hugo_build.lock file

Testing

Verified the fix by:

• Successfully building the Hugo site locally (generates 26 pages)
• Confirming the hugo-theme-relearn theme loads correctly from the submodule
• Testing both minified and regular builds work as expected

The workflow now supports both automatic deployment on commits to docs/ and manual deployment via the GitHub Actions interface.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• canonical-lgw01.cdn.snapcraftcontent.com
  • Triggering command: /usr/lib/snapd/snapd (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Original prompt

On gh-pages.yml, can you gey my github pages deploymeny working? It uses hugo but i cant seem tofigure out how to ge tit to pucblish/update, it should not be dependent ona build as its just docs, it should be runnable with a commit on on demand

---

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.