Skip to content

D8 canonical refresh: inline root-redirect HTML, drop template file#195

Merged
Chris-Wolfgang merged 4 commits into
mainfrom
canonical/d8-inline-root-redirect
Jun 18, 2026
Merged

D8 canonical refresh: inline root-redirect HTML, drop template file#195
Chris-Wolfgang merged 4 commits into
mainfrom
canonical/d8-inline-root-redirect

Conversation

@Chris-Wolfgang

Copy link
Copy Markdown
Owner

Summary

Adopts the new canonical pattern (proven on D20-Dice b58861a, landed on repo-template/main via PR #408) for the gh-pages root landing page.

Changes (4 files)

  • .github/workflows/docfx.yaml — synced from canonical. The root index.html is now built inline as a PowerShell string-array inside the Deploy docs to GitHub Pages step (no more Get-Content of a template file + regex -replace substitution). Only the page title is dynamic; the in-page version picker (public/version-picker.js) handles version switching from any docs page, so the root no longer needs a clickable list.

  • .github/workflows/build-all-versions.yaml — same inline-HTML refactor on the parallel Generate root index.html step.

  • .github/version-picker-template.htmlDELETED. No workflow step references it anymore.

  • docs/DOCFX-VERSION-PICKER.md — updated section 4, the gh-pages flow diagram, and the troubleshooting table to point at the new step names + log lines.

Why

The template-file indirection was pure overhead — the only dynamic piece was the page title (the repo name). Inlining the HTML in the workflow makes what gets produced visible at the call site and removes a file from every repo.

Bypass needed

Touches protected paths (.github/workflows/*.yaml, .github/version-picker-template.html), so the Detect .NET Projects guard will fail. Admin-bypass merge.

Copilot AI review requested due to automatic review settings June 3, 2026 20:20

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR refreshes the GitHub Pages (gh-pages) root landing behavior to the newer “canonical” pattern by generating a minimal root index.html redirect inline in the workflows and removing the now-unneeded HTML template file.

Changes:

  • Inline-generate the gh-pages root index.html redirect HTML in both docs deployment workflows (no template file or regex substitution).
  • Remove .github/version-picker-template.html now that workflows no longer depend on it.
  • Sync additional “canonical” workflow hardening around docs asset overlay/backfill, versions manifest safety checks, and deploy robustness.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
.github/workflows/docfx.yaml Builds root redirect HTML inline and includes canonical hardening (overlay docs assets, versions.json safeguards, deploy script improvements).
.github/workflows/build-all-versions.yaml Uses the same inline root redirect generation; filters versions.json entries to tags that actually built; bumps gh-pages action pin.
.github/version-picker-template.html Deleted (no longer referenced).

@Chris-Wolfgang Chris-Wolfgang merged commit 26830bc into main Jun 18, 2026
8 of 9 checks passed
@Chris-Wolfgang Chris-Wolfgang deleted the canonical/d8-inline-root-redirect branch June 18, 2026 22:25
Chris-Wolfgang added a commit that referenced this pull request Jun 19, 2026
Resolves 2 conflict files by taking main's (canonical) version:

- .github/workflows/docfx.yaml — 3 hunks. vNext was behind on:
  - The `env: GITHUB_REPOSITORY: ...` derive that lets the versions.json
    preservation guard work under workflow_call (main's PR #229/#230).
  - The hardened PowerShell error handling in the existing-versions
    fetch (distinguishes 404 from other failures more carefully,
    drops the PS-5-only `-UseBasicParsing` flag).
  - The inlined root-redirect HTML — replaces the external
    `.github/version-picker-template.html` indirection (main's
    PR #195 "canonical/d8-inline-root-redirect"). The template file
    is deleted by this merge.

- docs/DOCFX-VERSION-PICKER.md — add/add. Main's 256-line version
  documents the inlined-HTML approach; vNext's 210-line version
  still described the template file. Taking main's keeps the doc
  internally consistent with the workflow change above.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.

2 participants