Fix the API references workflow for XMLDoc2Markdown 6 - #1443
Merged
martindevans merged 5 commits intoSep 27, 2026
Merged
Conversation
…name, with .NET 10 for XMLDoc2Markdown 6
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The workflow push target and contributor documentation still need updates.
Review effort: Lite
Findings: 1
What changed in this PR
Updates the API-reference workflow for XMLDoc2Markdown 6 and .NET 10.
Changes:
- Adds .NET 10 setup.
- Invokes
xmldoc2mddirectly.
| File | Summary |
|---|---|
.github/workflows/update_api_references.yml |
Workflow invocation and runtime updated. Critical: configure an explicit push target for pull-request review runs. Nit: update the contributor documentation command. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
…ush works for pull requests from forks too
Laurianti
marked this pull request as draft
September 26, 2026 05:56
…ose names Windows cannot check out
Laurianti
marked this pull request as ready for review
September 26, 2026 06:09
Member
|
Thanks for investigating this! |
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.

The "Update API references" workflow fails on every approval, so
docs/xmldocshas not been regenerated since October 2025.Two problems:
dotnet tool install -g XMLDoc2Markdowninstalls 6.0.0, whose command isxmldoc2mdand which needs .NET 10. The workflow runsdotnet xmldoc2mdwith .NET 8 only.actions/checkoutchecks out the pull request's merge ref, not a branch, sogit pushhas nowhere to go. On a pull request from a fork it cannot push at all: the job gets no write access to the fork.So the docs are now regenerated after a merge into master, when
LLama/changes. That works whatever the pull request came from.dotnet-xmldoc2md does not existGeneration: 146 succeeded, 0 failedThe contributing guide had the same
dotnet xmldoc2mdcommand, fixed too.XMLDoc2Markdown 6 also writes a page for each fixed buffer type the compiler generates, such as
llama.native.llamamodelmetadataoverride.<key>e__fixedbuffer.md. Windows cannot check out a name with<and>, so the job deletes those two pages and their lines inindex.md. 5.0.0 is not an option: it fails to loadMicrosoft.Extensions.AI.Abstractions10.Checked on a GitHub runner in a private copy of master: a merged pull request starts the job, the docs commit lands on master, and it does not start the job again.
master is protected:
REPO_TOKENis used for the push when it is set. I cannot see whether it may push to master.