Skip to content

Fix the API references workflow for XMLDoc2Markdown 6 - #1443

Merged
martindevans merged 5 commits into
SciSharp:masterfrom
Laurianti:fix/api-references-workflow
Sep 27, 2026
Merged

martindevans merged 5 commits into
SciSharp:masterfrom
Laurianti:fix/api-references-workflow

Conversation

@Laurianti

@Laurianti Laurianti commented Sep 26, 2026 •

Copy link
Copy Markdown
Contributor

The "Update API references" workflow fails on every approval, so docs/xmldocs has not been regenerated since October 2025.

Two problems:

  1. dotnet tool install -g XMLDoc2Markdown installs 6.0.0, whose command is xmldoc2md and which needs .NET 10. The workflow runs dotnet xmldoc2md with .NET 8 only.
  2. On a review, actions/checkout checks out the pull request's merge ref, not a branch, so git push has 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.

Before Now
dotnet-xmldoc2md does not exist Generation: 146 succeeded, 0 failed
on approval, push fails after the merge, the docs commit lands on master

The contributing guide had the same dotnet xmldoc2md command, 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 in index.md. 5.0.0 is not an option: it fails to load Microsoft.Extensions.AI.Abstractions 10.

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_TOKEN is used for the push when it is set. I cannot see whether it may push to master.

Copilot AI lite review requested due to automatic review settings September 26, 2026 05:21

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.

Copilot review overview

🟡 Changes recommended

The workflow push target and contributor documentation still need updates.

Review effort: Lite
Findings: 1 High severity

Open (1)
What changed in this PR

Updates the API-reference workflow for XMLDoc2Markdown 6 and .NET 10.

Changes:

  • Adds .NET 10 setup.
  • Invokes xmldoc2md directly.
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.

Comment thread .github/workflows/update_api_references.yml
@Laurianti
Laurianti marked this pull request as draft September 26, 2026 05:56
@martindevans

Copy link
Copy Markdown
Member

Thanks for investigating this!

@martindevans
martindevans merged commit 9af35b2 into SciSharp:master Sep 27, 2026
8 checks passed
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.

3 participants