Skip to content

[Doc] Upgrade to Docfx 2.67.0 #6738

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
merged 12 commits into from
May 9, 2023
Merged

[Doc] Upgrade to Docfx 2.67.0 #6738

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
b1c55e2
[Doc] Upgrade to `Docfx 2.67.0`
eaba May 7, 2023
9552b60
Merge branch 'dev' into doc_fx
eaba May 7, 2023
e7fb676
`docfx.exe` to `docfx`
eaba May 7, 2023
558a3f1
Merge branch 'doc_fx' of https://github.com/eaba/akka.net into doc_fx
eaba May 7, 2023
64bccf7
fix
eaba May 7, 2023
d598251
fix
eaba May 8, 2023
92d05d8
Merge branch 'dev' into doc_fx
eaba May 8, 2023
4c672f2
fixed - removed `--warningsAsErrors`
eaba May 9, 2023
71ac1b3
fix
eaba May 9, 2023
aba9f20
Merge branch 'dev' into doc_fx
eaba May 9, 2023
99b36c3
fix - $VisualStudioVersion = "17.5.0"
eaba May 9, 2023
17538e6
Add `"warningsAsErrors": true` to `Docfx.json`
eaba May 9, 2023
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
4 changes: 3 additions & 1 deletion build.fsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -491,10 +491,12 @@ Target "DocFx" (fun _ ->
OutputDirectory = currentDirectory @@ "tools" }) "msdn.4.5.2"

let docsPath = FullName "./docs"
let docFxPath = FullName(findToolInSubPath "docfx.exe" "tools/docfx.console/tools")
let docFxPath = FullName(findToolInSubPath "docfx.exe" "tools")

let args = StringBuilder()
|> append (docsPath @@ "docfx.json" )
//|> 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 •
edited
Loading

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

//|> 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'

|> toText

Expand Down
10 changes: 4 additions & 6 deletions build.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

$IncrementalistVersion = "0.8.0";

Expand Down Expand Up @@ -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

if (!(Test-Path $DocfxExePath)) {
Write-Host "Installing Docfx..."
Invoke-Expression "&`"$NugetPath`" install docfx.console -ExcludeVersion -Version $DocfxVersion -OutputDirectory `"$ToolPath`"" | Out-Null;
if ($LASTEXITCODE -ne 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


###########################################################################
Expand Down
3 changes: 2 additions & 1 deletion docs/docfx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@
"template"
],
"postProcessors": ["ExtractSearchIndex"],
"noLangKeyword": false
"noLangKeyword": false,
"Docfx_Git_Timeout": 30000
}
}
2 changes: 1 addition & 1 deletion serve-docs.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ $env:MSBuildExtensionsPath = $MSBuildExtensionsPath;
$env:MSBuildSDKsPath = $MSBuildSDKsPath;

# Build our docs
& .\tools\docfx.console\tools\docfx @args
& .\tools\docfx @args
20 changes: 18 additions & 2 deletions src/Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<PropertyGroup>
<Copyright>Copyright © 2013-2023 Akka.NET Team</Copyright>
<Authors>Akka.NET Team</Authors>
<VersionPrefix>1.5.4</VersionPrefix>
<VersionPrefix>1.5.5</VersionPrefix>
<PackageIcon>akkalogo.png</PackageIcon>
<PackageProjectUrl>https://github.com/akkadotnet/akka.net</PackageProjectUrl>
<PackageLicenseUrl>https://github.com/akkadotnet/akka.net/blob/master/LICENSE</PackageLicenseUrl>
Expand Down Expand Up @@ -40,7 +40,23 @@
<CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
</PropertyGroup>
<PropertyGroup>
<PackageReleaseNotes>placeholder for nightlies*</PackageReleaseNotes>
<PackageReleaseNotes>[TestKit: Add new variant of `ExpectAll` that accepts predicates](https://github.com/akkadotnet/akka.net/pull/6668)
[FSharp: Downgrade FSharp to v6.0.5](https://github.com/akkadotnet/akka.net/pull/6688)
[Core: Bump Google.Protobuf from 3.22.1 to 3.22.3](https://github.com/akkadotnet/akka.net/pull/6648)
[Core: Fix ByteString to check for index bounds](https://github.com/akkadotnet/akka.net/pull/6709)
[Core: Fix ReceiveActor ReceiveAsync ReceiveTimeout bug](https://github.com/akkadotnet/akka.net/pull/6718)
[Core: Fix race condition inside FastLazy](https://github.com/akkadotnet/akka.net/pull/6707)
If you want to see the [full set of changes made in Akka.NET v1.5.5, click here](https://github.com/akkadotnet/akka.net/milestone/87?closed=1).
7 contributors since release 1.5.4
| COMMITS | LOC+ | LOC- | AUTHOR |
|---------|------|------|---------------------|
| 16 | 68 | 34 | Ebere Abanonu |
| 9 | 598 | 1053 | Simon Cropp |
| 4 | 4 | 4 | dependabot[bot] |
| 2 | 229 | 5 | Gregorius Soedharmo |
| 1 | 33 | 28 | Aaron Stannard |
| 1 | 256 | 3 | Malcolm Learner |
| 1 | 148 | 140 | Sergey Popov |</PackageReleaseNotes>
</PropertyGroup>
<!-- SourceLink support for all Akka.NET projects -->
<ItemGroup>
Expand Down