Skip to content

Use NuGet version of DocFX #2099

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bkoelman merged 1 commit into from
Oct 9, 2026
Merged

Use NuGet version of DocFX #2099

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,11 +125,8 @@ jobs:
$ErrorActionPreference = "Stop"
$PSNativeCommandUseErrorActionPreference = $true
cd docs
$zipFile = [IO.Path]::Combine($env:TEMP, 'docfx-net10-binaries.zip')
Invoke-WebRequest -Uri 'https://github.com/json-api-dotnet/docfx/raw/refs/heads/dotnet10-rtm/net10-binaries.zip' -Method 'GET' -OutFile $zipFile
Expand-Archive $zipFile -Force
& ./generate-examples.ps1
dotnet exec docfx-net10-binaries/docfx.dll docfx.json --warningsAsErrors true
dotnet docfx docfx.json --warningsAsErrors true
Copy-Item CNAME _site/CNAME
Copy-Item home/*.html _site/
Copy-Item home/*.ico _site/
Expand Down
1 change: 0 additions & 1 deletion docs/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,3 @@ api/*.yml
api/.manifest
request-examples/*.json
request-examples/*.temp
docfx-net10-binaries/
16 changes: 1 addition & 15 deletions docs/build-dev.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,6 @@ param(
$ErrorActionPreference = "Stop"
$PSNativeCommandUseErrorActionPreference = $true

# Workaround for bug at https://github.com/PowerShell/PowerShell/issues/23875#issuecomment-2672336383
$PSDefaultParameterValues['Remove-Item:ProgressAction'] = 'SilentlyContinue'

function EnsureDocfxBinaries() {
# Temporary workaround until a proper DocFX build supporting .NET 10 is available.
$zipFile = [IO.Path]::Combine($env:TEMP, 'docfx-net10-binaries.zip')

if (!(Test-Path -Path 'docfx-net10-binaries')) {
Invoke-WebRequest -Uri 'https://github.com/json-api-dotnet/docfx/raw/refs/heads/dotnet10-rtm/net10-binaries.zip' -Method 'GET' -OutFile $zipFile
Expand-Archive $zipFile -Force
}
}

function EnsureHttpServerIsInstalled {
if ((Get-Command "npm" -ErrorAction SilentlyContinue) -eq $null) {
throw "Unable to find npm in your PATH. please install Node.js first."
Expand Down Expand Up @@ -55,7 +42,6 @@ function EnsureHttpServerIsInstalled {
}
}

EnsureDocfxBinaries
EnsureHttpServerIsInstalled

if (-Not $NoBuild -Or -Not (Test-Path -Path _site)) {
Expand All @@ -69,7 +55,7 @@ if (-Not $NoBuild -Or -Not (Test-Path -Path _site)) {
dotnet tool restore

$env:DOCFX_SOURCE_BRANCH_NAME="dev"
dotnet exec docfx-net10-binaries/docfx.dll docfx.json --warningsAsErrors true
dotnet docfx docfx.json --warningsAsErrors true

Copy-Item -Force home/*.html _site/
Copy-Item -Force home/*.ico _site/
Expand Down
Loading