-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Incorporate Intellisense XML into ref-assembly nuget packages #979
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.
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
Conversation
…be a good version)
/cc @mairaw, @AdamYoblick, @ahsonkhan |
…be a good version)
0bd1b2d
to
8f224b1
Compare
@dotnet/wpf-developers, this is not longer "WIP" - please review |
@AdamYoblick, you should take note about how this is done. The work for WinForms would be really simple. You shouldn't even have to create assets in the blob store - you can directly piggy-back onto the assets that we have created (it includes WinForms xml's), allow them to be unzipped by Arcade scripts under $(RepoRoot).tools\native, then merge them into your nuget package at the appropriate location. Later on, the only effort we'd have to do would be periodically updating the blob store with a new zip, then updating global.json and .props with the new (arbitrarily chosen) version numbers. |
Wooo thanks Vatsan :) adding @RussKie for visibility (Igor is a new team member working on runtime) |
Hello @vatsan-madhavan! Because this pull request has the p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (
|
@msftbot, require at least 1 sign off. |
@msftbot, require approvals from any one of the following: @vatsan-madhavan, @rladuca, @SamBent, @stevenbrix, @ryalanms |
Fixes #747
See
intellisense.md
for architecture notes.Intellisense XML's are produced in
dotnet/dotnet-api-docs
repo. They are currently not published to a Nuget package or another easily consumable artifact. Thus, the process of ingestion of these XML files is a manual one at this time.From the OPS build site at https://ops.microsoft.com/#/sites/Docs/docsets/dotnet-api-docs?tabName=builds, we obtain the latest build artifacts
Build Type = Intellisense
zip
file)Extract the zip contents and retain only the contents of
_intellisense\netcore-3.0
subfolderCompress the contents into a new zip file (typically named
dotnet-api-docs_netcoreapp3.0-0.0.0.1-win32-x86.zip
) and upload it to a blob store using Azure Storage Explorer tonetcorenativeassets
under this path:resource-packages -> external -> windows -> dotnet-api-docs_netcoreapp3.0
During build, consume this blob, unzip and incorporate into ref-assembly nuget pakcages produced out of WPF.
Q&A
Q. What happens when an intellisense XML is not found?
A. Nothing. We will silently ignore the problem and the build will succeed.
Q. Are there missing files today?
Y. Yes, WindowsBase and PresentationBuildTasks intellisense files are missing. See dotnet/dotnet-api-docs#2602
Q.. How is the zip file update? How often is it update?
A. Manually. As often as needed - typically once per major milestone or preview release.
Notes:
Microsoft.DotNet.Arcade.Wpf
packge, and flow into todotnet-wpf-int
, to build a complete set of ref-assembly packages containing intellisense information.