From 1101d0d30c77a02579111383af7bdd45d38ca759 Mon Sep 17 00:00:00 2001 From: Claude Date: Mon, 19 Oct 2026 12:28:11 +0000 Subject: [PATCH 1/7] chore: update Unity to 6000.3.26f1 (6.3 LTS) 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 Claude-Session: https://claude.ai/code/session_01UcBPq8SrT8Z2nv2UTJxtMH --- Documentation/DocFxForUnity.csproj | 2 +- Documentation/docfx.json | 2 +- ProjectSettings/ProjectVersion.txt | 2 +- README.md | 12 ++++++------ 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/Documentation/DocFxForUnity.csproj b/Documentation/DocFxForUnity.csproj index 64c367b..7191005 100644 --- a/Documentation/DocFxForUnity.csproj +++ b/Documentation/DocFxForUnity.csproj @@ -44,7 +44,7 @@ + Text="Unity managed DLLs not found. Set UNITY_MANAGED_PATH to your Unity installation's Managed/UnityEngine directory (e.g. /Applications/Unity/Hub/Editor/6000.3.26f1/Unity.app/Contents/Managed/UnityEngine), or install Unity Hub at its default location." /> diff --git a/Documentation/docfx.json b/Documentation/docfx.json index d557030..56cb05b 100644 --- a/Documentation/docfx.json +++ b/Documentation/docfx.json @@ -69,7 +69,7 @@ } }, "xref": [ - "https://normanderwan.github.io/UnityXrefMaps/6000.0/xrefmap.yml", + "https://normanderwan.github.io/UnityXrefMaps/6000.3/xrefmap.yml", "https://learn.microsoft.com/en-us/dotnet/.xrefmap.json" ], "dest": "../_site" diff --git a/ProjectSettings/ProjectVersion.txt b/ProjectSettings/ProjectVersion.txt index c0912af..e6134cb 100644 --- a/ProjectSettings/ProjectVersion.txt +++ b/ProjectSettings/ProjectVersion.txt @@ -1 +1 @@ -m_EditorVersion: 6000.0.73f1 +m_EditorVersion: 6000.3.26f1 diff --git a/README.md b/README.md index 2bf28ec..3163971 100644 --- a/README.md +++ b/README.md @@ -165,7 +165,7 @@ details. "xref": [ "https://normanderwan.github.io/UnityXrefMaps//xrefmap.yml" ], ``` - where `` is a Unity version in the form of `YYYY.x` (*e.g.* 2022.3, 2023.2, 6000.0). + where `` is a Unity version in the form of `YYYY.x` (*e.g.* 2022.3, 2023.2, 6000.3). ## Advanced: `UNITY_MANAGED_PATH` @@ -179,21 +179,21 @@ Point it to the `UnityEngine` subfolder inside your Unity installation's `Manage | OS | Example path | |----|-------------| -| Windows | `C:\Program Files\Unity\Hub\Editor\6000.0.73f1\Editor\Data\Managed\UnityEngine` | -| macOS | `/Applications/Unity/Hub/Editor/6000.0.73f1/Unity.app/Contents/Managed/UnityEngine` | -| Linux | `~/Unity/Hub/Editor/6000.0.73f1/Editor/Data/Managed/UnityEngine` | +| Windows | `C:\Program Files\Unity\Hub\Editor\6000.3.26f1\Editor\Data\Managed\UnityEngine` | +| macOS | `/Applications/Unity/Hub/Editor/6000.3.26f1/Unity.app/Contents/Managed/UnityEngine` | +| Linux | `~/Unity/Hub/Editor/6000.3.26f1/Editor/Data/Managed/UnityEngine` | Set it in your shell before running DocFX: ```bash # macOS / Linux -export UNITY_MANAGED_PATH="/Applications/Unity/Hub/Editor/6000.0.73f1/Unity.app/Contents/Managed/UnityEngine" +export UNITY_MANAGED_PATH="/Applications/Unity/Hub/Editor/6000.3.26f1/Unity.app/Contents/Managed/UnityEngine" docfx Documentation/docfx.json --serve ``` ```powershell # Windows (PowerShell) -$env:UNITY_MANAGED_PATH = "C:\Program Files\Unity\Hub\Editor\6000.0.73f1\Editor\Data\Managed\UnityEngine" +$env:UNITY_MANAGED_PATH = "C:\Program Files\Unity\Hub\Editor\6000.3.26f1\Editor\Data\Managed\UnityEngine" docfx Documentation/docfx.json --serve ``` From 30f57ec1f3808aa459106c7ed0922d81b04ef0a7 Mon Sep 17 00:00:00 2001 From: Claude Date: Mon, 19 Oct 2026 12:28:12 +0000 Subject: [PATCH 2/7] ci: test DocFX 2.60-2.81 across supported Unity versions - 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 Claude-Session: https://claude.ai/code/session_01UcBPq8SrT8Z2nv2UTJxtMH --- .github/workflows/documentation.yml | 45 +++++++++++++++++++++++++---- 1 file changed, 40 insertions(+), 5 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 81ffbc2..3887819 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -17,40 +17,75 @@ permissions: jobs: # Build the documentation build: + name: build (docfx ${{ matrix.docfx }}, Unity ${{ matrix.unity }}) runs-on: ubuntu-latest # DocFX v2+ is cross-platform; no longer requires Windows + strategy: + fail-fast: false + matrix: + # Every tested DocFX version on the reference Unity version, + # then the latest DocFX on every other supported Unity version. + include: + - { docfx: 2.60.0, unity: 6000.3.26f1 } + - { docfx: 2.64.0, unity: 6000.3.26f1 } + - { docfx: 2.77.0, unity: 6000.3.26f1 } + - { docfx: 2.81.0, unity: 6000.3.26f1, deploy: true } + - { docfx: 2.81.0, unity: 6000.6.6f1 } steps: - name: Checkout uses: actions/checkout@v7 # with: # submodules: true + # DocFX 2.60 cannot load the project with the .NET 8 SDK alone (NuGet.Frameworks load failure) + - name: Setup .NET + uses: actions/setup-dotnet@v4 + with: + dotnet-version: | + 6.0.x + 8.0.x + - name: Install DocFX - run: dotnet tool install -g docfx --version 2.77.0 + run: dotnet tool install -g docfx --version ${{ matrix.docfx }} - name: Cache Unity managed DLLs id: cache-unity-dlls uses: actions/cache@v6 with: path: lib/UnityEngine - key: unity-managed-dlls-6000.0.73f1-v1 + key: unity-managed-dlls-${{ matrix.unity }}-v1 - name: Extract Unity managed DLLs from game-ci image if: steps.cache-unity-dlls.outputs.cache-hit != 'true' run: | mkdir -p lib - docker create --name unity-editor unityci/editor:ubuntu-6000.0.73f1-linux-il2cpp-3.2.2 + docker create --name unity-editor unityci/editor:ubuntu-${{ matrix.unity }}-linux-il2cpp-3.2.2 docker cp unity-editor:/opt/unity/Editor/Data/Managed/UnityEngine lib/ docker rm unity-editor + - name: Use the Unity xref map of the tested version + run: | + unity='${{ matrix.unity }}' + sed -i "s#UnityXrefMaps/[0-9.]*/#UnityXrefMaps/${unity%.*}/#" Documentation/docfx.json + - name: Use README.md as index.md run: cp README.md Documentation/index.md - name: Build - run: docfx Documentation/docfx.json + run: docfx Documentation/docfx.json --warningsAsErrors + + # A build can succeed without resolving Unity types: check the generated links + - name: Check Unity API links + run: | + unity='${{ matrix.unity }}' + page=_site/api/DocFxForUnity.Player.html + for type in Object Component Behaviour MonoBehaviour AudioClip; do + grep -q "href=\"https://docs.unity3d.com/${unity%.*}/Documentation/ScriptReference/$type.html\"" $page \ + || { echo "::error::Missing link to Unity $type in $page"; exit 1; } + done # Upload the generated documentation (only on main for deployment) - name: Upload site artifact - if: github.ref == 'refs/heads/main' + if: matrix.deploy && github.ref == 'refs/heads/main' uses: actions/upload-pages-artifact@v5 with: path: _site # Must equal the 'build.dest' value in docfx.json From eacd3d75e7e41c2df3516083f562b614dccd689c Mon Sep 17 00:00:00 2001 From: Claude Date: Mon, 19 Oct 2026 12:28:12 +0000 Subject: [PATCH 3/7] ci(gitlab): build with Unity DLLs from the game-ci image 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 Claude-Session: https://claude.ai/code/session_01UcBPq8SrT8Z2nv2UTJxtMH --- .gitlab-ci.yml | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 544356d..805f79d 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,12 +1,18 @@ -image: mcr.microsoft.com/dotnet/sdk:8.0 +# The game-ci editor image ships the Unity managed DLLs that DocFX needs to resolve +# Unity types. Unity is never activated: only its files are read. +image: unityci/editor:ubuntu-6000.3.26f1-linux-il2cpp-3.2.2 pages: stage: deploy + variables: + UNITY_MANAGED_PATH: /opt/unity/Editor/Data/Managed/UnityEngine + DOTNET_ROOT: /opt/dotnet script: - - dotnet tool install -g docfx --version 2.77.0 - - export PATH="$HOME/.dotnet/tools:$PATH" + - curl -sSL https://dot.net/v1/dotnet-install.sh | bash -s -- --channel 8.0 --install-dir "$DOTNET_ROOT" + - export PATH="$DOTNET_ROOT:$HOME/.dotnet/tools:$PATH" + - dotnet tool install -g docfx --version 2.81.0 - cp README.md Documentation/index.md - - docfx Documentation/docfx.json + - docfx Documentation/docfx.json --warningsAsErrors - mv _site public artifacts: paths: From 8319eafcbbb9591c3943f4b470313b1ec6b1e2d8 Mon Sep 17 00:00:00 2001 From: Claude Date: Mon, 19 Oct 2026 12:28:12 +0000 Subject: [PATCH 4/7] docs(readme): replace dead and redirected documentation links 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 Claude-Session: https://claude.ai/code/session_01UcBPq8SrT8Z2nv2UTJxtMH --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3163971..7ea0c55 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ online: . It references both C# A ## Setup your documentation -1. [Install DocFX](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html#2-use-docfx-as-a-command-line-tool). +1. [Install DocFX](https://dotnet.github.io/docfx/index.html). 2. Copy the `Documentation/` folder to your Unity project: ```diff @@ -38,7 +38,7 @@ online: . It references both C# A ```javascript { "build": { - "globalMetadata": // Edit your documentation website info, see: https://dotnet.github.io/docfx/tutorial/docfx.exe_user_manual.html#322-reserved-metadata + "globalMetadata": // Edit your documentation website info, see: https://dotnet.github.io/docfx/reference/docfx-json-reference.html#predefined-metadata { "_appTitle": "Example Unity documentation", "_appFooter": "Example Unity documentation", @@ -52,7 +52,7 @@ online: . It references both C# A ``` It's the configuration file of your documentation. - See for more details. + See for more details. 4. Edit `Documentation/filterConfig.yml`: @@ -70,9 +70,9 @@ online: . It references both C# A ``` It tells DocFX which namespaces you want to generate the documentation. - See for more details. + See for more details. -5. Document your classes and methods. See for more details. +5. Document your classes and methods. See for more details. 6. (Optional) Add your manual pages: - Write a Markdown file for each page in `Documentation/manual/`. @@ -81,7 +81,7 @@ online: . It references both C# A 7. (Optional) Add resources such as images: - Copy them to `Documentation/resources/`. - Reference them on your docs or manual pages. - - See for more details. + - See for more details. 8. (Optional) Document your namespaces: - For each namespace, add a `Assets/Scripts/Your/Namespace1/Your.Namespace1.md` file: @@ -131,7 +131,7 @@ If you're using GitHub: If you're using GitLab, use the provided [`.gitlab-ci.yml`](https://github.com/NormandErwan/DocFxForUnity/blob/main/.gitlab-ci.yml). Generated website is pushed to a `public/` directory. See the -[GitLab Pages documentation](https://docs.gitlab.com/ee/user/project/pages/getting_started_part_four.html) for more +[GitLab Pages documentation](https://docs.gitlab.com/user/project/pages/) for more details. ## Troubleshooting / FAQ From 4858d4758be86890355ef820e5a33bd721fd382b Mon Sep 17 00:00:00 2001 From: Claude Date: Mon, 19 Oct 2026 12:28:12 +0000 Subject: [PATCH 5/7] docs(readme): DocFX and Unity compatibility - 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 Claude-Session: https://claude.ai/code/session_01UcBPq8SrT8Z2nv2UTJxtMH --- README.md | 54 +++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 43 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 7ea0c55..34e5bba 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,32 @@ online: . It references both C# A |:----------------------------------:| | [![DocFxForUnity documentation scripting API](https://normanderwan.github.io/DocFxForUnity/resources/ExampleScriptingApi.png)](https://normanderwan.github.io/DocFxForUnity/api/DocFxForUnity.Player.html) | +## Compatibility + +Every combination below is built by the [CI workflow](https://github.com/NormandErwan/DocFxForUnity/blob/main/.github/workflows/documentation.yml) on each change. + +| DocFX | Unity 6000.3 (6.3 LTS) | Unity 6000.6 (6.6) | +|-------|:----------------------:|:------------------:| +| 2.60.0 (unsupported, see below) | ✓ | | +| 2.64.0 | ✓ | | +| 2.77.0 | ✓ | | +| 2.81.0 | ✓ | ✓ | + +- Use DocFX **2.64 or later**, with the **.NET SDK 8.0 or later**. +- Since DocFX 2.62, a C# compilation error stops the build. DocFX must therefore find the Unity managed DLLs, + see [Troubleshooting](#troubleshooting--faq). DocFX 2.60 and 2.61 build without them with only warnings, and emit pages with + no link to the Unity API. +- Unity 6000.3 is the version of this example project. The CI also builds against Unity 6000.6 with its own xref + map, see [Reference another Unity version](#reference-another-unity-version). + ## Setup your documentation -1. [Install DocFX](https://dotnet.github.io/docfx/index.html). +1. Install the [.NET SDK](https://dotnet.microsoft.com/download) 8.0 or later, then [DocFX](https://dotnet.github.io/docfx/index.html): + + ```bash + dotnet tool update -g docfx + ``` + 2. Copy the `Documentation/` folder to your Unity project: ```diff @@ -125,14 +148,20 @@ If you're using GitHub: └── README.md ``` + The workflow builds every DocFX and Unity version of the [Compatibility](#compatibility) table. For your project, + keep a single entry in `jobs.build.strategy.matrix.include`, with `deploy: true` and your Unity version. + The `Check Unity API links` step reads `_site/api/DocFxForUnity.Player.html`: point it to one of your pages, or delete it. + 2. [Configure the Pages of your repository to use GitHub Actions.](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow) 3. Commit and push on the `main` branch: your documentation will be built and deployed to `https://.github.io/`. +The workflow reads the Unity managed DLLs from the public [game-ci](https://game.ci/) editor Docker image +`unityci/editor:ubuntu--linux-il2cpp-3.2.2`. Unity is never activated, so no license is needed. + If you're using GitLab, use the provided -[`.gitlab-ci.yml`](https://github.com/NormandErwan/DocFxForUnity/blob/main/.gitlab-ci.yml). -Generated website is pushed to a `public/` directory. See the -[GitLab Pages documentation](https://docs.gitlab.com/user/project/pages/) for more -details. +[`.gitlab-ci.yml`](https://github.com/NormandErwan/DocFxForUnity/blob/main/.gitlab-ci.yml). It runs in the same +game-ci image. Set its `image` to your Unity version. Generated website is pushed to a `public/` directory. See the +[GitLab Pages documentation](https://docs.gitlab.com/user/project/pages/) for more details. ## Troubleshooting / FAQ @@ -150,7 +179,7 @@ details. type: Namespace ``` -- MSBuild outputs: `Unity managed DLLs not found.` +- DocFX outputs `error CS0246: The type or namespace name 'UnityEngine' could not be found`, or MSBuild outputs `Unity managed DLLs not found.` This means DocFX could not locate Unity's managed DLLs. It looks in three places, in order: 1. The `UNITY_MANAGED_PATH` environment variable (see below). @@ -159,13 +188,16 @@ details. If Unity Hub is installed at a non-default location, or you want to target a specific Unity version, set `UNITY_MANAGED_PATH` (see *Advanced: `UNITY_MANAGED_PATH`* below). -- If you want to reference a specific version of Unity, change this line on your `docfx.json`: +### Reference another Unity version - ```json - "xref": [ "https://normanderwan.github.io/UnityXrefMaps//xrefmap.yml" ], - ``` +The links to the Unity API come from the xref map of [UnityXrefMaps](https://github.com/NormandErwan/UnityXrefMaps). +To link to the documentation of your Unity version, change this line on your `docfx.json`: + +```json +"xref": [ "https://normanderwan.github.io/UnityXrefMaps//xrefmap.yml" ], +``` - where `` is a Unity version in the form of `YYYY.x` (*e.g.* 2022.3, 2023.2, 6000.3). +where `` is a Unity version in the form of `YYYY.x` (*e.g.* 2022.3, 6000.3, 6000.6). ## Advanced: `UNITY_MANAGED_PATH` From a67d9c8e3b27fe1d52b1cda409e6fff4b8189c20 Mon Sep 17 00:00:00 2001 From: Claude Date: Mon, 19 Oct 2026 12:28:12 +0000 Subject: [PATCH 6/7] docs(readme): document the Unity package layout (#20) 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 Claude-Session: https://claude.ai/code/session_01UcBPq8SrT8Z2nv2UTJxtMH --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 34e5bba..697ccbd 100644 --- a/README.md +++ b/README.md @@ -130,6 +130,21 @@ Every combination below is built by the [CI workflow](https://github.com/Normand If you want to have a more similar look to the Unity documentation, see this UnityFX template for DocFX: . +### Unity package layout + +A [Unity package](https://docs.unity3d.com/Manual/cus-layout.html) has no `Assets/` folder. To document one: + +1. Copy the folder as `Documentation~/` at the package root: Unity ignores folders whose name ends with `~`. +2. In `Documentation~/DocFxForUnity.csproj`, point the sources to your package scripts: + + ```xml + + ``` + +3. In `Documentation~/docfx.json`, point the namespace pages under `build.overwrite[0].files` to the same folder: + `"Runtime/**/*.md"`. +4. Use `Documentation~/` instead of `Documentation/` in the commands and CI files. + ## Generate automatically your documentation If you're using GitHub: From a6b7037c699ac2e2bf19539baff107b7cb21ec82 Mon Sep 17 00:00:00 2001 From: Claude Date: Mon, 19 Oct 2026 12:28:12 +0000 Subject: [PATCH 7/7] chore(renovate): keep Unity, xref map and DocFX versions in step - 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 Claude-Session: https://claude.ai/code/session_01UcBPq8SrT8Z2nv2UTJxtMH --- .github/workflows/documentation.yml | 11 +++--- .gitlab-ci.yml | 4 +- README.md | 2 +- renovate.json | 60 +++++++++++++++++++++++++++++ 4 files changed, 69 insertions(+), 8 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 3887819..bb6c2c2 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -24,12 +24,13 @@ jobs: matrix: # Every tested DocFX version on the reference Unity version, # then the latest DocFX on every other supported Unity version. + # The `renovate:` comments tell renovate.json which values to update. include: - - { docfx: 2.60.0, unity: 6000.3.26f1 } - - { docfx: 2.64.0, unity: 6000.3.26f1 } - - { docfx: 2.77.0, unity: 6000.3.26f1 } - - { docfx: 2.81.0, unity: 6000.3.26f1, deploy: true } - - { docfx: 2.81.0, unity: 6000.6.6f1 } + - { docfx: 2.60.0, unity: 6000.3.26f1 } # renovate: unity-lts + - { docfx: 2.64.0, unity: 6000.3.26f1 } # renovate: unity-lts + - { docfx: 2.77.0, unity: 6000.3.26f1 } # renovate: unity-lts + - { docfx: 2.81.0, unity: 6000.3.26f1, deploy: true } # renovate: docfx unity-lts + - { docfx: 2.81.0, unity: 6000.6.6f1 } # renovate: docfx unity-supported steps: - name: Checkout uses: actions/checkout@v7 diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 805f79d..d1c96f0 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,6 +1,6 @@ # The game-ci editor image ships the Unity managed DLLs that DocFX needs to resolve # Unity types. Unity is never activated: only its files are read. -image: unityci/editor:ubuntu-6000.3.26f1-linux-il2cpp-3.2.2 +image: unityci/editor:ubuntu-6000.3.26f1-linux-il2cpp-3.2.2 # renovate: unity-lts pages: stage: deploy @@ -10,7 +10,7 @@ pages: script: - curl -sSL https://dot.net/v1/dotnet-install.sh | bash -s -- --channel 8.0 --install-dir "$DOTNET_ROOT" - export PATH="$DOTNET_ROOT:$HOME/.dotnet/tools:$PATH" - - dotnet tool install -g docfx --version 2.81.0 + - dotnet tool install -g docfx --version 2.81.0 # renovate: docfx - cp README.md Documentation/index.md - docfx Documentation/docfx.json --warningsAsErrors - mv _site public diff --git a/README.md b/README.md index 697ccbd..50128a5 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ Every combination below is built by the [CI workflow](https://github.com/Normand | 2.60.0 (unsupported, see below) | ✓ | | | 2.64.0 | ✓ | | | 2.77.0 | ✓ | | -| 2.81.0 | ✓ | ✓ | +| 2.81.0 | ✓ | ✓ | - Use DocFX **2.64 or later**, with the **.NET SDK 8.0 or later**. - Since DocFX 2.62, a C# compilation error stops the build. DocFX must therefore find the Unity managed DLLs, diff --git a/renovate.json b/renovate.json index 5db72dd..695245b 100644 --- a/renovate.json +++ b/renovate.json @@ -2,5 +2,65 @@ "$schema": "https://docs.renovatebot.com/renovate-schema.json", "extends": [ "config:recommended" + ], + "customManagers": [ + { + "customType": "regex", + "description": "Unity LTS version in CI files, on lines marked `# renovate: ... unity-lts`", + "managerFilePatterns": ["/^\\.github/workflows/documentation\\.yml$/", "/^\\.gitlab-ci\\.yml$/"], + "matchStrings": ["(?\\d+\\.\\d+\\.\\d+f\\d+)[^\\n]*# renovate:[^\\n]*\\bunity-lts\\b"], + "depNameTemplate": "Unity Editor", + "datasourceTemplate": "unity3d" + }, + { + "customType": "regex", + "description": "Unity Update (SUPPORTED stream) version in CI files, on lines marked `# renovate: ... unity-supported`", + "managerFilePatterns": ["/^\\.github/workflows/documentation\\.yml$/"], + "matchStrings": ["(?\\d+\\.\\d+\\.\\d+f\\d+)[^\\n]*# renovate:[^\\n]*\\bunity-supported\\b"], + "depNameTemplate": "Unity Editor (Update)", + "datasourceTemplate": "unity3d", + "registryUrlTemplate": "https://services.api.unity.com/unity/editor/release/v1/releases?stream=SUPPORTED" + }, + { + "customType": "regex", + "description": "Unity xref map of the reference Unity version", + "managerFilePatterns": ["/^Documentation/docfx\\.json$/"], + "matchStrings": ["UnityXrefMaps/(?\\d+\\.\\d+)/xrefmap\\.yml"], + "depNameTemplate": "Unity Editor", + "datasourceTemplate": "unity3d", + "versioningTemplate": "loose", + "extractVersionTemplate": "^(?\\d+\\.\\d+)\\." + }, + { + "customType": "regex", + "description": "Latest DocFX, on lines marked `# renovate: docfx`; the older tested versions stay pinned", + "managerFilePatterns": ["/^\\.github/workflows/documentation\\.yml$/", "/^\\.gitlab-ci\\.yml$/", "/^README\\.md$/"], + "matchStrings": [ + "docfx: (?\\d+\\.\\d+\\.\\d+)[^\\n]*# renovate:[^\\n]*\\bdocfx\\b", + "docfx --version (?\\d+\\.\\d+\\.\\d+) # renovate: docfx", + "\\| (?\\d+\\.\\d+\\.\\d+) " + ], + "depNameTemplate": "docfx", + "datasourceTemplate": "nuget", + "versioningTemplate": "semver" + } + ], + "packageRules": [ + { + "description": "Update Unity version, game-ci image and xref map together", + "matchDepNames": ["Unity Editor"], + "groupName": "Unity LTS" + }, + { + "description": "SUPPORTED stream releases are not flagged stable by the unity3d datasource", + "matchDepNames": ["Unity Editor (Update)"], + "groupName": "Unity Update", + "ignoreUnstable": false + }, + { + "description": "Update every latest-DocFX occurrence together", + "matchDepNames": ["docfx"], + "groupName": "DocFX" + } ] }