Skip to content

ci: Trigger Pages deploy from Release workflow#299

Draft
rubberduck203 wants to merge 4 commits intomainfrom
ci/trigger-pages-from-release
Draft

ci: Trigger Pages deploy from Release workflow#299
rubberduck203 wants to merge 4 commits intomainfrom
ci/trigger-pages-from-release

Conversation

@rubberduck203
Copy link
Copy Markdown
Contributor

@rubberduck203 rubberduck203 commented Apr 8, 2026

Summary

  • Remove the tag glob trigger from gh-page.yml — it hasn't matched since the CalVer format changed in February
  • Instead, call gh-page.yml directly from the Release workflow via workflow_call
  • This makes the dependency explicit: a release always deploys Pages
  • Update docusaurus.config.ts to point at Gusto org (was still referencing oscope-dev)
  • Add CI workflow README with mermaid diagram and CLAUDE.md for maintenance

Blocked: GitHub Pages domain issue

GitHub Pages is enabled for the repo, but the Gusto org has a custom domain (docs.gusto.com) configured for Pages. That means this repo's docs would be served at docs.gusto.com/scope/, which is a problem because docs.gusto.com is Gusto's official public API documentation portal for customers and partners. An internal dev tool's docs shouldn't live there.

Options to resolve

  1. Set a repo-level custom domain (e.g., scope-docs.gusto.com) — requires DNS work and org admin help
  2. Host docs outside GitHub Pages (Netlify, Vercel, Cloudflare Pages) — avoids the org domain issue entirely
  3. Don't deploy Pages from this org — keep docs in the repo, read on GitHub directly
  4. Ask an org admin if there's a way to exclude a single repo from the org-level custom domain

Context

  • Pages hasn't deployed since January 2026, when the repo was transferred from oscope-dev to Gusto
  • The old oscope-dev org had no custom domain, so Pages worked at oscope-dev.github.io/scope/
  • The Gusto/gists repo (internal visibility) gets an anonymized URL, but public repos are forced through docs.gusto.com

Why Pages was broken before the domain issue

The Build Github Pages workflow triggered on tags matching '**[0-9]+.[0-9]+.[0-9]+*'. Old tags like v2026.1.12 matched. New tags like v2026.4.8+1002 do not — the + breaks the glob.

Test plan

  • Verified full release pipeline via workflow_dispatch — Pages build step succeeds
  • Verified deploy step correctly skips on non-main branches
  • GitHub Pages enabled for Gusto/scope
  • Resolve domain issue before merging

🤖 Generated with Claude Code

rubberduck203 and others added 4 commits April 8, 2026 06:40
Pages hasn't deployed since January because the tag glob pattern
in gh-page.yml didn't match the new CalVer+build metadata tags.
Instead of fixing the pattern, call gh-page.yml directly from the
Release workflow via workflow_call — this is more reliable and
makes the dependency explicit.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Also add CLAUDE.md to remind AI assistants to keep the README
in sync when workflows are modified.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Update URL, organizationName, editUrl, and GitHub links to point
at the Gusto org after the repo transfer.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Gusto's org has a custom domain for GitHub Pages.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@rubberduck203 rubberduck203 marked this pull request as draft April 8, 2026 11:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant