Skip to content

Commit bca9d35

Browse files
yufeihyufeih
authored
Merge branch 'main' into fix-xml-comment-parse-behavior
2 parents b4a3a8c + 7feca8b commit bca9d35

File tree

131 files changed

+4464
-3497
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

131 files changed

+4464
-3497
lines changed

‎.github/actions/build/action.yml‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,14 @@ description: build the project
33
runs:
44
using: "composite"
55
steps:
6-
- uses: actions/setup-node@v4
6+
- uses: actions/setup-node@v6
77
with:
8-
node-version: 22
8+
node-version: 24
99

10-
- uses: actions/setup-dotnet@v4
10+
- uses: actions/setup-dotnet@v5
1111
with:
1212
dotnet-version: |
13+
10.x
1314
9.x
1415
8.x
1516

‎.github/dependabot.yml‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,22 @@ updates:
2020
- "xunit.*"
2121
- "xunit.v3"
2222
- "xunit.v3.*"
23-
- "Verify.Xunit"
24-
- "Verify.XunitV3"
23+
24+
- package-ecosystem: "nuget"
25+
target-branch: main
26+
directory: "/"
27+
schedule:
28+
interval: "monthly"
29+
allow:
30+
- dependency-name: "Verify.*"
2531

2632
- package-ecosystem: npm
2733
target-branch: main
2834
directory: "/templates"
2935
schedule:
3036
interval: daily
37+
cooldown:
38+
default-days: 14
3139
groups:
3240
typescript-eslint:
3341
patterns:

‎.github/workflows/ci.yml‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,21 @@ jobs:
3131
shell: bash
3232
working-directory: templates
3333

34-
- run: dotnet test -c Release -f net8.0 --no-build --collect:"XPlat Code Coverage" --consoleLoggerParameters:"Summary;Verbosity=Minimal"
35-
id: test-net80
34+
- run: dotnet test -c Release -f net10.0 --no-build --collect:"XPlat Code Coverage" --consoleLoggerParameters:"Summary;Verbosity=Minimal"
35+
id: test-net100
3636

3737
- run: dotnet test -c Release -f net9.0 --no-build --collect:"XPlat Code Coverage" --consoleLoggerParameters:"Summary;Verbosity=Minimal"
3838
if: matrix.os == 'ubuntu-latest'
3939
id: test-net90
4040

41+
- run: dotnet test -c Release -f net8.0 --no-build --collect:"XPlat Code Coverage" --consoleLoggerParameters:"Summary;Verbosity=Minimal"
42+
if: matrix.os == 'ubuntu-latest'
43+
id: test-net80
44+
4145
- run: npm i -g @percy/cli
4246
if: matrix.os == 'ubuntu-latest'
4347

44-
- run: percy exec -- dotnet test -c Release -f net8.0 --filter Stage=Percy --no-build --collect:"XPlat Code Coverage"
48+
- run: percy exec -- dotnet test -c Release -f net10.0 --filter Stage=Percy --no-build --collect:"XPlat Code Coverage"
4549
if: matrix.os == 'ubuntu-latest'
4650
env:
4751
PERCY_TOKEN: ${{ secrets.PERCY_TOKEN }}
@@ -55,8 +59,8 @@ jobs:
5559
- run: echo "DOTNET_DbgEnableMiniDump=1" >> $GITHUB_ENV
5660
if: matrix.os == 'ubuntu-latest'
5761

58-
- run: dotnet run -c Release --no-build -f net8.0 --project src/docfx -- docs/docfx.json
59-
- run: dotnet run -c Release --no-build -f net8.0 --project src/docfx -- samples/seed/docfx.json --output docs/_site/seed
62+
- run: dotnet run -c Release --no-build -f net10.0 --project src/docfx -- docs/docfx.json
63+
- run: dotnet run -c Release --no-build -f net10.0 --project src/docfx -- samples/seed/docfx.json --output docs/_site/seed
6064

6165
- uses: actions/upload-pages-artifact@v4
6266
if: matrix.os == 'ubuntu-latest'

‎.github/workflows/lint.yml‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,9 @@ jobs:
1919
- name: Checkout
2020
uses: actions/checkout@v5
2121

22-
- name: Setup .NET SDK
23-
uses: actions/setup-dotnet@v5
22+
- uses: actions/setup-dotnet@v5
2423
with:
25-
dotnet-version: |
26-
9.x
24+
dotnet-version: 10.x
2725

