docfx: All builds failing without any changes

Operating System: Windows + Linux

DocFX Version Used: docfx.console v2.59.3

Template used: default

Steps to Reproduce:

Run docfx against any project.

Expected Behavior: Documentation generated.

Actual Behavior: Error / warning reported and no documentation generated. There are many files within the .csproj, and I have about 13 projects all experiencing the same issue with no explanation. These are all DevOps pipelines, and I have reproduced locally by installing the NuGet package / running DocFX generation.

Perhaps related to https://github.com/dotnet/sdk/issues/27059 - only reason I mention this is because both the argument issue and this DocFX issue began occurring on all my projects at the same time. If not this specific issue, perhaps some other change in a more recent net / msbuild version?

PS C:\Users\xxx.nuget\packages\docfx.console\2.59.3\tools> .\docfx.exe “C:\Development\xxx\docfx.json” --serve [22-08-16 12:26:44.530]Info:[MetadataCommand.ExtractMetadata]Using msbuild C:\Program Files\Microsoft Visual Studio\2022\Enterprise\MSBuild\Current\Bin as inner compiler. [22-08-16 12:26:44.758]Info:[MetadataCommand.ExtractMetadata]Loading projects… [22-08-16 12:26:46.519]Warning:MetadataCommand.ExtractMetadataWorkspace failed with: [Failure] Msbuild failed when processing the file ‘C:\Development\xxx\Localization.csproj’ with message: Method not found: ‘System.ReadOnlySpan1<Char> Microsoft.IO.Path.GetFileName(System.ReadOnlySpan1<Char>)’. [22-08-16 12:26:46.975]Warning:[MetadataCommand.ExtractMetadata]Project ‘C:\Development\xxx\Localization.csproj’ does not contain any documents.

About this issue

Original URL
State: closed
Created 2 years ago
Comments: 19 (4 by maintainers)

Most upvoted comments

Hacky fix which works for me, basically the manual version of #8135 until there’s a release containing that:

Download System.Memory NuGet package version 4.5.5
Extract lib/net461/System.Memory.dll into the docfx installation directory
Modify docfx.exe.config to add the following binding redirect:

    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
      <dependentAssembly>
        <assemblyIdentity name="System.Memory" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-4.0.1.2" newVersion="4.0.1.2" />
      </dependentAssembly>
    </assemblyBinding>

+12

jskeet on Aug 18, 2022

I think it’s fixed in #8135. Not sure if there’s any plans for a new release though. Imho it seems like an important fix to ship.

OskarKlintrot on Aug 29, 2022

FYI a new release with #8135 has been released last week: https://github.com/dotnet/docfx/releases

MihaZupan on Sep 14, 2022

I’m running into the same problem on Windows 11 and Visual Studio 2022 17.3.2. I’ve tried the following but still encountering the issue.

Anything else to try?

Hacky fix which works for me, basically the manual version of #8135 until there’s a release containing that:

Download System.Memory NuGet package version 4.5.5

Extract lib/net461/System.Memory.dll into the docfx installation directory

Modify docfx.exe.config to add the following binding redirect:
    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
      <dependentAssembly>
        <assemblyIdentity name="System.Memory" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-4.0.1.2" newVersion="4.0.1.2" />
      </dependentAssembly>
    </assemblyBinding>

ianceicys on Aug 26, 2022

@CalvinWilkinson: I just unzip the release and execute docfx.exe directly (always on a Windows box, which may make a difference).

jskeet on Aug 23, 2022