fixes metadata generation

[tibel]

Fixes #8097

The reason was an update to System.Memory in MSBuild
dotnet/msbuild#7680

[tibel]

@superyyrrzz Could you help with this, please.

[saipramod]

As I understand it, this was due to a preview version of msbuild and this affects more than just docfx i.e other tools as well. Should we not wait for the fix to msbuild as opposed to making changes to docfx or are these changes long overdue ?

[tibel]

@saipramod The change in MSBuild was released with Visual Studio 2022 17.2.6

[saipramod]

Visual Studio 2022 17.2.6

@saipramod The change in MSBuild was released with Visual Studio 2022 17.2.6

does this help - https://docs.microsoft.com/en-us/visualstudio/releases/2022/release-notes-v17.2#17.2.7 ?

[superyyrrzz]

The change looks good to me. VS17.3 has been released (https://docs.microsoft.com/en-us/visualstudio/releases/2022/release-notes). The confusion might be that 17.3 was still preview when this issue was originally raised.

[tig]

This issue is not fixed in VS2022 17.4.0 Preview 1.0:

Not sure why the MSBuild shows 17.3.0 when running 17.4.0 Preview 1.0...

I'm installing Visual Studio 2022 version 17.3.1 (not Preview) now. Will report back.

[OskarKlintrot]

@tig I assume you need to wait for a new release of DocFX to be released.

[ibruynin]

@tig I assume you need to wait for a new release of DocFX to be released.

Hi all

Is there any idea when this would roll out in an official 2.x release? Trying to build the dev branch manually now - but that's not trivial so it seems.

Thanks!

[glopesdev]

All the CI for all our docs repositories is also broken. Proposed hacks/workarounds are not scalable as they run the risk of locking builds into legacy tooling if someone forgets the fix was there.

Anyone using CI to build DocFX websites must be dealing with the same problem, and there is a high chance of some devs not even realising what is happening until it hits them.

I would say it seems like a pretty urgent situation in itself to justify a release. Hopefully we get one soon.

[ibruynin]

@glopesdev I managed to build the dev branch yesterday

Added "-skipTests" in the build.cmd file

@ECHO OFF
PUSHD %~dp0
pwsh -NoProfile -ExecutionPolicy Bypass -Command ".\build.ps1 -skipTests %*; exit $LastExitCode;"
POPD

you need VS2019, nuget, npm, pwsh (and maybe more I already forgot)

Afterwards you can copy paste docfx-dev\target\Release\docfx to your build machine

As a temp fix I marked that version in an alias to be used for now in the build definition files:

# this is our compiled version
Set-Alias -Name docfx -Value C:\tools\docfx\docfx.exe

[glopesdev]

@ibruynin thanks, it's good to know there is a way to reproduce the build.

Unfortunately, we use a GitHub Actions workflow that uses chocolatey to download docfx into the docker image, so it would still require quite a bit of hand-tweaked reworking of scripts to get something like this going.

[ibruynin]

@glopesdev tweaking the docker image might be a solution in that case

Copy the dev branch build in /app/docfx as part of the docker build

And then execute /app/docfx/docfx instead

[KalleOlaviNiemitalo]

Anyone using CI to build DocFX websites must be dealing with the same problem

The problem seems to affect metadata generation only. Using DocFX v2 to build a website from Markdown and YAML still works, even if done in CI.

[ibruynin]

@KalleOlaviNiemitalo confirmed. We have builds that don't do api doc generation and those work fine.

Even the one that does (try) api doc generation works well too, only the toc entry says "TO BE REPLACED" and that part of the generated website is useless.

[OskarKlintrot]

They just released v2.59.4 which seems to work. I ran into all the C# 10 issues so I resorted back to generate from .dll's though.