CI Update - Delete old System.CommandLine APIs #12114
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Build.Reason:Manual by Genevieve Warren Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=580399&view=results source_repo.branch:SCL source_repo.url:https://apidrop.visualstudio.com/_git/binaries
Contributor
|
@@gewarren - This PR edits one or more files whose 'source of truth' for documentation is not in this repo. Please make documentation updates in the /// comments in the dotnet/runtime repo (or dotnet/extensions repo) instead. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR removes deprecated System.CommandLine API documentation published under the "system-commandline" framework moniker. The changes clean up XML documentation files by removing old API variants and obsolete framework-specific entries, keeping only the current .NET package-provided monikers (net-10.0-pp, net-8.0-pp, net-9.0-pp, netstandard-2.0-pp).
Key Changes:
- Removes framework-specific variants for the old "system-commandline" moniker across multiple types
- Deletes entire documentation files for deprecated extension classes and types
- Cleans up System.Numerics.Tensors metadata by removing unnecessary
System.Runtime.InteropServices.InAttributereferences - Removes
Indexattributes from Parameter elements throughout the codebase
Reviewed changes
Copilot reviewed 70 out of 70 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| System.Numerics.Tensors/Tensor`1.xml | Removed InAttribute from InterfaceMember references |
| System.Numerics.Tensors/TensorSpan`1.xml | Removed InAttribute from InterfaceMember references |
| System.Numerics.Tensors/ReadOnlyTensorSpan`1.xml | Removed InAttribute from InterfaceMember references |
| System.CommandLine/Symbol.xml | Removed system-commandline framework variants and obsolete members |
| System.CommandLine/RootCommand.xml | Cleaned up Parameter Index attributes |
| System.CommandLine/Option`1.xml | Removed system-commandline constructors and interface implementations |
| System.CommandLine/OptionExtensions.xml | Entire file deleted (deprecated extensions) |
| System.CommandLine/Option.xml | Removed system-commandline members and interface implementations |
| System.CommandLine/LocalizationResources.xml | Entire file deleted (old localization API) |
| System.CommandLine/IdentifierSymbol.xml | Entire file deleted (deprecated base class) |
| System.CommandLine/IConsole.xml | Entire file deleted (deprecated interface) |
| System.CommandLine/Handler.xml | Entire file deleted (deprecated handler methods) |
| System.CommandLine/DirectiveCollection.xml | Entire file deleted (deprecated directive collection) |
| System.CommandLine/ConsoleExtensions.xml | Entire file deleted (deprecated extensions) |
| System.CommandLine/CompletionSourceList.xml | Entire file deleted (deprecated completion source list) |
| System.CommandLine/CompletionSourceExtensions.xml | Removed system-commandline overloads and cleaned up parameters |
| System.CommandLine/CommandLineConfigurationException.xml | Entire file deleted (deprecated exception type) |
| System.CommandLine/CommandLineConfiguration.xml | Entire file deleted (deprecated configuration class) |
| System.CommandLine/CommandExtensions.xml | Entire file deleted (deprecated extensions) |
| System.CommandLine/Argument`1.xml | Removed system-commandline constructors and interface implementations |
| System.CommandLine/ArgumentArity.xml | Cleaned up FrameworkAlternate attributes |
| System.CommandLine.Parsing/ValidateSymbolResult`1.xml | Entire file deleted (deprecated delegate) |
| System.CommandLine.Parsing/TokenType.xml | Removed Unparsed enum value and cleaned up Directive value |
| System.CommandLine.Parsing/Token.xml | Removed system-commandline type signatures |
| System.CommandLine.Parsing/ParseError.xml | Removed system-commandline type signatures |
| System.CommandLine.Parsing/ParseArgument`1.xml | Entire file deleted (deprecated delegate) |
Member
|
@gewarren Are the warnings expected on this one? |
Contributor
Author
@BillWagner No, fixed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Build.Reason:Manual by Genevieve Warren
Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=580399&view=results
source_repo.branch:SCL
source_repo.url:https://apidrop.visualstudio.com/_git/binaries
Summary
These APIs were published under the System.CommandLine API and then never updated. The newer SCL APIs are published under the .NET (package-provided) monikers.