Skip to content
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.

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

[Doc] Upgrade to Docfx 2.67.0 #6738

Merged
merged 12 commits into from
May 9, 2023
Merged

[Doc] Upgrade to Docfx 2.67.0 #6738

merged 12 commits into from
May 9, 2023

Conversation

eaba
Copy link
Contributor

@eaba eaba commented May 7, 2023

Fixes #6666

Changes

  • remove docfx.console

Checklist

For significant changes, please ensure that the following have been completed (delete if not relevant):

Copy link
Contributor Author

@eaba eaba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed docfx.console @Aaronontheweb

build.fsx Outdated

let args = StringBuilder()
|> append (docsPath @@ "docfx.json" )
//|> append ("--Docfx_Git_Timeout")
//|> append "30000"
|> append ("--warningsAsErrors")
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unknown option 'Docfx_Git_Timeout'

@@ -33,7 +33,7 @@ $FakeVersion = "4.63.0"
$NugetVersion = "5.8.0";
$NugetUrl = "https://dist.nuget.org/win-x86-commandline/v$NugetVersion/nuget.exe"
$ProtobufVersion = "3.21.5"
$DocfxVersion = "2.59.4"
$DocfxVersion = "2.67.0"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docfx 2.67.0

Throw "An error occured while restoring docfx.console from NuGet."
}
##Invoke-Expression "&dotnet new tool-manifest --force"
dotnet tool install docfx --version $DocfxVersion --tool-path "$ToolPath" --output "$ToolPath"
}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dotnet tool install

docs/docfx.json Show resolved Hide resolved
@eaba eaba marked this pull request as draft May 7, 2023 14:49
@eaba
Copy link
Contributor Author

eaba commented May 7, 2023

Local.....
image

@eaba
Copy link
Contributor Author

eaba commented May 7, 2023

dotnet/docfx#8676

@Aaronontheweb
Copy link
Member

dotnet/docfx#8676

I'd work around this issue and do a local install like how we do for Incrementalist:

akka.net/build.ps1

Lines 105 to 113 in c402cc7

# Make sure the Incrementalist has been installed
if (Get-Command incrementalist -ErrorAction SilentlyContinue) {
Write-Host "Found Incrementalist. Skipping install."
}
else{
$IncrementalistFolder = Join-Path $ToolPath "incrementalist"
Write-Host "Incrementalist not found. Installing to ... $IncrementalistFolder"
dotnet tool install Incrementalist.Cmd --version $IncrementalistVersion --tool-path "$IncrementalistFolder"
}

We make zero attempts at updating the existing tool - users have to delete their tools folder in the root of the Akka.NET repo and re-run the install script to upgrade. I'd do that.

build.ps1 Outdated
@@ -89,13 +89,11 @@ if (!(Test-Path $ProtobufExePath)) {
###########################################################################

# Make sure Docfx has been installed.
$DocfxExePath = Join-Path $ToolPath "docfx.console/tools/docfx.exe"
$DocfxExePath = Join-Path $ToolPath "docfx.exe"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need a sub-folder for this

@eaba eaba marked this pull request as ready for review May 9, 2023 10:06
build.fsx Outdated

let args = StringBuilder()
|> append (docsPath @@ "docfx.json" )
|> append ("--warningsAsErrors")
//|> append ("--Docfx_Git_Timeout")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aren't these the settings we're trying to turn on? And don't we want to keep --warningsAsErrors?

Copy link
Contributor Author

@eaba eaba May 9, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I turn it back, is not working. Let me try another way @Aaronontheweb

Copy link
Member

@Aaronontheweb Aaronontheweb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like you disabled the DocFx settings we wanted to turn on in this PR and warningsAsErrors

Copy link
Member

@Aaronontheweb Aaronontheweb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like you disabled the DocFx settings we wanted to turn on in this PR and warningsAsErrors

Copy link
Member

@Aaronontheweb Aaronontheweb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@Aaronontheweb Aaronontheweb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Aaronontheweb Aaronontheweb enabled auto-merge (squash) May 9, 2023 15:52
@Aaronontheweb Aaronontheweb merged commit 66f348a into akkadotnet:dev May 9, 2023
@eaba eaba deleted the doc_fx branch May 9, 2023 17:31
Arkatufus added a commit to Arkatufus/akka.net that referenced this pull request May 15, 2023
Aaronontheweb pushed a commit that referenced this pull request May 15, 2023
* Revert "[FIX][pre][code] CSS problem (#6756)"

This reverts commit 37cb4c6.

* Revert "[Doc] Upgrade to `Docfx 2.67.0` (#6738)"

This reverts commit 66f348a.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Build System]: Frequent DocFx timeouts
2 participants