docfx.yaml: feed back coverage-trend + SHA-pinning + checkout@v7 (downstream → canonical) - #425
Merged
Merged
Conversation
… String-Extensions
… coverage-trend main moved ahead via the github-actions Dependabot group bump (checkout@v6→v7, setup-dotnet kept @v5, floating tags). The original feed-back branch also SHA-pinned those actions, which conflicts with the floating-tag convention Dependabot just reaffirmed on main. Resolution: take main's docfx.yaml verbatim (floating @v7/@v5) and splice in ONLY the uncontested improvement — the coverage-trend block (T1 #65: restore prior coverage/history snapshots from gh-pages, pass -historydir so ReportGenerator renders the historical chart, re-deploy the accumulated history). Dropped the SHA-pinning change; whether to SHA-pin actions fleet-wide is a separate S2-hardening decision, not something this docs-feature PR should force.
This was referenced Jun 30, 2026
This was referenced Jun 30, 2026
Chris-Wolfgang
added a commit
to Chris-Wolfgang/DbContextBuilder
that referenced
this pull request
Jun 30, 2026
## Summary Syncs `.github/workflows/docfx.yaml` to the current canonical repo-template version. This is a generic workflow (repo name auto-derived from the GitHub context — no per-repo placeholders), so it is a straight overwrite. Brings the recent canonical fixes: - **first-deploy guard** — don't fail the first docs deploy when gh-pages serves a 200 placeholder / non-JSON (Chris-Wolfgang/repo-template#421) - coverage-trend into the docs site, SHA-pinned third-party actions, `actions/checkout@v7` (Chris-Wolfgang/repo-template#425) - plus the full current docs tooling (versions.json preservation, dev/ keep-list, version-picker overlay). Protected file — needs a maintainer admin-bypass merge. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
A fleet docfx drift-scan found downstream repos'
docfx.yamlwere ahead of repo-template canonical, not behind. The canonical here was the stale one. This promotes the most advanced downstream version (String-Extensions, 685 lines) so future syncs propagate the improvements up across the fleet instead of reverting them.What canonical was missing (now added)
coverage/history/*snapshots are restored fromgh-pagesbefore generating, and re-published, so the trend accumulates across releases instead of resetting each deploy. Best-effort (continue-on-error).actions/checkoutandactions/setup-dotnetpinned to commit SHA with a# v7/# v5comment, preventing tag-hijack supply-chain attacks.actions/checkout@v7@v6.All other content is identical to the current canonical (overlay-canonical-docs-assets, inline-HTML root redirect, etc.). The file is repo-agnostic (keys off
$env:GITHUB_REPOSITORY), verified byte-identical to String-Extensions' workingdocfx.yaml.Fleet effect
After this merges, the ~9 repos currently at 663-line
docfx.yaml(DbContextBuilder, ETL-*, IEquatable, etc.) will read as "behind canonical" — correctly — and pick up the coverage-trend + SHA-pinning on their next template sync. Convergence is upward.Not in scope
build-all-versions.yaml— handled separately (the 2 split-landing time-bomb fixes: IAsyncEnumerable Harden all GitHub Actions workflows against supply chain and permission escalation risks #269, D20-Dice Fix verb tense consistency in README setup instructions #200).bulk-repo-pronce this canonical lands, if/when a broad docs-sync pass is wanted.Protected file → admin-bypass merge
Touches
.github/workflows/docfx.yaml.