docfx.yaml: overlay canonical docs assets from main when backfilling old tags (admin-bypass) - #94
docfx.yaml: overlay canonical docs assets from main when backfilling old tags (admin-bypass)#94Chris-Wolfgang wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Pull request overview
The PR is described as a fleet sync of an upstream change that should add an overlay_canonical_docs_assets input (declared under both workflow_call and workflow_dispatch) and an "Overlay canonical docs assets from origin/main" step to .github/workflows/docfx.yaml. The overlay step is intended to swap in canonical docs-tooling files (docfx_project/{public,versions.json,logo.svg,docfx.json}) from origin/main when rebuilding docs against older tags, so backfilled versioned docs receive the current version-picker assets. On normal release runs (HEAD == origin/main) the step is meant to be a no-op.
The actual diff, however, deletes the entire docfx.yaml workflow (all 417 lines removed, nothing added) and the on-disk file is now empty (0 lines). This does not match the described intent and will break docs deployment rather than enhance it.
Changes:
- Entire
.github/workflows/docfx.yaml(Deploy DocFX Pages workflow) is removed. - No new
overlay_canonical_docs_assetsinput or overlay step is added, despite the PR description. - No other files are modified.
Comments suppressed due to low confidence (1)
.github/workflows/docfx.yaml:1
- The diff deletes the entire
.github/workflows/docfx.yamlfile (all 417 lines removed, none added), leaving an empty workflow file in the repository. This contradicts the PR description, which states the change should add anoverlay_canonical_docs_assetsinput (declared under bothworkflow_callandworkflow_dispatch) plus an "Overlay canonical docs assets from origin/main" step after checkout, while leaving the rest of the workflow intact. As written, this PR removes the entire Deploy DocFX Pages workflow — including the build, versions.json generation, gh-pages cleanup, and deploy steps — which will break docs deployment entirely rather than augment it. Please re-push the branch with the intended additive change on top of the existing workflow rather than a full deletion.
|
Closing — this overlay fanout was destructive. The wholesale docfx.yaml replace reverted this repo's workflow to repo-template's baseline (~156-line diff), not the intended purely-additive overlay step. Will redo surgically (add only the overlay input + step to this repo's own docfx.yaml). |
Summary
Fleet sync of repo-template#400. Adds a
overlay_canonical_docs_assetsinput (default true, declared under bothworkflow_callandworkflow_dispatch) plus an "Overlay canonical docs assets from origin/main" step that runs after checkout.Why
When you run
Deploy DocFX Pagesagainst an older tag to backfill that version's docs with the canonical version-picker dropdown, the tag's working tree predates the picker assets. The overlay stepgit checkout origin/main -- docfx_project/{public,versions.json,logo.svg,docfx.json}swaps just the docs-tooling files so the rebuilt versioned docs get the dropdown.HEAD == origin/mainshort-circuits it to a no-op on normal release-triggered runs.Scope is deliberately narrow: only docs-tooling files. Source / csproj / tests / scripts / other workflows are untouched.
Protected file
Touches
.github/workflows/docfx.yaml→ trips theDetect .NET Projectsguard. Admin-bypass merge required.Source
Verbatim from repo-template
feature/d-version-picker-overlay-canonical(PR #400, review-clean).