Add IGenerateTools

ricaun-io · Dec 4, 2024 · b15c513 · b15c513
1 parent 3eb840e
commit b15c513
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 6 deletions.
diff --git a/Build/.nuke/build.schema.json b/Build/.nuke/build.schema.json
@@ -27,6 +27,7 @@
         "Build",
         "Clean",
         "Compile",
+        "GenerateTools",
         "GitRelease",
         "Release",
         "Sign",

diff --git a/Build/Build.cs b/Build/Build.cs
@@ -3,7 +3,7 @@
 using ricaun.Nuke;
 using ricaun.Nuke.Components;
 
-class Build : NukeBuild, IPublish, ITest //,IShowNuGetKeyVaultSign
+class Build : NukeBuild, IPublish, ITest, IGenerateTools
 {
     string ITest.TestProjectName => "Nuke.NuGetKeyVaultSignTool";
     public static int Main() => Execute<Build>(x => x.From<IPublish>().Build);

diff --git a/Build/Build.csproj b/Build/Build.csproj
@@ -11,6 +11,7 @@
 
   <ItemGroup>
     <PackageReference Include="ricaun.Nuke" Version="*" />
+    <PackageReference Include="Nuke.Tooling.Generator" Version="8.*" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/Build/IGenerateTools.cs b/Build/IGenerateTools.cs
@@ -0,0 +1,27 @@
+using Nuke.Common;
+using Nuke.Common.IO;
+using Nuke.Common.Utilities.Collections;
+using ricaun.Nuke.Components;
+using static Nuke.CodeGeneration.CodeGenerator;
+
+using Nuke.Common.Tools.GitHub;
+
+public interface IGenerateTools : IClean, ICompile, IHazMainProject, IHazGitRepository
+{
+    AbsolutePath SpecificationsDirectory => MainProject.Directory / "Tools";
+    Target GenerateTools => _ => _
+        .TriggeredBy(Clean)
+        .Before(Compile)
+        .Executes(() =>
+        {
+            SpecificationsDirectory.GlobFiles("*.json").ForEach(x =>
+            {
+                Serilog.Log.Information($"GenerateCode: {x.Name}");
+                GenerateCode(
+                    x,
+                    namespaceProvider: x => $"Nuke.Common.Tools.{x.Name}",
+                    sourceFileProvider: x => GitRepository.GetGitHubBrowseUrl(x.SpecificationFile)
+                );
+            });
+        });
+}
diff --git a/Nuke.NuGetKeyVaultSignTool/Tools/NuGetKeyVaultSignTool.Generated.cs b/Nuke.NuGetKeyVaultSignTool/Tools/NuGetKeyVaultSignTool.Generated.cs
@@ -17,7 +17,7 @@
 namespace Nuke.Common.Tools.NuGetKeyVaultSignTool;
 
 /// <summary>
-///   <p>Azure Sign Tool is similar to <c>signtool</c> in the Windows SDK, with the major difference being that it uses Azure Key Vault for performing the signing process. The usage is like <c>signtool</c>, except with a limited set of options for signing and options for authenticating to Azure Key Vault.</p>
+///   <p>NuGet Key Vault Sign Tool is similar to <c>nuget sign</c>, with the major difference being that it uses Azure Key Vault for performing the signing process. Similar usage configuration like <c>AzureSignTool</c>, except is used to sign nuget package.</p>
 ///   <p>For more details, visit the <a href="https://github.com/novotnyllc/NuGetKeyVaultSignTool">official website</a>.</p>
 /// </summary>
 [PublicAPI]
@@ -36,7 +36,7 @@ public partial class NuGetKeyVaultSignToolTasks
     public static Action<OutputType, string> NuGetKeyVaultSignToolLogger { get; set; } = ProcessTasks.DefaultLogger;
     public static Action<ToolSettings, IProcess> NuGetKeyVaultSignToolExitHandler { get; set; } = ProcessTasks.DefaultExitHandler;
     /// <summary>
-    ///   <p>Azure Sign Tool is similar to <c>signtool</c> in the Windows SDK, with the major difference being that it uses Azure Key Vault for performing the signing process. The usage is like <c>signtool</c>, except with a limited set of options for signing and options for authenticating to Azure Key Vault.</p>
+    ///   <p>NuGet Key Vault Sign Tool is similar to <c>nuget sign</c>, with the major difference being that it uses Azure Key Vault for performing the signing process. Similar usage configuration like <c>AzureSignTool</c>, except is used to sign nuget package.</p>
     ///   <p>For more details, visit the <a href="https://github.com/novotnyllc/NuGetKeyVaultSignTool">official website</a>.</p>
     /// </summary>
     public static IReadOnlyCollection<Output> NuGetKeyVaultSignTool(ArgumentStringHandler arguments, string workingDirectory = null, IReadOnlyDictionary<string, string> environmentVariables = null, int? timeout = null, bool? logOutput = null, bool? logInvocation = null, Action<OutputType, string> logger = null, Action<IProcess> exitHandler = null)
@@ -46,7 +46,7 @@ public static IReadOnlyCollection<Output> NuGetKeyVaultSignTool(ArgumentStringHa
         return process.Output;
     }
     /// <summary>
-    ///   <p>Azure Sign Tool is similar to <c>signtool</c> in the Windows SDK, with the major difference being that it uses Azure Key Vault for performing the signing process. The usage is like <c>signtool</c>, except with a limited set of options for signing and options for authenticating to Azure Key Vault.</p>
+    ///   <p>NuGet Key Vault Sign Tool is similar to <c>nuget sign</c>, with the major difference being that it uses Azure Key Vault for performing the signing process. Similar usage configuration like <c>AzureSignTool</c>, except is used to sign nuget package.</p>
     ///   <p>For more details, visit the <a href="https://github.com/novotnyllc/NuGetKeyVaultSignTool">official website</a>.</p>
     /// </summary>
     /// <remarks>
@@ -75,7 +75,7 @@ public static IReadOnlyCollection<Output> NuGetKeyVaultSignTool(NuGetKeyVaultSig
         return process.Output;
     }
     /// <summary>
-    ///   <p>Azure Sign Tool is similar to <c>signtool</c> in the Windows SDK, with the major difference being that it uses Azure Key Vault for performing the signing process. The usage is like <c>signtool</c>, except with a limited set of options for signing and options for authenticating to Azure Key Vault.</p>
+    ///   <p>NuGet Key Vault Sign Tool is similar to <c>nuget sign</c>, with the major difference being that it uses Azure Key Vault for performing the signing process. Similar usage configuration like <c>AzureSignTool</c>, except is used to sign nuget package.</p>
     ///   <p>For more details, visit the <a href="https://github.com/novotnyllc/NuGetKeyVaultSignTool">official website</a>.</p>
     /// </summary>
     /// <remarks>
@@ -101,7 +101,7 @@ public static IReadOnlyCollection<Output> NuGetKeyVaultSignTool(Configure<NuGetK
         return NuGetKeyVaultSignTool(configurator(new NuGetKeyVaultSignToolSettings()));
     }
     /// <summary>
-    ///   <p>Azure Sign Tool is similar to <c>signtool</c> in the Windows SDK, with the major difference being that it uses Azure Key Vault for performing the signing process. The usage is like <c>signtool</c>, except with a limited set of options for signing and options for authenticating to Azure Key Vault.</p>
+    ///   <p>NuGet Key Vault Sign Tool is similar to <c>nuget sign</c>, with the major difference being that it uses Azure Key Vault for performing the signing process. Similar usage configuration like <c>AzureSignTool</c>, except is used to sign nuget package.</p>
     ///   <p>For more details, visit the <a href="https://github.com/novotnyllc/NuGetKeyVaultSignTool">official website</a>.</p>
     /// </summary>
     /// <remarks>

diff --git a/Nuke.NuGetKeyVaultSignTool/Tools/NuGetKeyVaultSignTool.json b/Nuke.NuGetKeyVaultSignTool/Tools/NuGetKeyVaultSignTool.json
@@ -20,12 +20,14 @@
             "name": "KeyVaultUrl",
             "type": "string",
             "format": "--azure-key-vault-url {value}",
+            "secret": false,
             "help": "A fully qualified URL of the key vault with the certificate that will be used for signing. An example value might be <c>https://my-vault.vault.azure.net</c>."
           },
           {
             "name": "KeyVaultClientId",
             "type": "string",
             "format": "--azure-key-vault-client-id {value}",
+            "secret": false,
             "help": "This is the client ID used to authenticate to Azure, which will be used to generate an access token. This parameter is not required if an access token is supplied directly with the <c>--azure-key-vault-accesstoken</c> option. If this parameter is supplied, <c>--azure-key-vault-client-secret</c> and <c>--azure-key-vault-tenant-id</c> must be supplied as well."
           },
           {
@@ -39,12 +41,14 @@
             "name": "KeyVaultTenantId",
             "type": "string",
             "format": "--azure-key-vault-tenant-id {value}",
+            "secret": false,
             "help": "This is the tenant id used to authenticate to Azure, which will be used to generate an access token. This parameter is not required if an access token is supplied directly with the <c>--azure-key-vault-accesstoken</c> option or when using managed identities with <c>--azure-key-vault-managed-identity</c>. If this parameter is supplied, <c>--azure-key-vault-client-id</c> and <c>--azure-key-vault-client-secret</c> must be supplied as well."
           },
           {
             "name": "KeyVaultCertificateName",
             "type": "string",
             "format": "--azure-key-vault-certificate {value}",
+            "secret": false,
             "help": "The name of the certificate used to perform the signing operation."
           },
           {
@@ -58,6 +62,7 @@
             "name": "KeyVaultManagedIdentity",
             "type": "bool",
             "format": "--azure-key-vault-managed-identity",
+            "secret": false,
             "help": "Use the ambient Managed Identity to authenticate to Azure. This can be used instead of the <c>--azure-key-vault-accesstoken</c>, <c>--azure-key-vault-client-id</c> and <c>--azure-key-vault-client-secret</c> options. This is useful if NuGetKeyVaultSignTool is being used on a VM/service/CLI that is configured for managed identities to Azure."
           },
           {