Skip to content

Upgrade docfx to 2.78.5, docs target to net10, and increase docs build perf #1432

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

Open
paulirwin wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Upgrade docfx to 2.78.5, docs target to net10, and increase docs build perf #1432

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9cebb20
Upgrade docfx to 2.78.5, target net10.0 for docs, and skip restore
paulirwin Aug 5, 2026
d3aef7c
Run docfx in parallel
paulirwin Aug 5, 2026
12edc90
Build docs and website on pull requests without publishing
paulirwin Aug 9, 2026
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
2 changes: 1 addition & 1 deletion .config/dotnet-tools.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"isRoot": true,
"tools": {
"docfx": {
"version": "2.77.0",
"version": "2.78.5",
"commands": [
"docfx"
],
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/Lucene-Net-Documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ jobs:

- name: Build docs
run: ./main-repo/websites/apidocs/docs.ps1 -Clean -LuceneNetVersion ${{ env.RELEASE_VERSION }}
shell: powershell
shell: pwsh

- name: Upload apidocs as build artifact
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
Expand Down
5 changes: 3 additions & 2 deletions src/docs/LuceneDocsPlugins/AggregatePostProcessor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
using Docfx.Plugins;
using System.Collections.Immutable;
using System.Composition;
using System.Threading;

namespace LuceneDocsPlugins;

Expand All @@ -40,11 +41,11 @@ public ImmutableDictionary<string, object> PrepareMetadata(ImmutableDictionary<s
return metadata;
}

public Manifest Process(Manifest manifest, string outputFolder)
public Manifest Process(Manifest manifest, string outputFolder, CancellationToken cancellationToken)
{
foreach (var postProcessor in _postProcessors)
{
manifest = postProcessor.Process(manifest, outputFolder);
manifest = postProcessor.Process(manifest, outputFolder, cancellationToken);
}

return manifest;
Expand Down
5 changes: 4 additions & 1 deletion src/docs/LuceneDocsPlugins/EnvironmentVariableProcessor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
using System.Collections.Immutable;
using System.IO;
using System.Linq;
using System.Threading;

namespace LuceneDocsPlugins;

Expand All @@ -30,12 +31,14 @@ public ImmutableDictionary<string, object> PrepareMetadata(ImmutableDictionary<s
return metadata;
}

public Manifest Process(Manifest manifest, string outputFolder)
public Manifest Process(Manifest manifest, string outputFolder, CancellationToken cancellationToken)
{
foreach (var manifestItem in manifest.Files.Where(x => x.Type == "Conceptual"))
{
foreach (var manifestItemOutputFile in manifestItem.Output)
{
cancellationToken.ThrowIfCancellationRequested();

var outputPath = Path.Combine(outputFolder, manifestItemOutputFile.Value.RelativePath);

var content = File.ReadAllText(outputPath);
Expand Down
4 changes: 2 additions & 2 deletions src/docs/LuceneDocsPlugins/LuceneDocsPlugins.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ under the License.
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Docfx.Plugins" Version="2.77.0" />
<PackageReference Include="Docfx.Common" Version="2.77.0" />
<PackageReference Include="Docfx.Plugins" Version="2.78.5" />
<PackageReference Include="Docfx.Common" Version="2.78.5" />
<PackageReference Include="System.Composition" Version="8.0.0" />
</ItemGroup>

Expand Down
5 changes: 4 additions & 1 deletion src/docs/LuceneDocsPlugins/LuceneNoteProcessor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;
using System.Threading;

namespace LuceneDocsPlugins;

Expand All @@ -42,12 +43,14 @@ public ImmutableDictionary<string, object> PrepareMetadata(ImmutableDictionary<s
return metadata;
}

public Manifest Process(Manifest manifest, string outputFolder)
public Manifest Process(Manifest manifest, string outputFolder, CancellationToken cancellationToken)
{
foreach (var manifestItem in manifest.Files)
{
foreach (var manifestItemOutputFile in manifestItem.Output)
{
cancellationToken.ThrowIfCancellationRequested();

var outputPath = Path.Combine(outputFolder, manifestItemOutputFile.Value.RelativePath);

var content = File.ReadAllText(outputPath);
Expand Down
2 changes: 1 addition & 1 deletion websites/apidocs/docfx.analysis-common.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
],
"dest": "obj/docfx/api/analysis-common",
"properties": {
"TargetFramework": "net8.0"
"TargetFramework": "net10.0"
}
}
],
Expand Down
2 changes: 1 addition & 1 deletion websites/apidocs/docfx.analysis-kuromoji.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
],
"dest": "obj/docfx/api/analysis-kuromoji",
"properties": {
"TargetFramework": "net8.0"
"TargetFramework": "net10.0"
}
}
],
Expand Down
2 changes: 1 addition & 1 deletion websites/apidocs/docfx.analysis-morfologik.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
],
"dest": "obj/docfx/api/analysis-morfologik",
"properties": {
"TargetFramework": "net8.0"
"TargetFramework": "net10.0"
}
}
],
Expand Down
2 changes: 1 addition & 1 deletion websites/apidocs/docfx.analysis-opennlp.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
],
"dest": "obj/docfx/api/analysis-opennlp",
"properties": {
"TargetFramework": "net8.0"
"TargetFramework": "net10.0"
}
}
],
Expand Down
2 changes: 1 addition & 1 deletion websites/apidocs/docfx.analysis-phonetic.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
],
"dest": "obj/docfx/api/analysis-phonetic",
"properties": {
"TargetFramework": "net8.0"
"TargetFramework": "net10.0"
}
}
],
Expand Down
2 changes: 1 addition & 1 deletion websites/apidocs/docfx.analysis-smartcn.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
],
"dest": "obj/docfx/api/analysis-smartcn",
"properties": {
"TargetFramework": "net8.0"
"TargetFramework": "net10.0"
}
}
],
Expand Down
2 changes: 1 addition & 1 deletion websites/apidocs/docfx.analysis-stempel.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
],
"dest": "obj/docfx/api/analysis-stempel",
"properties": {
"TargetFramework": "net8.0"
"TargetFramework": "net10.0"
}
}
],
Expand Down
2 changes: 1 addition & 1 deletion websites/apidocs/docfx.benchmark.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
],
"dest": "obj/docfx/api/benchmark",
"properties": {
"TargetFramework": "net8.0"
"TargetFramework": "net10.0"
}
}
],
Expand Down
2 changes: 1 addition & 1 deletion websites/apidocs/docfx.classification.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
],
"dest": "obj/docfx/api/classification",
"properties": {
"TargetFramework": "net8.0"
"TargetFramework": "net10.0"
}
}
],
Expand Down
2 changes: 1 addition & 1 deletion websites/apidocs/docfx.codecs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
],
"dest": "obj/docfx/api/codecs",
"properties": {
"TargetFramework": "net8.0"
"TargetFramework": "net10.0"
}
}
],
Expand Down
2 changes: 1 addition & 1 deletion websites/apidocs/docfx.core.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
],
"dest": "obj/docfx/api/core",
"properties": {
"TargetFramework": "net8.0"
"TargetFramework": "net10.0"
}
}
],
Expand Down
2 changes: 1 addition & 1 deletion websites/apidocs/docfx.demo.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
],
"dest": "obj/docfx/api/demo",
"properties": {
"TargetFramework": "net8.0"
"TargetFramework": "net10.0"
}
}
],
Expand Down
2 changes: 1 addition & 1 deletion websites/apidocs/docfx.expressions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
],
"dest": "obj/docfx/api/expressions",
"properties": {
"TargetFramework": "net8.0"
"TargetFramework": "net10.0"
}
}
],
Expand Down
2 changes: 1 addition & 1 deletion websites/apidocs/docfx.facet.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
],
"dest": "obj/docfx/api/facet",
"properties": {
"TargetFramework": "net8.0"
"TargetFramework": "net10.0"
}
}
],
Expand Down
2 changes: 1 addition & 1 deletion websites/apidocs/docfx.grouping.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
],
"dest": "obj/docfx/api/grouping",
"properties": {
"TargetFramework": "net8.0"
"TargetFramework": "net10.0"
}
}
],
Expand Down
2 changes: 1 addition & 1 deletion websites/apidocs/docfx.highlighter.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
],
"dest": "obj/docfx/api/highlighter",
"properties": {
"TargetFramework": "net8.0"
"TargetFramework": "net10.0"
}
}
],
Expand Down
2 changes: 1 addition & 1 deletion websites/apidocs/docfx.icu.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
],
"dest": "obj/docfx/api/icu",
"properties": {
"TargetFramework": "net8.0"
"TargetFramework": "net10.0"
}
}
],
Expand Down
2 changes: 1 addition & 1 deletion websites/apidocs/docfx.join.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
],
"dest": "obj/docfx/api/join",
"properties": {
"TargetFramework": "net8.0"
"TargetFramework": "net10.0"
}
}
],
Expand Down
Loading