-
Notifications
You must be signed in to change notification settings - Fork 52
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
Add Public Api Analyzers #79
Merged
Merged
Conversation
This file contains 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
aaronpowell
requested changes
Oct 9, 2024
...olkit.Hosting.Azure.StaticWebApps/Aspire.CommunityToolkit.Hosting.Azure.StaticWebApps.csproj
Outdated
Show resolved
Hide resolved
src/Aspire.CommunityToolkit.Hosting.Ollama/OllamaResourceBuilderExtensions.cs
Outdated
Show resolved
Hide resolved
Can we add to this PR guidance on how to generate/update the files when an integration is being created or edited? |
aaronpowell
approved these changes
Oct 10, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Two small nits on the doc but otherwise good to merge!
Co-authored-by: Aaron Powell <[email protected]>
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.
!!! important !!!
This branch should be based on the latest main branch changes before being merged.
Closes #61
This pull request introduces the integration of Public API Analyzers into the project, along with several related configurations and scripts. The most important changes include adding necessary imports and properties to the build files, creating new analyzer configuration files, and adding scripts and documentation for managing shipped APIs.
Integration of Public API Analyzers:
.editorconfig
: Enabled thedotnet_public_api_analyzer.require_api_files
setting.Directory.Build.props
: ImportedPublicApiAnalyzer.props
andPublicApiAnalyzer.targets
and set properties to use Public API Analyzers and treat warnings as errors. [1] [2]Directory.Packages.props
: AddedMicrosoft.CodeAnalysis.PublicApiAnalyzers
as a build dependency.Configuration files:
eng/apicompat/PublicApiAnalyzer.props
: Added configuration for Public API Analyzers, specifying warnings to be treated as errors.eng/apicompat/PublicApiAnalyzer.targets
: Defined package references and additional files required for the analyzers.Scripts and documentation:
eng/apicompat/mark-shipped.cmd
: Added a script to run themark-shipped.ps1
PowerShell script.eng/apicompat/mark-shipped.ps1
: Implemented a PowerShell script to merge shipped and unshipped API files, considering removed elements.eng/apicompat/readme.md
: Added documentation for themark-shipped
tool, explaining its usage and purpose.PR Checklist
Other information