D8 fleet sync: add verify-docs-build job + DOCFX-VERSION-PICKER doc#107
Closed
Chris-Wolfgang wants to merge 1 commit into
Closed
D8 fleet sync: add verify-docs-build job + DOCFX-VERSION-PICKER doc#107Chris-Wolfgang wants to merge 1 commit into
Chris-Wolfgang wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Fleet-syncs D8 work from repo-template#395: adds a verify-docs-build job to release.yaml so that DocFX build failures block the NuGet publish step (rather than landing after the package is already live), and adds the canonical DOCFX-VERSION-PICKER.md doc whose corresponding assets already exist in this repo.
Changes:
- New
verify-docs-buildjob inrelease.yaml, gated by presence ofdocfx_project/docfx.json, runsdotnet restore/buildanddocfx metadata/build, then verifies_siteand_site/api. publish-nugetnow also depends onverify-docs-buildso a docs failure blocks the NuGet publish.- Adds
docs/DOCFX-VERSION-PICKER.mddocumenting the existing version-picker mechanism (not shown in diff).
Reviewed changes
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
.github/workflows/release.yaml |
Adds the verify-docs-build Windows job before publish-nuget and adds it to publish-nuget.needs. |
docs/DOCFX-VERSION-PICKER.md |
New canonical doc for the version-picker mechanism (not in diff). |
Owner
Author
|
Superseded by PR #112 (vNext → main release). Content is folded into the vNext release PR alongside the rest of the canonical maintenance round. |
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
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.
Summary
Fleet sync of the D8 canonical work from repo-template#395.
Changes
.github/workflows/release.yaml— adds averify-docs-buildjob (Windows) beforepublish-nuget. Builds DocFX without deploying so a docs failure blocks the NuGet push instead of landing after the package is live. Gated bydocfx_project/docfx.jsonexistence (no-op on repos without docfx).docs/DOCFX-VERSION-PICKER.md— canonical doc describing the version-picker mechanism whose assets already shipped fleet-wide.Why protected merge
release.yamlis a protected path; this PR will trip the "Detect .NET Projects" guard on its own check. Use admin-bypass merge.Source
Verbatim copy of
repo-template/mainafter PR #395 merged.