Skip to content
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 9 commits into from
Oct 10, 2024
Merged

Add Public Api Analyzers #79

merged 9 commits into from
Oct 10, 2024

Conversation

Alirexaa
Copy link
Member

@Alirexaa Alirexaa commented Oct 8, 2024

!!! 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 the dotnet_public_api_analyzer.require_api_files setting.
  • Directory.Build.props: Imported PublicApiAnalyzer.props and PublicApiAnalyzer.targets and set properties to use Public API Analyzers and treat warnings as errors. [1] [2]
  • Directory.Packages.props: Added Microsoft.CodeAnalysis.PublicApiAnalyzers as a build dependency.

Configuration files:

Scripts and documentation:

PR Checklist

  • Created a feature/dev branch in your fork (vs. submitting directly from a commit on main)
  • Based off latest main branch of toolkit
  • Contains NO breaking changes (one obsolete API removed)

Other information

@Alirexaa Alirexaa self-assigned this Oct 8, 2024
@Alirexaa Alirexaa temporarily deployed to github-packages October 8, 2024 19:19 — with GitHub Actions Inactive
@Alirexaa Alirexaa temporarily deployed to github-packages October 9, 2024 11:01 — with GitHub Actions Inactive
@aaronpowell
Copy link
Member

Can we add to this PR guidance on how to generate/update the files when an integration is being created or edited?

Copy link
Member

@aaronpowell aaronpowell left a 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!

@aaronpowell aaronpowell merged commit d569c50 into main Oct 10, 2024
9 checks passed
@aaronpowell aaronpowell deleted the alirexaa/public-api-analyzer branch October 10, 2024 06:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Packages should have reference to Public API analyzer
2 participants