Add extension validation step to CI #2756
Conversation
There was a problem hiding this comment.
small nit on naming: Directory.Build.targets (lowercase t)
There was a problem hiding this comment.
Can you move this to eng/build? Also recommend naming WorkerExtensions.targets or something similar - so we can put all extension related targets into it.
There was a problem hiding this comment.
For importing, in the root Directory.Build.props, add this:
<PropertyGroup>
<RepoRoot>$(MSBuildThisFileDirectory)</RepoRoot>
<EngRoot>$(RepoRoot)eng/</EngRoot>
<TargetsRoot>$(EngRoot)build/</TargetsRoot>
</PropertyGroup>You can then use $(TargetsRoot)WorkerExtensions.targets to import this file in the Directory.Build.targets you are adding.
|
|
||
| <Import Project="$(MSBuildThisFileDirectory)extensionValidation/GenerateExtensionValidationProjects.targets" /> | ||
|
|
||
| <Target Name="AddWebJobsExtensionInformation" BeforeTargets="CoreCompile" Condition="'@(WebJobsExtension)' != ''"> |
There was a problem hiding this comment.
nit: move this target into GenerateExtensionValidationProjects.targets
| </Target> | ||
|
|
||
| <Target Name="BuildGeneratedExtensionProject" AfterTargets="GenerateExtensionProject" Condition="'@(WebJobsExtension)' != ''"> | ||
| <MSBuild Projects="$(IntermediateOutputPath)\ExtensionValidation\ExtensionValidation.csproj" Targets="Restore;Build" /> |
There was a problem hiding this comment.
Small nit: use forward slashes /. Also $(IntermediateOutputPath) already includes a trailing slash.
I think we only need to restore to get the project.assets.json, correct?
| <MSBuild Projects="$(IntermediateOutputPath)\ExtensionValidation\ExtensionValidation.csproj" Targets="Restore;Build" /> | |
| <MSBuild Projects="$(IntermediateOutputPath)ExtensionValidation/ExtensionValidation.csproj" Targets="Restore" /> |
| <Target Name="GenerateExtensionProject" AfterTargets="Compile" Condition="'@(WebJobsExtension)' != ''"> | ||
| <MakeDir Directories="$(IntermediateOutputPath)ExtensionValidation" /> | ||
| <WriteLinesToFile | ||
| File="$(IntermediateOutputPath)ExtensionValidation\ExtensionValidation.csproj" |
There was a problem hiding this comment.
| File="$(IntermediateOutputPath)ExtensionValidation\ExtensionValidation.csproj" | |
| File="$(IntermediateOutputPath)ExtensionValidation/ExtensionValidation.csproj" |
| <Target Name="GenerateExtensionProject" AfterTargets="Compile" Condition="'@(WebJobsExtension)' != ''"> | ||
| <MakeDir Directories="$(IntermediateOutputPath)ExtensionValidation" /> | ||
| <WriteLinesToFile | ||
| File="$(IntermediateOutputPath)ExtensionValidation\ExtensionValidation.csproj" |
There was a problem hiding this comment.
You could pull $(IntermediateOutputPath)ExtensionValidation/ExtensionValidation.csproj into a property for re-use.
| Lines="$([System.IO.File]::ReadAllText($(_ExtensionProjectTemplate)) | ||
| .Replace('$PackageName$', '%(WebJobsExtension.Identity)') | ||
| .Replace('$PackageVersion$', '%(WebJobsExtension.Version)'))" | ||
| Overwrite="true" /> |
There was a problem hiding this comment.
This is fine for now, but we may want to do some work for incremental build support. There are a few ways to do it, but primarily you want to only write to files if their contents have actually changed. By not writing to the csproj if it has not changed, restore will no-op as it will be already up to date.
|
Closing this as we are going to split this PR into two |
Issue describing the changes in this PR
resolves #2237
Pull request checklist
release_notes.mdAdditional information
This PR introduces a target imported by each extension library that will generate a
.csprojfile referencing their respective WebJobs extension package. This will allow CI to build and restore these packages, producing aproject.assets.jsonfile that can be scanned by Component Governance. Full context in the linked issue.Important Change for Contributors
WebJobs extensions would no longer be referenced in
Properties/AssemblyInfo.cs- they have been moved to the.csprojfile of each extension as an MS Build property. To update the WebJobs extension package, please update this new MS Build property,WebJobsExtension.Testing Locally
/extensionsand build the project.bin/Debug/net8.0/ExtensionValidationto see the generated file.