Skip to content

Make ProjectTemplates replacement incremental #19413

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.

Sign up for GitHub

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

Open
Clint Rutkas (crutkas) wants to merge 2 commits into
base: main
Choose a base branch
from
+441 −22
Open

Make ProjectTemplates replacement incremental #19413

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7c0660c
Make template replacement incremental
crutkas Aug 15, 2026
61d8d51
Make template incremental test portable
crutkas Aug 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 71 additions & 22 deletions src/Aspire.ProjectTemplates/Aspire.ProjectTemplates.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
<Description>Aspire Template Pack for Microsoft Template Engine</Description>
<UsingToolTemplateLocalizer>true</UsingToolTemplateLocalizer>
<NoDefaultExcludes>true</NoDefaultExcludes>
<_TemplateSourceRoot Condition="'$(_TemplateSourceRoot)' == ''">$(MSBuildThisFileDirectory)templates\</_TemplateSourceRoot>
<_ReplaceTextScriptPath Condition="'$(_ReplaceTextScriptPath)' == ''">$(RepoRoot)tools\scripts\replace-text.cs</_ReplaceTextScriptPath>
</PropertyGroup>

<PropertyGroup>
Expand All @@ -21,34 +23,34 @@

<ItemGroup>
<!-- see https://github.com/microsoft/aspire/pull/1225 -->
<None Include="templates\**\*" />
<None Include="$(_TemplateSourceRoot)**\*" />
</ItemGroup>

<ItemGroup>
<!-- Template config files: .template.config\*.json -->
<TemplateConfigFiles Include="$(MSBuildThisFileDirectory)templates\**\.template.config\*.json">
<TemplateConfigFiles Include="$(_TemplateSourceRoot)**\.template.config\*.json">
<PackagePath>content/templates/%(RecursiveDir)</PackagePath>
<DestinationFile>$(IntermediateOutputPath)content\templates\%(RecursiveDir)%(Filename)%(Extension)</DestinationFile>
</TemplateConfigFiles>

<TemplateConfigFilesObj Include="@(TemplateConfigFiles->'%(DestinationFile)')" />

<!-- Template project files: *.csproj -->
<TemplateProjectFiles Include="$(MSBuildThisFileDirectory)templates\**\*.csproj">
<TemplateProjectFiles Include="$(_TemplateSourceRoot)**\*.csproj">
<PackagePath>content/templates/%(RecursiveDir)</PackagePath>
<DestinationFile>$(IntermediateOutputPath)content\templates\%(RecursiveDir)%(Filename)%(Extension)</DestinationFile>
</TemplateProjectFiles>

<!-- Template project files: apphost.cs (singlefile only) -->
<TemplateProjectFiles Include="$(MSBuildThisFileDirectory)templates\aspire-apphost-singlefile\**\apphost.cs">
<TemplateProjectFiles Include="$(_TemplateSourceRoot)aspire-apphost-singlefile\**\apphost.cs">
<PackagePath>content/templates/aspire-apphost-singlefile/%(RecursiveDir)</PackagePath>
<DestinationFile>$(IntermediateOutputPath)content\templates\aspire-apphost-singlefile\%(RecursiveDir)%(Filename)%(Extension)</DestinationFile>
</TemplateProjectFiles>

<TemplateProjectFilesObj Include="@(TemplateProjectFiles->'%(DestinationFile)')" />

<TemplateFiles Include="$(MSBuildThisFileDirectory)templates\**\*"
Exclude="$(MSBuildThisFileDirectory)templates\**\bin\**;$(MSBuildThisFileDirectory)templates\**\obj\**;$(MSBuildThisFileDirectory)templates\**\*.csproj;$(MSBuildThisFileDirectory)templates\aspire-apphost-singlefile\**\apphost.cs">
<TemplateFiles Include="$(_TemplateSourceRoot)**\*"
Exclude="$(_TemplateSourceRoot)**\bin\**;$(_TemplateSourceRoot)**\obj\**;$(_TemplateSourceRoot)**\*.csproj;$(_TemplateSourceRoot)aspire-apphost-singlefile\**\apphost.cs;$(_TemplateSourceRoot)**\.template.config\*.json;$(_TemplateSourceRoot)**\.template.config\localize\templatestrings.*.json">
<PackagePath>content/templates/%(RecursiveDir)</PackagePath>
</TemplateFiles>

