update short name for Authoring + readme.md (#6807)

* update short name for Authoring readme.md * include packaging of Readme file * fix test failures
dotnet · Jul 3, 2023 · cf58842 · cf58842
1 parent 01946c6
commit cf58842
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 6 deletions.
diff --git a/template_feed/Microsoft.TemplateEngine.Authoring.Templates/README.md b/template_feed/Microsoft.TemplateEngine.Authoring.Templates/README.md
@@ -3,8 +3,8 @@
 The package contains the templates useful for the template authoring:
 | Template name | Short name | Description|
 |---|---|---|
+|Template Package|`templatepack`|A project for creating template package containing .NET templates.|
 |`template.json` configuration file|`template.json`|A template for template.json configuration file for .NET template.|
-|Template Package|`template-package`|A project for creating template package containing .NET templates.|
 
 The package is available for download from nuget.org.
 Please feel to contribute or provide the feedback in discussions or via opening the issue in dotnet/templating repo.
diff --git a/...ft.TemplateEngine.Authoring.Templates/content/TemplatePackage/New.Template.Package.csproj b/...ft.TemplateEngine.Authoring.Templates/content/TemplatePackage/New.Template.Package.csproj
@@ -11,14 +11,15 @@
     <PackageTags>TODO: fill the tags here</PackageTags>
     <PackageProjectUrl>TODO: include a link to an associated project, repository, or company website</PackageProjectUrl>
 
-    <!-- Keep package type as 'Template' to show the package as template package on nuget.org and make you template available in dotnet new search.-->
+    <!-- Keep package type as 'Template' to show the package as a template package on nuget.org and make your template available in dotnet new search.-->
     <PackageType>Template</PackageType>
     <TargetFramework>net8.0</TargetFramework>
     <IncludeContentInPack>true</IncludeContentInPack>
     <IncludeBuildOutput>false</IncludeBuildOutput>
     <ContentTargetFolders>content</ContentTargetFolders>
     <NoWarn>$(NoWarn);NU5128</NoWarn>
     <NoDefaultExcludes>true</NoDefaultExcludes>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <!--#if (EnableMSBuildTasks) -->
@@ -36,4 +37,8 @@
     <Compile Remove="**\*" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="" />
+  </ItemGroup>
+
 </Project>
diff --git a/...s.IntegrationTests/Snapshots/templatepack.Basic.verified/templatepack/templatepack.csproj b/...s.IntegrationTests/Snapshots/templatepack.Basic.verified/templatepack/templatepack.csproj
@@ -11,14 +11,15 @@
     <PackageTags>TODO: fill the tags here</PackageTags>
     <PackageProjectUrl>TODO: include a link to an associated project, repository, or company website</PackageProjectUrl>
 
-    <!-- Keep package type as 'Template' to show the package as template package on nuget.org and make you template available in dotnet new search.-->
+    <!-- Keep package type as 'Template' to show the package as a template package on nuget.org and make your template available in dotnet new search.-->
     <PackageType>Template</PackageType>
     <TargetFramework>net8.0</TargetFramework>
     <IncludeContentInPack>true</IncludeContentInPack>
     <IncludeBuildOutput>false</IncludeBuildOutput>
     <ContentTargetFolders>content</ContentTargetFolders>
     <NoWarn>$(NoWarn);NU5128</NoWarn>
     <NoDefaultExcludes>true</NoDefaultExcludes>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <PropertyGroup>
@@ -34,4 +35,8 @@
     <Compile Remove="**\*" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="" />
+  </ItemGroup>
+
 </Project>
diff --git a/...tes.IntegrationTests/Snapshots/templatepack.CLI.verified/templatepack/templatepack.csproj b/...tes.IntegrationTests/Snapshots/templatepack.CLI.verified/templatepack/templatepack.csproj
@@ -11,14 +11,15 @@
     <PackageTags>TODO: fill the tags here</PackageTags>
     <PackageProjectUrl>TODO: include a link to an associated project, repository, or company website</PackageProjectUrl>
 
-    <!-- Keep package type as 'Template' to show the package as template package on nuget.org and make you template available in dotnet new search.-->
+    <!-- Keep package type as 'Template' to show the package as a template package on nuget.org and make your template available in dotnet new search.-->
     <PackageType>Template</PackageType>
     <TargetFramework>net8.0</TargetFramework>
     <IncludeContentInPack>true</IncludeContentInPack>
     <IncludeBuildOutput>false</IncludeBuildOutput>
     <ContentTargetFolders>content</ContentTargetFolders>
     <NoWarn>$(NoWarn);NU5128</NoWarn>
     <NoDefaultExcludes>true</NoDefaultExcludes>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <PropertyGroup>
@@ -34,4 +35,8 @@
     <Compile Remove="**\*" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="" />
+  </ItemGroup>
+
 </Project>
diff --git a/...tionTests/Snapshots/templatepack.NoMSBuildTasks.verified/templatepack/templatepack.csproj b/...tionTests/Snapshots/templatepack.NoMSBuildTasks.verified/templatepack/templatepack.csproj
@@ -11,19 +11,24 @@
     <PackageTags>TODO: fill the tags here</PackageTags>
     <PackageProjectUrl>TODO: include a link to an associated project, repository, or company website</PackageProjectUrl>
 
-    <!-- Keep package type as 'Template' to show the package as template package on nuget.org and make you template available in dotnet new search.-->
+    <!-- Keep package type as 'Template' to show the package as a template package on nuget.org and make your template available in dotnet new search.-->
     <PackageType>Template</PackageType>
     <TargetFramework>net8.0</TargetFramework>
     <IncludeContentInPack>true</IncludeContentInPack>
     <IncludeBuildOutput>false</IncludeBuildOutput>
     <ContentTargetFolders>content</ContentTargetFolders>
     <NoWarn>$(NoWarn);NU5128</NoWarn>
     <NoDefaultExcludes>true</NoDefaultExcludes>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>
     <Content Include="content\**\*" Exclude="content\**\bin\**;content\**\obj\**" />
     <Compile Remove="**\*" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="" />
+  </ItemGroup>
+
 </Project>
diff --git a/...ationTests/Snapshots/templatepack.WithName.verified/templatepack/MyTemplatePackage.csproj b/...ationTests/Snapshots/templatepack.WithName.verified/templatepack/MyTemplatePackage.csproj
@@ -11,14 +11,15 @@
     <PackageTags>TODO: fill the tags here</PackageTags>
     <PackageProjectUrl>TODO: include a link to an associated project, repository, or company website</PackageProjectUrl>
 
-    <!-- Keep package type as 'Template' to show the package as template package on nuget.org and make you template available in dotnet new search.-->
+    <!-- Keep package type as 'Template' to show the package as a template package on nuget.org and make your template available in dotnet new search.-->
     <PackageType>Template</PackageType>
     <TargetFramework>net8.0</TargetFramework>
     <IncludeContentInPack>true</IncludeContentInPack>
     <IncludeBuildOutput>false</IncludeBuildOutput>
     <ContentTargetFolders>content</ContentTargetFolders>
     <NoWarn>$(NoWarn);NU5128</NoWarn>
     <NoDefaultExcludes>true</NoDefaultExcludes>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <PropertyGroup>
@@ -34,4 +35,8 @@
     <Compile Remove="**\*" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="" />
+  </ItemGroup>
+
 </Project>