2826
- name: Run `dotnet format` command
2927
run: |

‎.github/workflows/nightly.yml‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,6 @@ jobs:
1515
permissions:
1616
packages: write
1717
steps:
18-
- uses: actions/setup-dotnet@v5
19-
with:
20-
dotnet-version: |
21-
10.x
2218

2319
- uses: actions/checkout@v5
2420
with:
@@ -34,6 +30,9 @@ jobs:
3430
- name: dotnet test
3531
run: dotnet test -c Release -f net8.0 --no-build
3632

33+
- name: dotnet test
34+
run: dotnet test -c Release -f net9.0 --no-build
35+
3736
- name: dotnet test
3837
run: dotnet test -c Release -f net10.0 --no-build
3938

‎.github/workflows/release.yml‎

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ jobs:
1616

1717
- name: dotnet publish
1818
run: |
19-
dotnet publish src/docfx -f net8.0 -c Release /p:Version=${GITHUB_REF_NAME#v} --self-contained -r win-x64 -o drop/publish/win-x64
20-
dotnet publish src/docfx -f net8.0 -c Release /p:Version=${GITHUB_REF_NAME#v} --self-contained -r linux-x64 -o drop/publish/linux-x64
21-
dotnet publish src/docfx -f net8.0 -c Release /p:Version=${GITHUB_REF_NAME#v} --self-contained -r osx-x64 -o drop/publish/osx-x64
19+
dotnet publish src/docfx -f net10.0 -c Release /p:Version=${GITHUB_REF_NAME#v} --self-contained -r win-x64 -o drop/publish/win-x64
20+
dotnet publish src/docfx -f net10.0 -c Release /p:Version=${GITHUB_REF_NAME#v} --self-contained -r linux-x64 -o drop/publish/linux-x64
21+
dotnet publish src/docfx -f net10.0 -c Release /p:Version=${GITHUB_REF_NAME#v} --self-contained -r osx-x64 -o drop/publish/osx-x64
2222
mkdir -p drop/bin
2323
2424
- run: zip -r ../../bin/docfx-win-x64-${GITHUB_REF_NAME}.zip .
@@ -41,29 +41,37 @@ jobs:
4141
sign:
4242
runs-on: windows-latest
4343
needs: build
44+
environment: nuget.org
45+
permissions:
46+
id-token: write
4447
steps:
4548
- uses: actions/setup-dotnet@v5
4649
with:
47-
dotnet-version: 8.x
50+
dotnet-version: 10.x
4851

4952
- uses: actions/download-artifact@v5
5053
with:
5154
name: nuget
5255
path: drop/nuget
5356

54-
- run: dotnet tool install --tool-path . sign --version 0.9.1-beta.24170.3
57+
# Install `Sign CLI` to use Azure Key Vault (See: https://github.com/dotnet/sign/blob/main/docs/comparisons.md)
58+
- run: dotnet tool install --tool-path . --prerelease sign
59+
60+
- uses: azure/login@v2
61+
with:
62+
allow-no-subscriptions: true
63+
client-id: ${{ secrets.SIGN_KEY_VAULT_CLIENT_ID }}
64+
tenant-id: ${{ secrets.SIGN_KEY_VAULT_TENANT_ID }}
5565

5666
- run: >
5767
./sign code azure-key-vault
5868
drop/nuget/**/*.*
5969
--description "Docfx code sign"
6070
--description-url "https://dotnet.github.io/docfx"
6171
--timestamp-url http://timestamp.digicert.com
72+
--azure-credential-type "azure-cli"
6273
--azure-key-vault-url "${{ secrets.SIGN_KEY_VAULT_URL }}"
6374
--azure-key-vault-certificate "${{ secrets.SIGN_KEY_VAULT_CERTIFICATE }}"
64-
--azure-key-vault-tenant-id "${{ secrets.SIGN_KEY_VAULT_TENANT_ID }}"
65-
--azure-key-vault-client-id "${{ secrets.SIGN_KEY_VAULT_CLIENT_ID }}"
66-
--azure-key-vault-client-secret "${{ secrets.SIGN_KEY_VAULT_CLIENT_SECRET }}"
6775
6876
- uses: actions/upload-artifact@v4
6977
with:
@@ -73,13 +81,14 @@ jobs:
7381
publish:
7482
runs-on: ubuntu-latest
7583
needs: sign
84+
environment: nuget.org
7685
permissions:
7786
contents: write
7887
id-token: write
7988
steps:
8089
- uses: actions/setup-dotnet@v5
8190
with:
82-
dotnet-version: 8.x
91+
dotnet-version: 10.x
8392

8493
- uses: actions/download-artifact@v5
8594
with:

‎.github/workflows/snapshot.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ jobs:
3434
- uses: ./.github/actions/build
3535

3636
# Update snapshots & accept changes
37-
- run: dotnet test -c Release -f net8.0 --no-build --filter Stage=Snapshot
37+
- run: dotnet test -c Release -f net10.0 --no-build --filter Stage=Snapshot
3838
working-directory: test/docfx.Snapshot.Tests
3939
env:
4040
BUILD_SERVER: false # Need to accept file changes automatically.
@@ -52,7 +52,7 @@ jobs:
5252
commit_message: 'test(snapshot): update snapshots ${{ github.sha }}'
5353

5454
# Invoke CI workflow if changes are committed.
55-
- uses: actions/github-script@v7
55+
- uses: actions/github-script@v8
5656
if: ${{ steps.auto-commit-action.outputs.changes_detected == 'true' }}
5757
with:
5858
script: |

‎Directory.Build.props‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<Project>
22
<PropertyGroup>
33
<ContinuousIntegrationBuild Condition="'$(GITHUB_ACTIONS)' == 'true'">true</ContinuousIntegrationBuild>
4-
<TargetFrameworks>net8.0;net9.0</TargetFrameworks>
5-
<TargetFrameworks Condition="'$(DOCFX_PREVIEW_BUILD)' == 'true'">net8.0;net10.0</TargetFrameworks>
4+
<TargetFrameworks>net8.0;net9.0;net10.0</TargetFrameworks>
5+
<!--<TargetFrameworks Condition="'$(DOCFX_PREVIEW_BUILD)' == 'true'">net8.0;net9.0;net10.0</TargetFrameworks>-->
66
<LangVersion>Preview</LangVersion>
77
<ImplicitUsings>enable</ImplicitUsings>
88
<SuppressNETCoreSdkPreviewMessage>true</SuppressNETCoreSdkPreviewMessage>
@@ -17,7 +17,7 @@
1717
<!--
1818
Suppress warnings similar to the following:
1919
warning NU1507: There are 2 package sources defined in your configuration.
20-
warning NU5104: A stable release of a package should not have a prerelease dependency. Either modify the version spec of dependency "PdfPig [0.1.9-alpha-20240510-d86c2, )" or update the version field in the nuspec.
20+
warning NU5104: A stable release of a package should not have a prerelease dependency.
2121
warning NU5111: The script file 'tools\.playwright\package\bin\install_media_pack.ps1' is not recognized by NuGet and hence will not be executed during installation of this package.
2222
-->
2323
<NoWarn>$(NoWarn);NU1507;NU5104;NU5111</NoWarn>

‎Directory.Packages.props‎

Lines changed: 17 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6,43 +6,36 @@
66
<ItemGroup>
77
<PackageVersion Include="HtmlAgilityPack" Version="1.12.4" />
88
<PackageVersion Include="ICSharpCode.Decompiler" Version="9.1.0.7988" />
9-
<PackageVersion Include="Jint" Version="4.4.1" />
9+
<PackageVersion Include="Jint" Version="4.4.2" />
1010
<PackageVersion Include="JsonSchema.Net" Version="7.4.0" />
11-
<PackageVersion Include="Markdig" Version="0.42.0" />
12-
<PackageVersion Include="Microsoft.Playwright" Version="1.55.0" />
11+
<PackageVersion Include="Markdig" Version="0.44.0" />
12+
<PackageVersion Include="Microsoft.Playwright" Version="1.57.0" />
1313
<PackageVersion Include="Newtonsoft.Json" Version="13.0.4" />
1414
<PackageVersion Include="OneOf" Version="3.0.271" />
1515
<PackageVersion Include="OneOf.SourceGenerator" Version="3.0.271" />
16-
<PackageVersion Include="PdfPig" Version="0.1.11" />
16+
<PackageVersion Include="PdfPig" Version="0.1.12" />
1717
<PackageVersion Include="PlantUml.Net" Version="1.4.80" />
18-
<PackageVersion Include="Spectre.Console" Version="0.52.0" />
19-
<PackageVersion Include="Spectre.Console.Cli" Version="0.52.0" />
18+
<PackageVersion Include="Spectre.Console" Version="0.53.0" />
19+
<PackageVersion Include="Spectre.Console.Cli" Version="0.53.0" />
2020
<PackageVersion Include="Stubble.Core" Version="1.10.8" />
21-
<PackageVersion Include="System.Composition" Version="9.0.10" />
21+
<PackageVersion Include="System.Composition" Version="10.0.1" />
2222
<PackageVersion Include="YamlDotNet" Version="16.3.0" />
2323
</ItemGroup>
2424

25-
<!-- TODO: Remove `Microsoft.Build` settings after `Microsoft.CodeAnalysis.Workspaces.MSBuild` dependency is updated to `5.0.0` -->
26-
<!-- .slnx solution format is supported Microsoft.Build 17.13.9 or later. -->
2725
<ItemGroup>
2826
<PackageVersion Include="Microsoft.Build" Version="[17.11.48]" Condition="'$(TargetFramework)' == 'net8.0'" />
29-
<PackageVersion Include="Microsoft.Build" Version="17.14.28" Condition="'$(TargetFramework)' != 'net8.0'" />
27+
<PackageVersion Include="Microsoft.Build" Version="[17.14.28]" Condition="'$(TargetFramework)' == 'net9.0'" />
28+
<PackageVersion Include="Microsoft.Build" Version="18.0.2" Condition="'$(TargetFramework)' != 'net8.0' AND '$(TargetFramework)' != 'net9.0'" />
3029
</ItemGroup>
3130

32-
<!-- Temporary settings to suppress NU1901 warning. -->
3331
<ItemGroup>
34-
<PackageVersion Include="Microsoft.Build.Tasks.Core" Version="[17.11.48]" Condition="'$(TargetFramework)' == 'net8.0'" />
35-
<PackageVersion Include="Microsoft.Build.Tasks.Core" Version="17.14.28" Condition="'$(TargetFramework)' != 'net8.0'" />
36-
</ItemGroup>
37-
38-
<ItemGroup>
39-
<PackageVersion Include="Microsoft.CodeAnalysis" Version="4.14.0" />
40-
<PackageVersion Include="Microsoft.CodeAnalysis.Common" Version="4.14.0" />
41-
<PackageVersion Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="4.14.0" />
42-
<PackageVersion Include="Microsoft.CodeAnalysis.CSharp" Version="4.14.0" />
43-
<PackageVersion Include="Microsoft.CodeAnalysis.VisualBasic.Workspaces" Version="4.14.0" />
44-
<PackageVersion Include="Microsoft.CodeAnalysis.VisualBasic" Version="4.14.0" />
45-
<PackageVersion Include="Microsoft.CodeAnalysis.Workspaces.Common" Version="4.14.0" />
46-
<PackageVersion Include="Microsoft.CodeAnalysis.Workspaces.MSBuild" Version="4.14.0" />
32+
<PackageVersion Include="Microsoft.CodeAnalysis" Version="5.0.0" />
33+
<PackageVersion Include="Microsoft.CodeAnalysis.Common" Version="5.0.0" />
34+
<PackageVersion Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="5.0.0" />
35+
<PackageVersion Include="Microsoft.CodeAnalysis.CSharp" Version="5.0.0" />
36+
<PackageVersion Include="Microsoft.CodeAnalysis.VisualBasic.Workspaces" Version="5.0.0" />
37+
<PackageVersion Include="Microsoft.CodeAnalysis.VisualBasic" Version="5.0.0" />
38+
<PackageVersion Include="Microsoft.CodeAnalysis.Workspaces.Common" Version="5.0.0" />
39+
<PackageVersion Include="Microsoft.CodeAnalysis.Workspaces.MSBuild" Version="5.0.0" />
4740
</ItemGroup>
4841
</Project>

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ We welcome code contributions through pull requests, issues tagged as **[`help-w
5353
5454
- Install [Visual Studio 2022 (Community or higher)](https://www.visualstudio.com/) and make sure you have the latest updates.
5555
- Install [.NET SDK](https://dotnet.microsoft.com/download/dotnet) 8.x and 9.x.
56-
- Install NodeJS (22.x.x).
56+
- Install NodeJS (24.x.x).
5757
5858
### Build and Test
5959

0 commit comments

Comments
 (0)