Expand All @@ -61,29 +63,28 @@
AfterTargets="Build"
DependsOnTargets="ReplacePackageVersionOnTemplates">
<ItemGroup>
<Content Include="@(TemplateFilesObj);@(TemplateProjectFilesObj)" />
<Content Include="@(TemplateFilesObj);@(TemplateConfigFilesObj);@(TemplateProjectFilesObj);@(TemplateLocalizedStringsFilesObj)" />
</ItemGroup>
</Target>

<Target Name="ReplacePackageVersionOnTemplates"
DependsOnTargets="CopyTemplatesToIntermediateOutputPath">

<Target Name="PrepareReplaceTextResponseFile">
<PropertyGroup>
<!-- Extract purely numeric portions before any '-' prerelease tag -->
<_VersionBase>$(PackageVersion.Split('-')[0])</_VersionBase>
<!-- Build major.minor version -->
<VersionMajor>$(_VersionBase.Split('.')[0])</VersionMajor>
<VersionMinor>$(_VersionBase.Split('.')[1])</VersionMinor>
<VersionMajorMinor>$(VersionMajor).$(VersionMinor)</VersionMajorMinor>
<_RspFilePath>$(IntermediateOutputPath)replace-text-args.rsp</_RspFilePath>
<_ReplaceTextScriptPath>$(RepoRoot)tools/scripts/replace-text.cs</_ReplaceTextScriptPath>
<_ReplaceTextRspFilePath>$(IntermediateOutputPath)replace-text-args.rsp</_ReplaceTextRspFilePath>
<_ReplaceTextStampPath>$(IntermediateOutputPath)replace-text.stamp</_ReplaceTextStampPath>
</PropertyGroup>

<ItemGroup>
<!-- This is defined here as these files aren't guaranteed to exist until the build has run -->
<TemplateLocalizedStringsFiles Include="$(MSBuildThisFileDirectory)templates\**\.template.config\localize\templatestrings.*.json" />
<TemplateLocalizedStringsFiles Include="$(_TemplateSourceRoot)**\.template.config\localize\templatestrings.*.json" />
<TemplateLocalizedStringsFilesDest Include="@(TemplateLocalizedStringsFiles)"
DestinationFile="$(IntermediateOutputPath)content\templates\%(RecursiveDir)%(Filename)%(Extension)" />
DestinationFile="$(IntermediateOutputPath)content\templates\%(RecursiveDir)%(Filename)%(Extension)"
PackagePath="content/templates/%(RecursiveDir)" />
<TemplateLocalizedStringsFilesObj Include="@(TemplateLocalizedStringsFilesDest->'%(DestinationFile)')" />
</ItemGroup>

Expand Down Expand Up @@ -126,31 +127,79 @@
<_RspLines Include="@(Replacements)" />
</ItemGroup>

<!-- Write the .rsp file -->
<WriteLinesToFile File="$(_RspFilePath)"
<!-- The response file captures both the source list and every replacement value. Keeping its
timestamp stable when the content is unchanged gives the replacement target one complete,
response-file-safe input for property changes. -->
<WriteLinesToFile File="$(_ReplaceTextRspFilePath)"
Lines="@(_RspLines)"
Overwrite="true"
WriteOnlyWhenDifferent="true" />

<ItemGroup>
<_ReplaceTextInputs Include="@(TemplateFiles);@(TemplateConfigFiles);@(TemplateProjectFiles);@(TemplateLocalizedStringsFiles);$(_ReplaceTextRspFilePath);$(_ReplaceTextScriptPath)" />
</ItemGroup>
</Target>

