feat: add .NET 9 support (And drop .NET 6 support)

filzrev · filzrev · commit 2aac9d1e1f09 · 2024-09-29T03:00:33.000+09:00
diff --git a/.github/actions/build/action.yml b/.github/actions/build/action.yml
@@ -10,7 +10,7 @@ runs:
   - uses: actions/setup-dotnet@v4
     with:
       dotnet-version: |
-        8.x
+        9.x
 
   - run: npm install
     shell: bash
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -34,9 +34,9 @@ jobs:
     - run: dotnet test -c Release -f net8.0 --no-build --collect:"XPlat Code Coverage" --consoleLoggerParameters:"Summary;Verbosity=Minimal"
       id: test-net80
 
-    - run: dotnet test -c Release -f net6.0 --no-build --collect:"XPlat Code Coverage" --consoleLoggerParameters:"Summary;Verbosity=Minimal"
+    - run: dotnet test -c Release -f net9.0 --no-build --collect:"XPlat Code Coverage" --consoleLoggerParameters:"Summary;Verbosity=Minimal"
       if: matrix.os == 'ubuntu-latest'
-      id: test-net60
+      id: test-net90
 
     - run: npm i -g @percy/cli
       if: matrix.os == 'ubuntu-latest'
@@ -74,7 +74,7 @@ jobs:
         path: /tmp/coredump*
 
     - name: Report failed tests
-      if: ${{ failure() && (steps.test-net80.outcome == 'failure' || steps.test-net60.outcome == 'failure') }}
+      if: ${{ failure() && (steps.test-net80.outcome == 'failure' || steps.test-net90.outcome == 'failure') }}
       uses: ./.github/actions/report-failed-tests
 
   publish-docs:
diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml
@@ -13,11 +13,6 @@ jobs:
     permissions:
       packages: write
     steps:
-    - uses: actions/setup-dotnet@v4
-      with:
-        dotnet-version: |
-          9.x
-
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -1,7 +1,7 @@
 <Project>
   <PropertyGroup>
     <ContinuousIntegrationBuild Condition="'$(GITHUB_ACTIONS)' == 'true'">true</ContinuousIntegrationBuild>
-    <TargetFrameworks>net6.0;net8.0</TargetFrameworks>
+    <TargetFrameworks>net8.0;net9.0</TargetFrameworks>
     <TargetFrameworks Condition="'$(DOCFX_PREVIEW_BUILD)' == 'true'">net8.0;net9.0</TargetFrameworks> 
     <LangVersion>Preview</LangVersion>
     <ImplicitUsings>enable</ImplicitUsings>
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -28,21 +28,7 @@
     <PackageVersion Include="YamlDotNet" Version="15.3.0" />
   </ItemGroup>
 
-  <ItemGroup Condition="'$(TargetFramework)' == 'net6.0'">
-    <!-- "17.3.2" is the latest compatible version for .NET 6 -->
-    <PackageVersion Include="Microsoft.Build" Version="[17.3.2]" />
-    <PackageVersion Include="Microsoft.Build.Locator" Version="1.7.8" />
-    <PackageVersion Include="Microsoft.CodeAnalysis" Version="[4.8.0]" />
-    <PackageVersion Include="Microsoft.CodeAnalysis.Common" Version="[4.8.0]" />
-    <PackageVersion Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="[4.8.0]" />
-    <PackageVersion Include="Microsoft.CodeAnalysis.CSharp" Version="[4.8.0]" />
-    <PackageVersion Include="Microsoft.CodeAnalysis.VisualBasic.Workspaces" Version="[4.8.0]" />
-    <PackageVersion Include="Microsoft.CodeAnalysis.VisualBasic" Version="[4.8.0]" />
-    <PackageVersion Include="Microsoft.CodeAnalysis.Workspaces.Common" Version="[4.8.0]" />
-    <PackageVersion Include="Microsoft.CodeAnalysis.Workspaces.MSBuild" Version="[4.8.0]" />
-  </ItemGroup>
-
-  <ItemGroup Condition="'$(TargetFramework)' != 'net6.0'">
+  <ItemGroup>
     <PackageVersion Include="Microsoft.CodeAnalysis" Version="4.11.0" />
     <PackageVersion Include="Microsoft.CodeAnalysis.Common" Version="4.11.0" />
     <PackageVersion Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="4.11.0" />
diff --git a/docs/docs/dotnet-api-docs.md b/docs/docs/dotnet-api-docs.md
@@ -87,7 +87,7 @@ If your project targets multiple target frameworks, docfx internally builds each
     }],
     "dest": "api",
     "properties": {
-      "TargetFramework": "net6.0"
+      "TargetFramework": "net8.0"
     }
   },
 }
