Skip to content

Commit 25bf56e

Browse files
authored
Create WinRT docs for New Architecture builds in CI (#14670)
## Description Makes sure we also run the task to create WinRT docs in CI with New Architecture builds. ### Type of Change - New feature (non-breaking change which adds functionality) ### Why What is the motivation for this change? Add a few sentences describing the context and overall goals of the pull request's commits. Resolves #14669 ### What Added the CreateApiDocs flag to fabric configurations to the universal matrix ## Screenshots N/A ## Testing Verified the docs became available ## Changelog Should this change be included in the release notes: _no_
1 parent be62db0 commit 25bf56e

File tree

3 files changed

+15
-7
lines changed

3 files changed

+15
-7
lines changed

.ado/jobs/universal.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
BuildConfiguration: Debug
1818
BuildPlatform: x64
1919
UseFabric: false
20+
CreateApiDocs: true
2021
- Name: X64Release
2122
BuildConfiguration: Release
2223
BuildPlatform: x64
@@ -25,7 +26,6 @@
2526
BuildConfiguration: Debug
2627
BuildPlatform: x86
2728
UseFabric: false
28-
CreateApiDocs: true
2929
- Name: X86Release
3030
BuildConfiguration: Release
3131
BuildPlatform: x86
@@ -38,6 +38,7 @@
3838
BuildConfiguration: Debug
3939
BuildPlatform: x64
4040
UseFabric: true
41+
CreateApiDocs: true
4142
- Name: X64ReleaseFabric
4243
BuildConfiguration: Release
4344
BuildPlatform: x64
@@ -73,6 +74,7 @@
7374
BuildConfiguration: Debug
7475
BuildPlatform: x64
7576
UseFabric: false
77+
CreateApiDocs: true
7678
- Name: X64Release
7779
BuildConfiguration: Release
7880
BuildPlatform: x64
@@ -81,7 +83,6 @@
8183
BuildConfiguration: Debug
8284
BuildPlatform: x86
8385
UseFabric: false
84-
CreateApiDocs: true
8586
- Name: X86Release
8687
BuildConfiguration: Release
8788
BuildPlatform: x86
@@ -98,6 +99,7 @@
9899
BuildConfiguration: Debug
99100
BuildPlatform: x64
100101
UseFabric: true
102+
CreateApiDocs: true
101103
- Name: X64ReleaseFabric
102104
BuildConfiguration: Release
103105
BuildPlatform: x64
@@ -168,9 +170,9 @@
168170

169171
- ${{ if eq(matrix.CreateApiDocs, true) }}:
170172
- powershell: |
171-
$winmd2md_url = "https://github.com/asklar/winmd2md/releases/download/v0.1.13/winmd2md.exe"
173+
$winmd2md_url = "https://github.com/asklar/winmd2md/releases/download/v0.1.16/winmd2md.exe"
172174
Invoke-WebRequest -UseBasicParsing $winmd2md_url -OutFile $env:TEMP\winmd2md.exe
173-
& $env:TEMP\winmd2md.exe /experimental /outputDirectory vnext\target\winmd2md vnext\target\x86\Debug\Microsoft.ReactNative\Microsoft.ReactNative.winmd
175+
& $env:TEMP\winmd2md.exe /experimental /outputDirectory vnext\target\winmd2md vnext\target\${{ matrix.BuildPlatform }}\${{ matrix.BuildConfiguration }}\Microsoft.ReactNative\Microsoft.ReactNative.winmd
174176
displayName: "Generate WinRT API docs"
175177
176178
- task: PublishBuildArtifacts@1
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"type": "prerelease",
3+
"comment": "Fix documentation in IReactPackageBuilderFabric",
4+
"packageName": "react-native-windows",
5+
"email": "[email protected]",
6+
"dependentChangeType": "patch"
7+
}

vnext/Microsoft.ReactNative/IReactPackageBuilderFabric.idl

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,13 @@ namespace Microsoft.ReactNative
1414

1515
[webhosthidden]
1616
[experimental]
17-
DOC_STRING("Provides ability to register custom ViewComponents when running fabric. Methods on this interface will eventually be moved onto @IReactPackageProvider once fabric ships.")
17+
DOC_STRING("Provides ability to register custom ViewComponents when running fabric.")
1818
interface IReactPackageBuilderFabric
1919
{
2020
DOC_STRING("Registers a custom native view component.")
2121
void AddViewComponent(String componentName, ReactViewComponentProvider componentProvider);
2222

23-
DOC_STRING(
24-
"Ability to load images using custom Uri protocol handlers. The provider should implement @Composition.IUriImageStreamProvider or @Composition.Experimental.IUriBrushProvider.")
23+
DOC_STRING("Ability to load images using custom Uri protocol handlers.")
2524
void AddUriImageProvider(Microsoft.ReactNative.Composition.IUriImageProvider provider);
2625
};
2726

0 commit comments

Comments
 (0)