<Target Name="InvalidateReplacePackageVersionStampForMissingFiles"
DependsOnTargets="PrepareReplaceTextResponseFile">
<ItemGroup>
<_MissingReplaceTextSourceFiles Include="@(SourceFiles)" Condition="!Exists('%(Identity)')" />
</ItemGroup>

<!-- Incremental target inputs are the original templates, so explicitly invalidate the stamp
when an expected generated file is missing. -->
<Delete Files="$(_ReplaceTextStampPath)" Condition="'@(_MissingReplaceTextSourceFiles)' != ''" />
</Target>

<Target Name="ReplacePackageVersionOnTemplates"
DependsOnTargets="CopyTemplatesToIntermediateOutputPath;InvalidateReplacePackageVersionStampForMissingFiles"
Inputs="@(_ReplaceTextInputs)"
Outputs="$(_ReplaceTextStampPath)">

<!-- Replacement-owned files are recopied only when an original template, the script, or a
serialized replacement value changes. This avoids copying tokenized sources over generated
content on every ordinary Build. -->
<Copy SourceFiles="@(TemplateConfigFiles)"
DestinationFiles="@(TemplateConfigFilesObj)"
SkipUnchangedFiles="false" />
<Copy SourceFiles="@(TemplateProjectFiles)"
DestinationFiles="@(TemplateProjectFilesObj)"
SkipUnchangedFiles="false" />
<Copy SourceFiles="@(TemplateLocalizedStringsFiles)"
DestinationFiles="@(TemplateLocalizedStringsFilesObj)"
SkipUnchangedFiles="false" />

<ItemGroup>
<_MissingReplaceTextSourceFilesAfterCopy Include="@(SourceFiles)" Condition="!Exists('%(Identity)')" />
</ItemGroup>
<Error Text="Template replacement input was not generated: @(_MissingReplaceTextSourceFilesAfterCopy, ', ')"
Condition="'@(_MissingReplaceTextSourceFilesAfterCopy)' != ''" />

<!-- Execute the script with the .rsp file, using double dash to pass arguments directly to the script -->
<Exec Command="dotnet &quot;$(_ReplaceTextScriptPath)&quot; -- @&quot;$(_RspFilePath)&quot;"
<Exec Command="dotnet &quot;$(_ReplaceTextScriptPath)&quot; -- @&quot;$(_ReplaceTextRspFilePath)&quot;"
WorkingDirectory="$(MSBuildThisFileDirectory)"
StandardOutputImportance="Normal"
StandardErrorImportance="Normal" />
<Touch Files="$(_ReplaceTextStampPath)" AlwaysCreate="true" />
</Target>

<!-- Grabs the contents of the templates folder and copies them to IntermediateOutputPath directory -->
<Target Name="CopyTemplatesToIntermediateOutputPath"
Inputs="@(TemplateFiles);@(TemplateProjectFiles)"
Outputs="@(TemplateFilesObj);@(TemplateProjectFilesObj)">
Inputs="@(TemplateFiles)"
Outputs="@(TemplateFilesObj)">

<Copy SourceFiles="@(TemplateFiles)"
DestinationFiles="@(TemplateFilesObj)"
SkipUnchangedFiles="true" />
<Copy SourceFiles="@(TemplateProjectFiles)"
DestinationFiles="@(TemplateProjectFilesObj)"
SkipUnchangedFiles="true" />
</Target>

<Target Name="CleanReplacePackageVersionOnTemplates"
AfterTargets="Clean">
<PropertyGroup>
<_ReplaceTextRspFilePath>$(IntermediateOutputPath)replace-text-args.rsp</_ReplaceTextRspFilePath>
<_ReplaceTextStampPath>$(IntermediateOutputPath)replace-text.stamp</_ReplaceTextStampPath>
</PropertyGroup>
<Delete Files="$(_ReplaceTextRspFilePath);$(_ReplaceTextStampPath)" />
</Target>

<!--
Expand Down
Loading
Loading