diff --git a/docs/index.md b/docs/index.md
@@ -8,7 +8,7 @@ In this section we will build a simple documentation site on your local machine.
 
 > Prerequisites
 > - Familiarity with the command line
-> - Install [.NET SDK](https://dotnet.microsoft.com/en-us/download) 6.0 or higher
+> - Install [.NET SDK](https://dotnet.microsoft.com/en-us/download) 8.0 or higher
 
 Make sure you have [.NET SDK](https://dotnet.microsoft.com/en-us/download) installed, then open a terminal and enter the following command to install the latest docfx:
 
diff --git a/docs/tutorial/howto_build_your_own_type_of_documentation_with_custom_plug-in.md b/docs/tutorial/howto_build_your_own_type_of_documentation_with_custom_plug-in.md
@@ -15,7 +15,7 @@ Goal and limitation
 
 Preparation
 -----------
-1.  Create a new C# class library targeting `net6.0` or later.
+1.  Create a new C# class library targeting `net8.0` or later.
 
 2.  Add NuGet package reference to `System.Composition`, `Docfx.Plugins` and `Docfx.Common`.
 
diff --git a/samples/extensions/build/build.csproj b/samples/extensions/build/build.csproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net7.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
   </PropertyGroup>
diff --git a/samples/seed/dotnet/project/Project.Core/BuildFromProject.Core.csproj b/samples/seed/dotnet/project/Project.Core/BuildFromProject.Core.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <LangVersion>latest</LangVersion>
     <Nullable>enable</Nullable>
     <ImplicitUsings>enable</ImplicitUsings>
diff --git a/samples/seed/dotnet/project/Project/BuildFromProject.csproj b/samples/seed/dotnet/project/Project/BuildFromProject.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <LangVersion>latest</LangVersion>
     <Nullable>enable</Nullable>
     <ImplicitUsings>enable</ImplicitUsings>
diff --git a/samples/seed/dotnet/solution/CatLibrary.Core/CatLibrary.Core.csproj b/samples/seed/dotnet/solution/CatLibrary.Core/CatLibrary.Core.csproj
@@ -1,5 +1,5 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
   </PropertyGroup>
-</Project>
+</Project>
diff --git a/samples/seed/dotnet/solution/CatLibrary/CatLibrary.csproj b/samples/seed/dotnet/solution/CatLibrary/CatLibrary.csproj
@@ -1,6 +1,6 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
   </PropertyGroup>
   <ItemGroup>
diff --git a/src/Docfx.Dotnet/Docfx.Dotnet.csproj b/src/Docfx.Dotnet/Docfx.Dotnet.csproj
@@ -28,11 +28,6 @@
     <ProjectReference Include="..\Docfx.Plugins\Docfx.Plugins.csproj" />
   </ItemGroup>
 
-  <ItemGroup Condition="'$(TargetFramework)' == 'net6.0'">
-    <PackageReference Include="Microsoft.Build" ExcludeAssets="runtime" />
-    <PackageReference Include="Microsoft.Build.Locator" />
-  </ItemGroup>
-
   <ItemGroup>
     <PackageReference Include="System.Formats.Asn1" />
     <PackageReference Include="HtmlAgilityPack" />
diff --git a/src/Docfx.Dotnet/DotnetApiCatalog.cs b/src/Docfx.Dotnet/DotnetApiCatalog.cs
@@ -57,8 +57,6 @@ internal static async Task Exec(MetadataJsonConfig config, DotnetApiOptions opti
     {
         var stopwatch = Stopwatch.StartNew();
 
-        EnsureMSBuildLocator();
-
         try
         {
             string originalGlobalNamespaceId = VisitorHelper.GlobalNamespaceId;
@@ -116,26 +114,6 @@ void WriteYaml(string outputFolder, string id, Build.ApiPage.ApiPage apiPage)
         }
     }
 
-    private static void EnsureMSBuildLocator()
-    {
-#if NET6_0
-        try
-        {
-            if (!Microsoft.Build.Locator.MSBuildLocator.IsRegistered)
-            {
-                var vs = Microsoft.Build.Locator.MSBuildLocator.RegisterDefaults() ?? throw new Docfx.Exceptions.ExtractMetadataException(
-                    $"Cannot find a supported .NET Core SDK. Install .NET Core SDK {Environment.Version.Major}.{Environment.Version.Minor}.x to build .NET API docs.");
-
-                Logger.LogInfo($"Using {vs.Name} {vs.Version}");
-            }
-        }
-        catch (Exception e)
-        {
-            throw new Docfx.Exceptions.ExtractMetadataException(e.Message, e);
-        }
-#endif
-    }
-
     private static ExtractMetadataConfig ConvertConfig(MetadataJsonItemConfig configModel, string configDirectory, string outputDirectory)
     {
         var projects = configModel.Src;
diff --git a/src/docfx/docfx.csproj b/src/docfx/docfx.csproj
@@ -19,7 +19,7 @@
   -->
   <Target Name="RewriteDocfxTemplateFiles" AfterTargets="PackTool">
     <PropertyGroup>
-      <!-- Select first element of TargetFrameworks as template source (e.g. `net6.0` is selected when TargetFrameworks `net6.0;net7.0;net8.0`) -->
+      <!-- Select first element of TargetFrameworks as template source (e.g. `net8.0` is selected when TargetFrameworks `net8.0;9.0`) -->
       <DocfxTemplateSourceTargetFramework>$(TargetFrameworks.Split(";")[0])</DocfxTemplateSourceTargetFramework>
     </PropertyGroup>
     <!-- If TargetFramework is selected version. Rewrite template files PackagePath.-->
diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.CatException-1.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.CatException-1.verified.md
@@ -24,7 +24,6 @@ public class CatException<T> : Exception, ISerializable
 #### Inherited Members
 
 [Exception.GetBaseException\(\)](https://learn.microsoft.com/dotnet/api/system.exception.getbaseexception), 
-[Exception.GetObjectData\(SerializationInfo, StreamingContext\)](https://learn.microsoft.com/dotnet/api/system.exception.getobjectdata), 
 [Exception.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.exception.gettype), 
 [Exception.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.exception.tostring), 
 [Exception.Data](https://learn.microsoft.com/dotnet/api/system.exception.data), 
diff --git a/test/docfx.Tests/Assets/multi-frameworks-test.csproj.sample.1 b/test/docfx.Tests/Assets/multi-frameworks-test.csproj.sample.1
@@ -1,10 +1,10 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFrameworks>net6.0;netstandard2.0</TargetFrameworks>
+    <TargetFrameworks>net8.0;netstandard2.0</TargetFrameworks>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="System" />
     <Reference Include="Microsoft.CSharp" />
   </ItemGroup>
-</Project>
+</Project>
diff --git a/test/docfx.Tests/Assets/ref.csproj.sample.1 b/test/docfx.Tests/Assets/ref.csproj.sample.1
@@ -1,5 +1,5 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFrameworks>net6.0</TargetFrameworks>
+    <TargetFrameworks>net8.0</TargetFrameworks>
   </PropertyGroup>
-</Project>
+</Project>
diff --git a/test/docfx.Tests/Assets/template/plugins/plugins.csproj b/test/docfx.Tests/Assets/template/plugins/plugins.csproj
@@ -1,7 +1,7 @@
-﻿<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
diff --git a/test/docfx.Tests/Assets/test.csproj.sample.1 b/test/docfx.Tests/Assets/test.csproj.sample.1
@@ -1,11 +1,11 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFrameworks>net6.0</TargetFrameworks>
+    <TargetFrameworks>net8.0</TargetFrameworks>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
   </PropertyGroup>
   <ItemGroup>
     <ProjectReference Include="ref.csproj">
       <Name>ClassLibrary1</Name>
     </ProjectReference>
   </ItemGroup>
-</Project>
+</Project>
diff --git a/test/docfx.Tests/Assets/test.vbproj.sample.1 b/test/docfx.Tests/Assets/test.vbproj.sample.1
@@ -1,6 +1,6 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFrameworks>net6.0</TargetFrameworks>
+    <TargetFrameworks>net8.0</TargetFrameworks>
     <RootNamespace>testVBproj1</RootNamespace>
     <AssemblyName>test.sample.1</AssemblyName>
     <OptionExplicit>On</OptionExplicit>
diff --git a/test/docfx.Tests/MetadataCommandTest.cs b/test/docfx.Tests/MetadataCommandTest.cs
@@ -69,7 +69,7 @@ await DotnetApiCatalog.Exec(
             {
                 Dest = _outputFolder,
                 Src = new(new FileMappingItem(projectFile)) { Expanded = true },
-                Properties = new() { ["TargetFramework"] = "net6.0" },
+                Properties = new() { ["TargetFramework"] = "net8.0" },
             }),
             new(), Directory.GetCurrentDirectory());
 

Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ If your project targets multiple target frameworks, docfx internally builds each`
`87`	`87`	`}],`
`88`	`88`	`"dest": "api",`
`89`	`89`	`"properties": {`
`90`		`- "TargetFramework": "net6.0"`
	`90`	`+ "TargetFramework": "net8.0"`
`91`	`91`	`}`
`92`	`92`	`},`
`93`	`93`	`}`