Add support for specifying a readme (required).

MonoGame · Aug 19, 2024 · 78f3443 · 78f3443
1 parent 1eebfc4
commit 78f3443
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/PackContext.cs b/PackContext.cs
@@ -13,6 +13,8 @@ public class PackContext
 
     public string LicensePath { get; }
 
+    public string ReadMePath { get; }
+
     public string? RepositoryOwner { get; }
 
     public string? RepositoryUrl { get; }
@@ -27,6 +29,7 @@ public PackContext(ICakeContext context)
         CommandName = context.Argument("commandname", "X");
         ExecutableName = context.Argument("executablename", "X");
         LicensePath = context.Argument("licensepath", "");
+        ReadMePath = context.Argument("readmepath", "");
         Version = context.Argument("version", "1.0.0");
         RepositoryUrl = "X";
         IsTag = false;

diff --git a/Resources/MonoGame.Tool.X.txt b/Resources/MonoGame.Tool.X.txt
@@ -17,11 +17,13 @@
     <PackageIcon>Icon.png</PackageIcon>
     <PackageId>{CommandName}</PackageId>
     <PackageLicenseFile>{LicenseName}</PackageLicenseFile>
+    <PackageReadmeFile>{ReadMeName}</PackageReadmeFile>
     <ToolCommandName>{CommandName}</ToolCommandName>
   </PropertyGroup>
 
   <ItemGroup>
       <None Include="../{LicensePath}" Pack="true" PackagePath="" />
+      <None Include="../{ReadMePath}" Pack="true" PackagePath="" />
       <None Include="Icon.png" Pack="true" PackagePath="" />
   </ItemGroup>
 

diff --git a/Tasks/PublishPackageTask.cs b/Tasks/PublishPackageTask.cs
@@ -63,13 +63,21 @@ public override async Task RunAsync(BuildContext context)
         if (licensePath.EndsWith(".txt")) licenseName += ".txt";
         else if (licensePath.EndsWith(".md")) licenseName += ".md";
 
+        var readMePath = context.PackContext.ReadMePath;
+        var readMeName = "README";
+
+        if (readMePath.EndsWith(".txt")) readMeName += ".txt";
+        else if (readMePath.EndsWith(".md")) readMeName += ".md";
+
         var contentInclude = $"<None Include=\"binaries\\**\\*\" CopyToOutputDirectory=\"PreserveNewest\" />";
 
         var projectData = await ReadEmbeddedResourceAsync("MonoGame.Tool.X.txt");
         projectData = projectData.Replace("{X}", context.PackContext.ToolName)
                                  .Replace("{CommandName}", context.PackContext.CommandName)
                                  .Replace("{LicensePath}", context.PackContext.LicensePath)
+                                 .Replace("{ReadMePath}", context.PackContext.ReadMePath)
                                  .Replace("{LicenseName}", licenseName)
+                                 .Replace("{ReadMeName}", readMeName)
                                  .Replace("{ContentInclude}", contentInclude);
 
         string projectPath = $"{projectDir}/MonoGame.Tool.{context.PackContext.ToolName}.csproj";