Skip to content

Support DocFX 2.64+ on all supported Unity versions - #44

Merged
NormandErwan merged 7 commits into
mainfrom
ccr-152be8c1-dynqj8
Oct 19, 2026
Merged

NormandErwan merged 7 commits into
mainfrom
ccr-152be8c1-dynqj8

Conversation

@NormandErwan

@NormandErwan NormandErwan commented Oct 18, 2026 •

Copy link
Copy Markdown
Owner

Brings the example up to date with the Unity versions supported today (6.3 LTS, 6.6) and proves which DocFX versions work, in CI.

Closes #20

Commits

Commit Change
chore: update Unity to 6000.3.26f1 ProjectVersion.txt, xref map 6000.0 → 6000.3, .csproj warning and README example paths (6.0 LTS leaves standard support in Oct 2026)
ci: test DocFX 2.60-2.81 … Build matrix, .NET 6 + 8 SDKs, --warningsAsErrors, Unity link check, deploy from one matrix job
ci(gitlab): build with Unity DLLs … GitLab job runs in the game-ci image, UNITY_MANAGED_PATH set, .NET 8 + DocFX 2.81.0, --warningsAsErrors
docs(readme): replace dead and redirected … 2 dead (404) DocFX anchors, 5 redirected DocFX/Microsoft/GitLab links
docs(readme): DocFX and Unity compatibility Compatibility table, DocFX 2.64+ / .NET SDK 8+, CS0246 troubleshooting (#28), install via dotnet tool, how to adapt the link check
docs(readme): document the Unity package layout (#20) Documentation~ at the package root, globs pointed at Runtime/
chore(renovate): keep Unity, xref map and DocFX … Regex managers + renovate: markers; groups Unity LTS, Unity Update, DocFX

Build matrix (DocFX × Unity):

DocFX Unity 6000.3.26f1 Unity 6000.6.6f1
2.60.0 ✓
2.64.0 ✓
2.77.0 ✓
2.81.0 ✓ (deployed) ✓

--warningsAsErrors plus the link check catch the failure behind #28: since DocFX 2.62.0 (dotnet/docfx#8397) missing Unity references abort the build, while 2.60/2.61 emit pages without Unity links with only warnings. The GitLab job had no Unity references at all, so it hit exactly that.

Every matrix entry must pass for the site to deploy: a red legacy entry blocks deployment on purpose.

Verification

  • Every run: step of the GitHub build job replayed locally for all 5 matrix entries: green. DocFX 2.81.0 build green at each of the 7 commits.
  • Negative controls without Unity DLLs: DocFX 2.60.0 and 2.81.0 both fail at Build. Link check fails when the expected Unity version does not match the site.
  • .NET 8 SDK alone: DocFX 2.64.0 and 2.77.0 build; DocFX 2.60.0 fails to load the project (NuGet.Frameworks), hence the .NET 6 SDK in CI.
  • GitLab pages script replayed with docker run in its own image: 0 warnings, 5 Unity links to 6000.3 docs. Not run on GitLab itself.
  • Package layout: package-shaped copy (Runtime/, Documentation~/) built with DocFX 2.81.0: 0 warnings, Unity links and namespace overwrite present.
  • README: every link checked (200, no redirect); dotnet tool update -g docfx and docfx Documentation/docfx.json --serve run.
  • Renovate: renovate-config-validator passes; renovate --platform=local --dry-run=lookup on an aged copy proposes all 12 updates in 3 branches (unity-lts, unity-update, docfx), older tested DocFX versions untouched.
  • actionlint: clean.

Known limits

  • The game-ci image suffix (-3.2.2) is not managed by Renovate; a Unity bump whose image only exists under a newer suffix fails the Renovate PR's CI.
  • README Unity headers (6000.3, 6000.6) and example paths are edited by hand when a new minor arrives.

🤖 Generated with Claude Code

https://claude.ai/code/session_01UcBPq8SrT8Z2nv2UTJxtMH

@NormandErwan
NormandErwan force-pushed the ccr-152be8c1-dynqj8 branch 2 times, most recently from 6402057 to 501520a Compare October 18, 2026 20:41
This was referenced Oct 18, 2026
6.0 LTS leaves standard support in October 2026. Xref map, csproj warning
and README example paths follow to 6000.3.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UcBPq8SrT8Z2nv2UTJxtMH
- Matrix: DocFX 2.60.0/2.64.0/2.77.0/2.81.0 on Unity 6.3, DocFX 2.81.0 on 6.6
- .NET 6 and 8 SDKs: DocFX 2.60 cannot load the project with SDK 8 alone
- Build with --warningsAsErrors; fail if Unity API links are missing
- Deploy from the DocFX 2.81.0 + Unity 6.3 build

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UcBPq8SrT8Z2nv2UTJxtMH
The job had no Unity references, so DocFX 2.62+ aborts on CS0246.
Run in unityci/editor 6000.3.26f1, point UNITY_MANAGED_PATH at its DLLs,
install .NET 8 and DocFX 2.81.0, build with --warningsAsErrors.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UcBPq8SrT8Z2nv2UTJxtMH
Two DocFX manual anchors return 404; the other DocFX, Microsoft and GitLab
links redirect to the pages now used.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UcBPq8SrT8Z2nv2UTJxtMH
- DocFX x Unity table matching the CI matrix; DocFX 2.64+ and .NET SDK 8+
- Explain the DocFX 2.62 compile-error abort and the CS0246 symptom (#28)
- Install with dotnet tool; game-ci image for GitHub and GitLab CI
- Say how to adapt the workflow's Unity link check to another project

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UcBPq8SrT8Z2nv2UTJxtMH
Documentation~ at the package root, sources and overwrite globs pointed
at Runtime/. Tested with DocFX 2.81.0 on a package-shaped copy.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UcBPq8SrT8Z2nv2UTJxtMH
- Unity LTS group: ProjectVersion.txt, game-ci image tags, xref map major.minor
- Unity Update group: the 6.6 matrix entry, from the SUPPORTED release stream
- DocFX group: the latest-DocFX entries and README row; older tested versions stay pinned
- CI lines and the README row carry `renovate:` markers the regex managers match

Verified with a local `renovate --platform=local --dry-run=lookup` on an
aged copy: all 12 occurrences get an update, in 3 branches.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UcBPq8SrT8Z2nv2UTJxtMH
@NormandErwan
NormandErwan merged commit 5819b4d into main Oct 19, 2026
6 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.

Unity package layout is incompatible

2 participants