Add analyzer template #9789
Add analyzer template #9789
Conversation
There was a problem hiding this comment.
Great!!
Do you plan to add a reference of Microsoft.Build package and add a dummy implementation? That would be likely helpfull as well.
The version of the PackageDependency can be a parameter in template (defaulting to latest current release, https://github.com/dotnet/msbuild/blob/main/eng/Versions.props#L5); the sample implementation can be part of the Microsoft.Build, added here as link - ensuring the code is up to date. Though I haven't thought about that too deeply - if it turns complicated, feel free to merge the current version and create separate workitem for improvements
template_feed/Microsoft.AnalyzerTemplate/Company.AnalyzerTemplate.csproj
Show resolved
Hide resolved
Co-authored-by: Jan Krivanek <[email protected]>
…com/YuliiaKovalova/msbuild into dev/ykovalova/add_analyzer_template
Jan, I have added package reference to Microsoft.Build |
| "type": "parameter", | ||
| "description": "Overrides the default Microsoft.Build version where analyzer's interfaces are placed", | ||
| "datatype": "text", | ||
| "defaultValue": "17.9.5", |
There was a problem hiding this comment.
Something for the future iteration - the version here should be in sync with Version.props - we can either ensure that during pcaking, or just simply ad a manual steps to our release checklist
There was a problem hiding this comment.
@GangWang01, could you take care of it? the first option is preferable. Feel free to create a separate work item for that.
There was a problem hiding this comment.
@GangWang01 - would you be able to handle #9915 as well? Feel free to contact me with any questions
There was a problem hiding this comment.
Created #9923. And self assigned with both issues.
There was a problem hiding this comment.
Something for the future iteration - the version here should be in sync with Version.props - we can either ensure that during pcaking, or just simply ad a manual steps to our release checklist
@JanKrivanek Could you give me more info how to add a manual steps to our release checklist?
There was a problem hiding this comment.
please include this info to this document
#9958
Co-authored-by: Jan Krivanek <[email protected]>
* Initial demonstration version * Make analyzer test use bootstrap properly (#9733) * Hook analyzers stats stub * Fix unit tests by explicitly opting into analysis * Disable build acceleration for MSBuild.Bootstrap * Make EndToEndTests disposable * Support running Analyzers.UnitTests from stage1 * Fix MSBuild.dll casing * Don't run netfx Analyzer.UnitTests in Windows Core builds * Fix Analyzers.UnitTests on Mac * Renaming changes * Renaming for clarity (#9754) * Removing unnecessary types * Code move * Adjust namespaces * Simplify TestEnvironments in EndToEndTests * Support for per-project configuration, Acquisition mounting, etc * Add more comments * Grace handle double initialization attempts * Fix tests * Troubleshoot test, comment * Reflect PR comments * Fix build * Fix build - proper multitargeting on core builds * Adjust API naming and exposure * Add forgotten acquisition data sending * Renaming BuildCop to BuildCheck (#9893) We decided to rename the analyzer project from BuildCop to BuildCheck. This PR is just reflecting that on the code. * Renamed a few files missed (#9900) * Add template for custom analyzers (#9789) * Run tests against just-built bootstrap environment * Reflecting PR comments * Add test without analysis * Rename tests project * Force case renaming * Simplify GlobalInstance initialization * Remove multiple registrations checking * Reflect on PR feedback * Apply suggestions from code review Co-authored-by: Mariana Dematte <[email protected]> * Reflect on PR comments * Update src/Build/BuildCheck/API/BuildAnalyzerRule.cs Co-authored-by: Farhad Alizada <[email protected]> * Reflect PR comments --------- Co-authored-by: Ladi Prosek <[email protected]> Co-authored-by: Mariana Dematte <[email protected]> Co-authored-by: YuliiaKovalova <[email protected]> Co-authored-by: Farhad Alizada <[email protected]>
Fixes #9915 Context #9789 added a template for custom analyzer. In order for that to be usable by our customers - we need to be publishing this to nuget feed along with our other binaries. So we should have the package produced from our repo - ideally as part of our build script Changes Made Create a template package project with property <GeneratePackageOnBuild>true</GeneratePackageOnBuild>that pack the templates into a nuget package when build. Add the package project in the msbuild solution in order to build the project. Testing https://dev.azure.com/devdiv/DevDiv/_build/results?buildId=9602998&view=artifacts&pathAsName=false&type=publishedArtifacts in the packageArtifacts folder. image
…in the workflow (#10345) Fixes #9923 Context #9789 added a template for custom analyzer. Microsoft.Build version specified in the template should be synced with Version.props during packing. See https://github.com/dotnet/msbuild/pull/9789/files#r1521218723 for more details. This needs to be done after #9915. Changes Made Create a workflow. When there are updates in the file Version.props, the flow will be trigger and check the version. If the version in the template is different form the VersionPrefix in the Version.props. It will create a PR to sync the version between them.
Related
#9633
Details
Add a basic content for a custom analyzer.
Given the multitude of prerequisites necessary for this operation, this template aims to simplify the process by automating the following tasks:
[MSBuild]::RegisterAnalyzer(string)from a custom .props file./lib/platform/*.dlltolib/*.dll.