Skip to content

CI Update - Introduce "package-provided" monikers #10646

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

Merged
merged 2 commits into from
Nov 6, 2024
Merged

Conversation

gewarren
Copy link
Contributor

@gewarren gewarren commented Nov 6, 2024

Fixes #10012

Build.Reason:Manual by Genevieve Warren
Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=473983&view=results
source_repo.branch:pp-monikers
source_repo.url:https://apidrop.visualstudio.com/_git/binaries

Summary

  • Expand down-level package APIs into "package-provided" monikers for .NET Framework 4.7-4.8.1, .NET Standard 2.0-2.1, .NET 6-9. (I didn't add .NET Framework 4.6.2 because I ran into errors in mdoc.)
  • Also adds Microsoft.Extensions.AI and Microsoft.IO.Redist packages.

Preview

Will be very hard to actually look at the diffs. Might have to make do with just looking at the previews.

FrozenDictionary<TKey,TValue> Class (System.Collections.Frozen) | Microsoft Learn

image

 Build.Reason:Manual by Genevieve Warren
 Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=473983&view=results
 source_repo.branch:pp-monikers
 source_repo.url:https://apidrop.visualstudio.com/_git/binaries

This comment was marked as outdated.

 Build.Reason:Manual by Genevieve Warren
 Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=474713&view=results
 source_repo.branch:pp-monikers
 source_repo.url:https://apidrop.visualstudio.com/_git/binaries
Copy link

Learn Build status updates of commit ad0bd38:

⚠️ Validation status: warnings

File Status Preview URL Details
xml/Microsoft.Extensions.AI/OpenAIChatClient.xml ⚠️Warning View Details
xml/Microsoft.Extensions.AI/OpenAIClientExtensions.xml ⚠️Warning View Details
xml/Microsoft.Extensions.AI/OpenAIEmbeddingGenerator.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Caching.StackExchangeRedis/RedisCacheOptions.xml ⚠️Warning View Details
xml/Microsoft.Extensions.DependencyInjection/ResilienceHttpClientBuilderExtensions.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Hosting.Internal/ConsoleLifetime.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Http.Resilience/HedgingEndpointOptions.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Http.Resilience/HttpCircuitBreakerStrategyOptions.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Http.Resilience/HttpClientHedgingResiliencePredicates.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Http.Resilience/HttpClientResiliencePredicates.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Http.Resilience/HttpHedgingStrategyOptions.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Http.Resilience/HttpRetryStrategyOptions.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Http.Resilience/HttpStandardResilienceOptions.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Http.Resilience/ResilienceHandler.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Logging.Console/ConfigurationConsoleLoggerSettings.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Logging.Console/ConsoleLoggerOptions.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Logging.Console/ConsoleLoggerProvider.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Logging.EventLog/EventLogSettings.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Logging.TraceSource/TraceSourceLoggerProvider.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Logging/ConsoleLoggerExtensions.xml ⚠️Warning View Details
xml/System.Runtime.Serialization/Formatter.xml ⚠️Warning View Details
xml/Microsoft.Extensions.DependencyInjection/DefaultServiceProviderFactory.xml 💡Suggestion View Details
xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml 💡Suggestion View Details
xml/FrameworksIndex/net-6.0-pp.xml ✅Succeeded
xml/FrameworksIndex/net-6.0.xml ✅Succeeded

This comment lists only the first 25 files in the pull request.

xml/Microsoft.Extensions.AI/OpenAIChatClient.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'OpenAI.Chat.ChatClient'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'OpenAI.OpenAIClient'.

xml/Microsoft.Extensions.AI/OpenAIClientExtensions.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'OpenAI.Chat.ChatClient'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'OpenAI.OpenAIClient'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'OpenAI.Embeddings.EmbeddingClient'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'OpenAI.OpenAIClient'.

xml/Microsoft.Extensions.AI/OpenAIEmbeddingGenerator.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'OpenAI.Embeddings.EmbeddingClient'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'OpenAI.OpenAIClient'.

xml/Microsoft.Extensions.Caching.StackExchangeRedis/RedisCacheOptions.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'StackExchange.Redis.IConnectionMultiplexer'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'StackExchange.Redis.Profiling.ProfilingSession'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'StackExchange.Redis.ConfigurationOptions'.

xml/Microsoft.Extensions.DependencyInjection/ResilienceHttpClientBuilderExtensions.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.ResiliencePipelineBuilder`1'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.ResiliencePipelineBuilder`1'.

xml/Microsoft.Extensions.Hosting.Internal/ConsoleLifetime.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Microsoft.Extensions.Hosting.Internal.ConsoleLifetime.HostOptions'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Microsoft.Extensions.Hosting.Internal.ConsoleLifetime.HostOptions'.

xml/Microsoft.Extensions.Http.Resilience/HedgingEndpointOptions.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.Timeout.TimeoutStrategyOptions.Timeout'.

xml/Microsoft.Extensions.Http.Resilience/HttpCircuitBreakerStrategyOptions.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.CircuitBreaker.CircuitBreakerStrategyOptions`1'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.CircuitBreaker.CircuitBreakerStrategyOptions`1'.

xml/Microsoft.Extensions.Http.Resilience/HttpClientHedgingResiliencePredicates.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.Outcome`1'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.Outcome`1'.

xml/Microsoft.Extensions.Http.Resilience/HttpClientResiliencePredicates.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.Outcome`1'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.Outcome`1'.

xml/Microsoft.Extensions.Http.Resilience/HttpHedgingStrategyOptions.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.Hedging.HedgingStrategyOptions`1'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.Hedging.HedgingStrategyOptions`1'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.CircuitBreaker.BrokenCircuitException'.

This comment lists only the first 25 errors (including error/warning/suggestion) in the pull request.
For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Copy link
Contributor

@terrajobst terrajobst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have diligently reviewed all 3,350 files*

*I might have skipped a few. Like about 3,349.

@gewarren gewarren merged commit 315f5b9 into main Nov 6, 2024
4 checks passed
@gewarren gewarren deleted the pp-monikers-all branch November 6, 2024 23:15
@YoshiRulz
Copy link

THANK YOU SO MUCH, this is huge for those of us still targeting .NET Standard 2.0.

@ManickaP
Copy link
Member

ManickaP commented Nov 7, 2024

Is it intentional that once I get into this "(package-provided)" docs, I cannot look up and quickly jump to APIs from in-box libraries:
image

Yes, I can do global search, but that's much less user friendly than it used to be.

@gewarren
Copy link
Contributor Author

gewarren commented Nov 7, 2024

Is it intentional that once I get into this "(package-provided)" docs, I cannot look up and quickly jump to APIs from in-box libraries:

It's an unfortunate side effect, yes, because it only searches within the selected moniker. Also if you go to the System.Net.Http namespace page for each moniker, it only shows the types that are in that moniker, not the entire namespace:

@nickwalkmsft @mtrilbybassett @huangmin-ms Any suggestions on how we could provide a better experience here? Would it be possible to combine, say, the .NET 8 and .NET 8 (package-provided) monikers into a single namespace page?

@carlossanlop
Copy link
Contributor

This is awesome. cc @ericstj @ViktorHofer

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs show some APIs added in .NET 9 preview as available in .NET 8
5 participants