diff --git a/CHANGELOG.md b/CHANGELOG.md
index c030c4a79..c3a9d9252 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
## [vNext]
+## [9.0.3] / 2024-12-05
+- Fixed nullable options for `ToolTasks.Run`
+- Fixed static tool path resolution
+- Fixed tool requirements initialization
+- Fixed documentation link in tool wrapper remarks
+- Fixed documentation on task methods and settings classes
+- Fixed missing `NuGetKeyVaultSignTool`
+- Fixed package executable in `OctopusTasks`
+
## [9.0.2] / 2024-12-03
- Fixed MSBuild tasks to use `net8.0` target framework
- Fixed error handling in `:update` command
@@ -1196,7 +1205,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Added CLT tasks for Git
- Fixed background color in console output
-[vNext]: https://github.com/nuke-build/nuke/compare/9.0.2...HEAD
+[vNext]: https://github.com/nuke-build/nuke/compare/9.0.3...HEAD
+[9.0.3]: https://github.com/nuke-build/nuke/compare/9.0.2...9.0.3
[9.0.2]: https://github.com/nuke-build/nuke/compare/9.0.1...9.0.2
[9.0.1]: https://github.com/nuke-build/nuke/compare/9.0.0...9.0.1
[9.0.0]: https://github.com/nuke-build/nuke/compare/8.1.4...9.0.0
diff --git a/build/Build.GitFlow.cs b/build/Build.GitFlow.cs
index c87df305a..2e7602d27 100644
--- a/build/Build.GitFlow.cs
+++ b/build/Build.GitFlow.cs
@@ -23,14 +23,14 @@ partial class Build
[Parameter] readonly bool Major;
string MajorMinorPatchVersion => Major ? $"{GitVersion.Major + 1}.0.0" : GitVersion.MajorMinorPatch;
+ string MilestoneTitle => $"v{MajorMinorPatchVersion}";
Target Milestone => _ => _
.Unlisted()
.OnlyWhenStatic(() => GitRepository.IsOnReleaseBranch() || GitRepository.IsOnHotfixBranch())
.Executes(async () =>
{
- var milestoneTitle = $"v{MajorMinorPatchVersion}";
- var milestone = await GitRepository.GetGitHubMilestone(milestoneTitle);
+ var milestone = await GitRepository.GetGitHubMilestone(MilestoneTitle);
if (milestone == null)
return;
diff --git a/build/Build.cs b/build/Build.cs
index 62a5be0f7..47a28bda4 100644
--- a/build/Build.cs
+++ b/build/Build.cs
@@ -18,6 +18,7 @@
using Nuke.Common.ProjectModel;
using Nuke.Common.Tooling;
using Nuke.Common.Tools.DotNet;
+using Nuke.Common.Tools.GitHub;
using Nuke.Common.Tools.GitVersion;
using Nuke.Common.Utilities;
using Nuke.Components;
@@ -178,7 +179,13 @@ void DeletePackage(string id, string version)
.Inherit()
.TriggeredBy()
.ProceedAfterFailure()
- .OnlyWhenStatic(() => GitRepository.IsOnMasterBranch());
+ .OnlyWhenStatic(() => GitRepository.IsOnMasterBranch())
+ .Executes(async () =>
+ {
+ var issues = await GitRepository.GetGitHubMilestoneIssues(MilestoneTitle);
+ foreach (var issue in issues)
+ await GitHubActions.Instance.CreateComment(issue.Number, $"Released in {MilestoneTitle}! 🎉");
+ });
Target Install => _ => _
.DependsOn()
diff --git a/source/Nuke.Common/Tools/AzureSignTool/AzureSignTool.Generated.cs b/source/Nuke.Common/Tools/AzureSignTool/AzureSignTool.Generated.cs
index 42205c7ce..b4b023856 100644
--- a/source/Nuke.Common/Tools/AzureSignTool/AzureSignTool.Generated.cs
+++ b/source/Nuke.Common/Tools/AzureSignTool/AzureSignTool.Generated.cs
@@ -23,23 +23,21 @@ namespace Nuke.Common.Tools.AzureSignTool;
[NuGetTool(Id = PackageId, Executable = PackageExecutable)]
public partial class AzureSignToolTasks : ToolTasks, IRequireNuGetPackage
{
- public static string AzureSignToolPath => new AzureSignToolTasks().GetToolPath();
+ public static string AzureSignToolPath { get => new AzureSignToolTasks().GetToolPathInternal(); set => new AzureSignToolTasks().SetToolPath(value); }
public const string PackageId = "AzureSignTool";
public const string PackageExecutable = "AzureSignTool.dll";
/// Azure Sign Tool is similar to signtool in the Windows SDK, with the major difference being that it uses Azure Key Vault for performing the signing process. The usage is like signtool, except with a limited set of options for signing and options for authenticating to Azure Key Vault.
For more details, visit the official website.
public static IReadOnlyCollection
For more details, visit the official website.
public static IReadOnlyCollection Codecov(ArgumentStringHandler arguments, string workingDirectory = null, IReadOnlyDictionary environmentVariables = null, int? timeout = null, bool? logOutput = null, bool? logInvocation = null, Action logger = null, Func exitHandler = null) => new CodecovTasks().Run(arguments, workingDirectory, environmentVariables, timeout, logOutput, logInvocation, logger, exitHandler);
/// Code coverage is a measurement used to express which lines of code were executed by a test suite. We use three primary terms to describe each line executed.
- hit - indicates that the source code was executed by the test suite.
- partial - indicates that the source code was not fully executed by the test suite; there are remaining branches that were not executed.
- miss - indicates that the source code was not executed by the test suite.
Coverage is the ratio of hits / (sum of hit + partial + miss). A code base that has 5 lines executed by tests out of 12 total lines will receive a coverage ratio of 41% (rounding down).Phrased simply, code coverage provides a visual measurement of what source code is being executed by a test suite. This information indicates to the software developer where they should write new tests in an effort to achieve higher coverage.Testing source code helps to prevent bugs and syntax errors by executing each line with a known variable and cross-checking it with an expected output.For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --branch via
- --build via
- --disable-network via
- --dump via
- --env via
- --feature via
- --file via
- --flag via
- --name via
- --no-color via
- --pr via
- --required via
- --root via
- --sha via
- --slug via
- --tag via
- --token via
- --url via
- --verbose via
- public static IReadOnlyCollection Codecov(CodecovSettings options = null) => new CodecovTasks().Run(options);
- /// Code coverage is a measurement used to express which lines of code were executed by a test suite. We use three primary terms to describe each line executed.
- hit - indicates that the source code was executed by the test suite.
- partial - indicates that the source code was not fully executed by the test suite; there are remaining branches that were not executed.
- miss - indicates that the source code was not executed by the test suite.
Coverage is the ratio of hits / (sum of hit + partial + miss). A code base that has 5 lines executed by tests out of 12 total lines will receive a coverage ratio of 41% (rounding down).Phrased simply, code coverage provides a visual measurement of what source code is being executed by a test suite. This information indicates to the software developer where they should write new tests in an effort to achieve higher coverage.Testing source code helps to prevent bugs and syntax errors by executing each line with a known variable and cross-checking it with an expected output.For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --branch via
- --build via
- --disable-network via
- --dump via
- --env via
- --feature via
- --file via
- --flag via
- --name via
- --no-color via
- --pr via
- --required via
- --root via
- --sha via
- --slug via
- --tag via
- --token via
- --url via
- --verbose via
- public static IReadOnlyCollection Codecov(Configure configurator) => new CodecovTasks().Run(configurator.Invoke(new CodecovSettings()));
- /// Code coverage is a measurement used to express which lines of code were executed by a test suite. We use three primary terms to describe each line executed.
- hit - indicates that the source code was executed by the test suite.
- partial - indicates that the source code was not fully executed by the test suite; there are remaining branches that were not executed.
- miss - indicates that the source code was not executed by the test suite.
Coverage is the ratio of hits / (sum of hit + partial + miss). A code base that has 5 lines executed by tests out of 12 total lines will receive a coverage ratio of 41% (rounding down).Phrased simply, code coverage provides a visual measurement of what source code is being executed by a test suite. This information indicates to the software developer where they should write new tests in an effort to achieve higher coverage.Testing source code helps to prevent bugs and syntax errors by executing each line with a known variable and cross-checking it with an expected output.For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --branch via
- --build via
- --disable-network via
- --dump via
- --env via
- --feature via
- --file via
- --flag via
- --name via
- --no-color via
- --pr via
- --required via
- --root via
- --sha via
- --slug via
- --tag via
- --token via
- --url via
- --verbose via
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --branch via
- --build via
- --disable-network via
- --dump via
- --env via
- --feature via
- --file via
- --flag via
- --name via
- --no-color via
- --pr via
- --required via
- --root via
- --sha via
- --slug via
- --tag via
- --token via
- --url via
- --verbose via
+ public static IReadOnlyCollection Codecov(CodecovSettings options = null) => new CodecovTasks().Run(options);
+ ///
+ public static IReadOnlyCollection Codecov(Configure configurator) => new CodecovTasks().Run(configurator.Invoke(new CodecovSettings()));
+ ///
public static IEnumerable<(CodecovSettings Settings, IReadOnlyCollection Output)> Codecov(CombinatorialConfigure configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(Codecov, degreeOfParallelism, completeOnFailure);
}
#region CodecovSettings
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
[Command(Type = typeof(CodecovTasks), Command = nameof(CodecovTasks.Codecov))]
@@ -87,7 +85,7 @@ public partial class CodecovSettings : ToolOptions
}
#endregion
#region CodecovSettingsExtensions
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
public static partial class CodecovSettingsExtensions
diff --git a/source/Nuke.Common/Tools/CorFlags/CorFlags.Generated.cs b/source/Nuke.Common/Tools/CorFlags/CorFlags.Generated.cs
index c9ec14b99..600a95fe6 100644
--- a/source/Nuke.Common/Tools/CorFlags/CorFlags.Generated.cs
+++ b/source/Nuke.Common/Tools/CorFlags/CorFlags.Generated.cs
@@ -23,22 +23,20 @@ namespace Nuke.Common.Tools.CorFlags;
[PathTool(Executable = PathExecutable)]
public partial class CorFlagsTasks : ToolTasks, IRequirePathTool
{
- public static string CorFlagsPath => new CorFlagsTasks().GetToolPath();
+ public static string CorFlagsPath { get => new CorFlagsTasks().GetToolPathInternal(); set => new CorFlagsTasks().SetToolPath(value); }
public const string PathExecutable = "CorFlags.exe";
/// The CorFlags Conversion tool allows you to configure the CorFlags section of the header of a portable executable image.
For more details, visit the official website.
public static IReadOnlyCollection CorFlags(ArgumentStringHandler arguments, string workingDirectory = null, IReadOnlyDictionary environmentVariables = null, int? timeout = null, bool? logOutput = null, bool? logInvocation = null, Action logger = null, Func exitHandler = null) => new CorFlagsTasks().Run(arguments, workingDirectory, environmentVariables, timeout, logOutput, logInvocation, logger, exitHandler);
/// The CorFlags Conversion tool allows you to configure the CorFlags section of the header of a portable executable image.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <assembly> via
- -32BIT via
- -32BITPREF via
- -Force via
- -ILONLY via
- -nologo via
- -RevertCLRHeader via
- -UpgradeCLRHeader via
- public static IReadOnlyCollection CorFlags(CorFlagsSettings options = null) => new CorFlagsTasks().Run(options);
- /// The CorFlags Conversion tool allows you to configure the CorFlags section of the header of a portable executable image.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <assembly> via
- -32BIT via
- -32BITPREF via
- -Force via
- -ILONLY via
- -nologo via
- -RevertCLRHeader via
- -UpgradeCLRHeader via
- public static IReadOnlyCollection CorFlags(Configure configurator) => new CorFlagsTasks().Run(configurator.Invoke(new CorFlagsSettings()));
- /// The CorFlags Conversion tool allows you to configure the CorFlags section of the header of a portable executable image.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <assembly> via
- -32BIT via
- -32BITPREF via
- -Force via
- -ILONLY via
- -nologo via
- -RevertCLRHeader via
- -UpgradeCLRHeader via
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <assembly> via
- -32BIT via
- -32BITPREF via
- -Force via
- -ILONLY via
- -nologo via
- -RevertCLRHeader via
- -UpgradeCLRHeader via
+ public static IReadOnlyCollection CorFlags(CorFlagsSettings options = null) => new CorFlagsTasks().Run(options);
+ ///
+ public static IReadOnlyCollection CorFlags(Configure configurator) => new CorFlagsTasks().Run(configurator.Invoke(new CorFlagsSettings()));
+ ///
public static IEnumerable<(CorFlagsSettings Settings, IReadOnlyCollection Output)> CorFlags(CombinatorialConfigure configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(CorFlags, degreeOfParallelism, completeOnFailure);
}
#region CorFlagsSettings
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
[Command(Type = typeof(CorFlagsTasks), Command = nameof(CorFlagsTasks.CorFlags))]
@@ -63,7 +61,7 @@ public partial class CorFlagsSettings : ToolOptions
}
#endregion
#region CorFlagsSettingsExtensions
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
public static partial class CorFlagsSettingsExtensions
diff --git a/source/Nuke.Common/Tools/CoverallsNet/CoverallsNet.Generated.cs b/source/Nuke.Common/Tools/CoverallsNet/CoverallsNet.Generated.cs
index d5c48a32d..8dbcf0c5f 100644
--- a/source/Nuke.Common/Tools/CoverallsNet/CoverallsNet.Generated.cs
+++ b/source/Nuke.Common/Tools/CoverallsNet/CoverallsNet.Generated.cs
@@ -23,23 +23,21 @@ namespace Nuke.Common.Tools.CoverallsNet;
[NuGetTool(Id = PackageId, Executable = PackageExecutable)]
public partial class CoverallsNetTasks : ToolTasks, IRequireNuGetPackage
{
- public static string CoverallsNetPath => new CoverallsNetTasks().GetToolPath();
+ public static string CoverallsNetPath { get => new CoverallsNetTasks().GetToolPathInternal(); set => new CoverallsNetTasks().SetToolPath(value); }
public const string PackageId = "coveralls.net";
public const string PackageExecutable = "csmacnz.Coveralls.dll";
/// Coveralls uploader for .Net Code coverage of your C# source code. Should work with any code files that get reported with the supported coverage tools, but the primary focus is CSharp.
For more details, visit the official website.
public static IReadOnlyCollection CoverallsNet(ArgumentStringHandler arguments, string workingDirectory = null, IReadOnlyDictionary environmentVariables = null, int? timeout = null, bool? logOutput = null, bool? logInvocation = null, Action logger = null, Func exitHandler = null) => new CoverallsNetTasks().Run(arguments, workingDirectory, environmentVariables, timeout, logOutput, logInvocation, logger, exitHandler);
/// Coveralls uploader for .Net Code coverage of your C# source code. Should work with any code files that get reported with the supported coverage tools, but the primary focus is CSharp.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --basePath via
- --commitAuthor via
- --commitBranch via
- --commitEmail via
- --commitId via
- --commitMessage via
- --dryrun via
- --dynamiccodecoverage via
- --exportcodecoverage via
- --input via
- --jobId via
- --monocov via
- --opencover via
- --output via
- --pullRequest via
- --repoToken via
- --repoTokenVariable via
- --serviceName via
- --useRelativePaths via
- public static IReadOnlyCollection CoverallsNet(CoverallsNetSettings options = null) => new CoverallsNetTasks().Run(options);
- /// Coveralls uploader for .Net Code coverage of your C# source code. Should work with any code files that get reported with the supported coverage tools, but the primary focus is CSharp.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --basePath via
- --commitAuthor via
- --commitBranch via
- --commitEmail via
- --commitId via
- --commitMessage via
- --dryrun via
- --dynamiccodecoverage via
- --exportcodecoverage via
- --input via
- --jobId via
- --monocov via
- --opencover via
- --output via
- --pullRequest via
- --repoToken via
- --repoTokenVariable via
- --serviceName via
- --useRelativePaths via
- public static IReadOnlyCollection CoverallsNet(Configure configurator) => new CoverallsNetTasks().Run(configurator.Invoke(new CoverallsNetSettings()));
- /// Coveralls uploader for .Net Code coverage of your C# source code. Should work with any code files that get reported with the supported coverage tools, but the primary focus is CSharp.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --basePath via
- --commitAuthor via
- --commitBranch via
- --commitEmail via
- --commitId via
- --commitMessage via
- --dryrun via
- --dynamiccodecoverage via
- --exportcodecoverage via
- --input via
- --jobId via
- --monocov via
- --opencover via
- --output via
- --pullRequest via
- --repoToken via
- --repoTokenVariable via
- --serviceName via
- --useRelativePaths via
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --basePath via
- --commitAuthor via
- --commitBranch via
- --commitEmail via
- --commitId via
- --commitMessage via
- --dryrun via
- --dynamiccodecoverage via
- --exportcodecoverage via
- --input via
- --jobId via
- --monocov via
- --opencover via
- --output via
- --pullRequest via
- --repoToken via
- --repoTokenVariable via
- --serviceName via
- --useRelativePaths via
+ public static IReadOnlyCollection CoverallsNet(CoverallsNetSettings options = null) => new CoverallsNetTasks().Run(options);
+ ///
+ public static IReadOnlyCollection CoverallsNet(Configure configurator) => new CoverallsNetTasks().Run(configurator.Invoke(new CoverallsNetSettings()));
+ ///
public static IEnumerable<(CoverallsNetSettings Settings, IReadOnlyCollection Output)> CoverallsNet(CombinatorialConfigure configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(CoverallsNet, degreeOfParallelism, completeOnFailure);
}
#region CoverallsNetSettings
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
[Command(Type = typeof(CoverallsNetTasks), Command = nameof(CoverallsNetTasks.CoverallsNet))]
@@ -86,7 +84,7 @@ public partial class CoverallsNetSettings : ToolOptions
}
#endregion
#region CoverallsNetSettingsExtensions
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
public static partial class CoverallsNetSettingsExtensions
diff --git a/source/Nuke.Common/Tools/Coverlet/Coverlet.Generated.cs b/source/Nuke.Common/Tools/Coverlet/Coverlet.Generated.cs
index c905992c8..07ebd9376 100644
--- a/source/Nuke.Common/Tools/Coverlet/Coverlet.Generated.cs
+++ b/source/Nuke.Common/Tools/Coverlet/Coverlet.Generated.cs
@@ -24,23 +24,21 @@ namespace Nuke.Common.Tools.Coverlet;
[NuGetTool(Id = PackageId, Executable = PackageExecutable)]
public partial class CoverletTasks : ToolTasks, IRequireNuGetPackage
{
- public static string CoverletPath => new CoverletTasks().GetToolPath();
+ public static string CoverletPath { get => new CoverletTasks().GetToolPathInternal(); set => new CoverletTasks().SetToolPath(value); }
public const string PackageId = "coverlet.console";
public const string PackageExecutable = "coverlet.console.dll";
/// Coverlet is a cross platform code coverage library for .NET Core, with support for line, branch and method coverage.The dotnet test command is used to execute unit tests in a given project. Unit tests are console application projects that have dependencies on the unit test framework (for example, MSTest, NUnit, or xUnit) and the dotnet test runner for the unit testing framework. These are packaged as NuGet packages and are restored as ordinary dependencies for the project.
For more details, visit the official website.
public static IReadOnlyCollection Coverlet(ArgumentStringHandler arguments, string workingDirectory = null, IReadOnlyDictionary environmentVariables = null, int? timeout = null, bool? logOutput = null, bool? logInvocation = null, Action logger = null, Func exitHandler = null) => new CoverletTasks().Run(arguments, workingDirectory, environmentVariables, timeout, logOutput, logInvocation, logger, exitHandler);
/// Coverlet is a cross platform code coverage library for .NET Core, with support for line, branch and method coverage.The dotnet test command is used to execute unit tests in a given project. Unit tests are console application projects that have dependencies on the unit test framework (for example, MSTest, NUnit, or xUnit) and the dotnet test runner for the unit testing framework. These are packaged as NuGet packages and are restored as ordinary dependencies for the project.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <assembly> via
- --exclude via
- --exclude-by-file via
- --format via
- --include via
- --merge-with via
- --output via
- --target via
- --targetargs via
- --threshold via
- --threshold-type via
- --version via
- public static IReadOnlyCollection Coverlet(CoverletSettings options = null) => new CoverletTasks().Run(options);
- /// Coverlet is a cross platform code coverage library for .NET Core, with support for line, branch and method coverage.The dotnet test command is used to execute unit tests in a given project. Unit tests are console application projects that have dependencies on the unit test framework (for example, MSTest, NUnit, or xUnit) and the dotnet test runner for the unit testing framework. These are packaged as NuGet packages and are restored as ordinary dependencies for the project.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <assembly> via
- --exclude via
- --exclude-by-file via
- --format via
- --include via
- --merge-with via
- --output via
- --target via
- --targetargs via
- --threshold via
- --threshold-type via
- --version via
- public static IReadOnlyCollection Coverlet(Configure configurator) => new CoverletTasks().Run(configurator.Invoke(new CoverletSettings()));
- /// Coverlet is a cross platform code coverage library for .NET Core, with support for line, branch and method coverage.The dotnet test command is used to execute unit tests in a given project. Unit tests are console application projects that have dependencies on the unit test framework (for example, MSTest, NUnit, or xUnit) and the dotnet test runner for the unit testing framework. These are packaged as NuGet packages and are restored as ordinary dependencies for the project.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <assembly> via
- --exclude via
- --exclude-by-file via
- --format via
- --include via
- --merge-with via
- --output via
- --target via
- --targetargs via
- --threshold via
- --threshold-type via
- --version via
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <assembly> via
- --exclude via
- --exclude-by-file via
- --format via
- --include via
- --merge-with via
- --output via
- --target via
- --targetargs via
- --threshold via
- --threshold-type via
- --version via
+ public static IReadOnlyCollection Coverlet(CoverletSettings options = null) => new CoverletTasks().Run(options);
+ ///
+ public static IReadOnlyCollection Coverlet(Configure configurator) => new CoverletTasks().Run(configurator.Invoke(new CoverletSettings()));
+ ///
public static IEnumerable<(CoverletSettings Settings, IReadOnlyCollection Output)> Coverlet(CombinatorialConfigure configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(Coverlet, degreeOfParallelism, completeOnFailure);
}
#region CoverletSettings
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
[Command(Type = typeof(CoverletTasks), Command = nameof(CoverletTasks.Coverlet))]
@@ -73,7 +71,7 @@ public partial class CoverletSettings : ToolOptions
}
#endregion
#region CoverletSettingsExtensions
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
public static partial class CoverletSettingsExtensions
diff --git a/source/Nuke.Common/Tools/DocFX/DocFX.Generated.cs b/source/Nuke.Common/Tools/DocFX/DocFX.Generated.cs
index 87bff044b..42136cc57 100644
--- a/source/Nuke.Common/Tools/DocFX/DocFX.Generated.cs
+++ b/source/Nuke.Common/Tools/DocFX/DocFX.Generated.cs
@@ -23,104 +23,84 @@ namespace Nuke.Common.Tools.DocFX;
[NuGetTool(Id = PackageId, Executable = PackageExecutable)]
public partial class DocFXTasks : ToolTasks, IRequireNuGetPackage
{
- public static string DocFXPath => new DocFXTasks().GetToolPath();
+ public static string DocFXPath { get => new DocFXTasks().GetToolPathInternal(); set => new DocFXTasks().SetToolPath(value); }
public const string PackageId = "docfx.console";
public const string PackageExecutable = "docfx.exe";
/// DocFX is an API documentation generator for .NET, and currently it supports C# and VB. It generates API reference documentation from triple-slash comments in your source code. It also allows you to use Markdown files to create additional topics such as tutorials and how-tos, and to customize the generated reference documentation. DocFX builds a static HTML website from your source code and Markdown files, which can be easily hosted on any web servers (for example, github.io). Also, DocFX provides you the flexibility to customize the layout and style of your website through templates. If you are interested in creating your own website with your own styles, you can follow how to create custom template to create custom templates.
For more details, visit the official website.
public static IReadOnlyCollection DocFX(ArgumentStringHandler arguments, string workingDirectory = null, IReadOnlyDictionary environmentVariables = null, int? timeout = null, bool? logOutput = null, bool? logInvocation = null, Action logger = null, Func exitHandler = null) => new DocFXTasks().Run(arguments, workingDirectory, environmentVariables, timeout, logOutput, logInvocation, logger, exitHandler);
/// Generate client-only website combining API in YAML files and conceptual files.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <configFile> via
- --changesFile via
- --cleanupCacheHistory via
- --content via
- --correlationId via
- --debug via
- --debugOutput via
- --disableGitFeatures via
- --dryRun via
- --exportRawModel via
- --exportViewModel via
- --falName via
- --fileMetadataFile via
- --fileMetadataFiles via
- --force via
- --forcePostProcess via
- --globalMetadata via
- --globalMetadataFile via
- --globalMetadataFiles via
- --help via
- --hostname via
- --intermediateFolder via
- --keepFileLink via
- --log via
- --logLevel via
- --lruSize via
- --markdownEngineName via
- --markdownEngineProperties via
- --maxParallelism via
- --noLangKeyword via
- --output via
- --overwrite via
- --port via
- --postProcessors via
- --rawModelOutputFolder via
- --repositoryRoot via
- --resource via
- --schemaLicense via
- --serve via
- --template via
- --theme via
- --viewModelOutputFolder via
- --warningsAsErrors via
- --xref via
- public static IReadOnlyCollection DocFXBuild(DocFXBuildSettings options = null) => new DocFXTasks().Run(options);
- /// Generate client-only website combining API in YAML files and conceptual files.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <configFile> via
- --changesFile via
- --cleanupCacheHistory via
- --content via
- --correlationId via
- --debug via
- --debugOutput via
- --disableGitFeatures via
- --dryRun via
- --exportRawModel via
- --exportViewModel via
- --falName via
- --fileMetadataFile via
- --fileMetadataFiles via
- --force via
- --forcePostProcess via
- --globalMetadata via
- --globalMetadataFile via
- --globalMetadataFiles via
- --help via
- --hostname via
- --intermediateFolder via
- --keepFileLink via
- --log via
- --logLevel via
- --lruSize via
- --markdownEngineName via
- --markdownEngineProperties via
- --maxParallelism via
- --noLangKeyword via
- --output via
- --overwrite via
- --port via
- --postProcessors via
- --rawModelOutputFolder via
- --repositoryRoot via
- --resource via
- --schemaLicense via
- --serve via
- --template via
- --theme via
- --viewModelOutputFolder via
- --warningsAsErrors via
- --xref via
- public static IReadOnlyCollection DocFXBuild(Configure configurator) => new DocFXTasks().Run(configurator.Invoke(new DocFXBuildSettings()));
- /// Generate client-only website combining API in YAML files and conceptual files.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <configFile> via
- --changesFile via
- --cleanupCacheHistory via
- --content via
- --correlationId via
- --debug via
- --debugOutput via
- --disableGitFeatures via
- --dryRun via
- --exportRawModel via
- --exportViewModel via
- --falName via
- --fileMetadataFile via
- --fileMetadataFiles via
- --force via
- --forcePostProcess via
- --globalMetadata via
- --globalMetadataFile via
- --globalMetadataFiles via
- --help via
- --hostname via
- --intermediateFolder via
- --keepFileLink via
- --log via
- --logLevel via
- --lruSize via
- --markdownEngineName via
- --markdownEngineProperties via
- --maxParallelism via
- --noLangKeyword via
- --output via
- --overwrite via
- --port via
- --postProcessors via
- --rawModelOutputFolder via
- --repositoryRoot via
- --resource via
- --schemaLicense via
- --serve via
- --template via
- --theme via
- --viewModelOutputFolder via
- --warningsAsErrors via
- --xref via
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <configFile> via
- --changesFile via
- --cleanupCacheHistory via
- --content via
- --correlationId via
- --debug via
- --debugOutput via
- --disableGitFeatures via
- --dryRun via
- --exportRawModel via
- --exportViewModel via
- --falName via
- --fileMetadataFile via
- --fileMetadataFiles via
- --force via
- --forcePostProcess via
- --globalMetadata via
- --globalMetadataFile via
- --globalMetadataFiles via
- --help via
- --hostname via
- --intermediateFolder via
- --keepFileLink via
- --log via
- --logLevel via
- --lruSize via
- --markdownEngineName via
- --markdownEngineProperties via
- --maxParallelism via
- --noLangKeyword via
- --output via
- --overwrite via
- --port via
- --postProcessors via
- --rawModelOutputFolder via
- --repositoryRoot via
- --resource via
- --schemaLicense via
- --serve via
- --template via
- --theme via
- --viewModelOutputFolder via
- --warningsAsErrors via
- --xref via
+ public static IReadOnlyCollection DocFXBuild(DocFXBuildSettings options = null) => new DocFXTasks().Run(options);
+ ///
+ public static IReadOnlyCollection DocFXBuild(Configure configurator) => new DocFXTasks().Run(configurator.Invoke(new DocFXBuildSettings()));
+ ///
public static IEnumerable<(DocFXBuildSettings Settings, IReadOnlyCollection Output)> DocFXBuild(CombinatorialConfigure configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(DocFXBuild, degreeOfParallelism, completeOnFailure);
/// Export dependency file.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <dependencyFile> via
- --help via
- --intermediateFolder via
- --version via
- public static IReadOnlyCollection DocFXDependency(DocFXDependencySettings options = null) => new DocFXTasks().Run(options);
- /// Export dependency file.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <dependencyFile> via
- --help via
- --intermediateFolder via
- --version via
- public static IReadOnlyCollection DocFXDependency(Configure configurator) => new DocFXTasks().Run(configurator.Invoke(new DocFXDependencySettings()));
- /// Export dependency file.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <dependencyFile> via
- --help via
- --intermediateFolder via
- --version via
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <dependencyFile> via
- --help via
- --intermediateFolder via
- --version via
+ public static IReadOnlyCollection DocFXDependency(DocFXDependencySettings options = null) => new DocFXTasks().Run(options);
+ ///
+ public static IReadOnlyCollection DocFXDependency(Configure configurator) => new DocFXTasks().Run(configurator.Invoke(new DocFXDependencySettings()));
+ ///
public static IEnumerable<(DocFXDependencySettings Settings, IReadOnlyCollection Output)> DocFXDependency(CombinatorialConfigure configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(DocFXDependency, degreeOfParallelism, completeOnFailure);
/// Download remote xref map file and create an xref archive in local.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <archiveFile> via
- --help via
- --xref via
- public static IReadOnlyCollection DocFXDownload(DocFXDownloadSettings options = null) => new DocFXTasks().Run(options);
- /// Download remote xref map file and create an xref archive in local.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <archiveFile> via
- --help via
- --xref via
- public static IReadOnlyCollection DocFXDownload(Configure configurator) => new DocFXTasks().Run(configurator.Invoke(new DocFXDownloadSettings()));
- /// Download remote xref map file and create an xref archive in local.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <archiveFile> via
- --help via
- --xref via
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <archiveFile> via
- --help via
- --xref via
+ public static IReadOnlyCollection DocFXDownload(DocFXDownloadSettings options = null) => new DocFXTasks().Run(options);
+ ///
+ public static IReadOnlyCollection DocFXDownload(Configure configurator) => new DocFXTasks().Run(configurator.Invoke(new DocFXDownloadSettings()));
+ ///
public static IEnumerable<(DocFXDownloadSettings Settings, IReadOnlyCollection Output)> DocFXDownload(CombinatorialConfigure configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(DocFXDownload, degreeOfParallelism, completeOnFailure);
/// Get an overall guide for the command and sub-commands.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- public static IReadOnlyCollection DocFXHelp(DocFXHelpSettings options = null) => new DocFXTasks().Run(options);
- /// Get an overall guide for the command and sub-commands.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- public static IReadOnlyCollection DocFXHelp(Configure configurator) => new DocFXTasks().Run(configurator.Invoke(new DocFXHelpSettings()));
- /// Get an overall guide for the command and sub-commands.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
+ public static IReadOnlyCollection DocFXHelp(DocFXHelpSettings options = null) => new DocFXTasks().Run(options);
+ ///
+ public static IReadOnlyCollection DocFXHelp(Configure configurator) => new DocFXTasks().Run(configurator.Invoke(new DocFXHelpSettings()));
+ ///
public static IEnumerable<(DocFXHelpSettings Settings, IReadOnlyCollection Output)> DocFXHelp(CombinatorialConfigure configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(DocFXHelp, degreeOfParallelism, completeOnFailure);
/// Generate an initial docfx.json following the instructions.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --apiGlobPattern via
- --apiSourceFolder via
- --file via
- --help via
- --output via
- --overwrite via
- --quiet via
- public static IReadOnlyCollection DocFXInit(DocFXInitSettings options = null) => new DocFXTasks().Run(options);
- /// Generate an initial docfx.json following the instructions.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --apiGlobPattern via
- --apiSourceFolder via
- --file via
- --help via
- --output via
- --overwrite via
- --quiet via
- public static IReadOnlyCollection DocFXInit(Configure configurator) => new DocFXTasks().Run(configurator.Invoke(new DocFXInitSettings()));
- /// Generate an initial docfx.json following the instructions.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --apiGlobPattern via
- --apiSourceFolder via
- --file via
- --help via
- --output via
- --overwrite via
- --quiet via
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --apiGlobPattern via
- --apiSourceFolder via
- --file via
- --help via
- --output via
- --overwrite via
- --quiet via
+ public static IReadOnlyCollection DocFXInit(DocFXInitSettings options = null) => new DocFXTasks().Run(options);
+ ///
+ public static IReadOnlyCollection DocFXInit(Configure configurator) => new DocFXTasks().Run(configurator.Invoke(new DocFXInitSettings()));
+ ///
public static IEnumerable<(DocFXInitSettings Settings, IReadOnlyCollection Output)> DocFXInit(CombinatorialConfigure configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(DocFXInit, degreeOfParallelism, completeOnFailure);
/// Merge .net base API in YAML files and toc files.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <configFile> via
- --content via
- --correlationId via
- --fileMetadataFile via
- --globalMetadata via
- --globalMetadataFile via
- --help via
- --log via
- --logLevel via
- --repositoryRoot via
- --tocMetadata via
- --warningsAsErrors via
- public static IReadOnlyCollection DocFXMerge(DocFXMergeSettings options = null) => new DocFXTasks().Run(options);
- /// Merge .net base API in YAML files and toc files.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <configFile> via
- --content via
- --correlationId via
- --fileMetadataFile via
- --globalMetadata via
- --globalMetadataFile via
- --help via
- --log via
- --logLevel via
- --repositoryRoot via
- --tocMetadata via
- --warningsAsErrors via
- public static IReadOnlyCollection DocFXMerge(Configure configurator) => new DocFXTasks().Run(configurator.Invoke(new DocFXMergeSettings()));
- /// Merge .net base API in YAML files and toc files.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <configFile> via
- --content via
- --correlationId via
- --fileMetadataFile via
- --globalMetadata via
- --globalMetadataFile via
- --help via
- --log via
- --logLevel via
- --repositoryRoot via
- --tocMetadata via
- --warningsAsErrors via
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <configFile> via
- --content via
- --correlationId via
- --fileMetadataFile via
- --globalMetadata via
- --globalMetadataFile via
- --help via
- --log via
- --logLevel via
- --repositoryRoot via
- --tocMetadata via
- --warningsAsErrors via
+ public static IReadOnlyCollection DocFXMerge(DocFXMergeSettings options = null) => new DocFXTasks().Run(options);
+ ///
+ public static IReadOnlyCollection DocFXMerge(Configure configurator) => new DocFXTasks().Run(configurator.Invoke(new DocFXMergeSettings()));
+ ///
public static IEnumerable<(DocFXMergeSettings Settings, IReadOnlyCollection Output)> DocFXMerge(CombinatorialConfigure configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(DocFXMerge, degreeOfParallelism, completeOnFailure);
/// Generate YAML files from source code.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <projects> via
- --correlationId via
- --disableDefaultFilter via
- --disableGitFeatures via
- --filter via
- --force via
- --globalNamespaceId via
- --help via
- --log via
- --logLevel via
- --output via
- --property via
- --raw via
- --repositoryRoot via
- --shouldSkipMarkup via
- --warningsAsErrors via
- public static IReadOnlyCollection DocFXMetadata(DocFXMetadataSettings options = null) => new DocFXTasks().Run(options);
- /// Generate YAML files from source code.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <projects> via
- --correlationId via
- --disableDefaultFilter via
- --disableGitFeatures via
- --filter via
- --force via
- --globalNamespaceId via
- --help via
- --log via
- --logLevel via
- --output via
- --property via
- --raw via
- --repositoryRoot via
- --shouldSkipMarkup via
- --warningsAsErrors via
- public static IReadOnlyCollection DocFXMetadata(Configure configurator) => new DocFXTasks().Run(configurator.Invoke(new DocFXMetadataSettings()));
- /// Generate YAML files from source code.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <projects> via
- --correlationId via
- --disableDefaultFilter via
- --disableGitFeatures via
- --filter via
- --force via
- --globalNamespaceId via
- --help via
- --log via
- --logLevel via
- --output via
- --property via
- --raw via
- --repositoryRoot via
- --shouldSkipMarkup via
- --warningsAsErrors via
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <projects> via
- --correlationId via
- --disableDefaultFilter via
- --disableGitFeatures via
- --filter via
- --force via
- --globalNamespaceId via
- --help via
- --log via
- --logLevel via
- --output via
- --property via
- --raw via
- --repositoryRoot via
- --shouldSkipMarkup via
- --warningsAsErrors via
+ public static IReadOnlyCollection DocFXMetadata(DocFXMetadataSettings options = null) => new DocFXTasks().Run(options);
+ ///
+ public static IReadOnlyCollection DocFXMetadata(Configure configurator) => new DocFXTasks().Run(configurator.Invoke(new DocFXMetadataSettings()));
+ ///
public static IEnumerable<(DocFXMetadataSettings Settings, IReadOnlyCollection Output)> DocFXMetadata(CombinatorialConfigure configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(DocFXMetadata, degreeOfParallelism, completeOnFailure);
/// Generate pdf file.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <configFile> via
- --basePath via
- --changesFile via
- --cleanupCacheHistory via
- --content via
- --correlationId via
- --css via
- --debug via
- --debugOutput via
- --disableGitFeatures via
- --dryRun via
- --errorHandling via
- --excludedTocs via
- --exportRawModel via
- --exportViewModel via
- --falName via
- --fileMetadataFile via
- --fileMetadataFiles via
- --force via
- --forcePostProcess via
- --generatesAppendices via
- --generatesExternalLink via
- --globalMetadata via
- --globalMetadataFile via
- --globalMetadataFiles via
- --help via
- --host via
- --hostname via
- --intermediateFolder via
- --keepFileLink via
- --keepRawFiles via
- --locale via
- --log via
- --logLevel via
- --lruSize via
- --markdownEngineName via
- --markdownEngineProperties via
- --maxParallelism via
- --name via
- --noLangKeyword via
- --noStdin via
- --output via
- --overwrite via
- --port via
- --postProcessors via
- --rawModelOutputFolder via
- --rawOutputFolder via
- --repositoryRoot via
- --resource via
- --schemaLicense via
- --serve via
- --template via
- --theme via
- --viewModelOutputFolder via
- --warningsAsErrors via
- --xref via
- public static IReadOnlyCollection DocFXPdf(DocFXPdfSettings options = null) => new DocFXTasks().Run(options);
- /// Generate pdf file.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <configFile> via
- --basePath via
- --changesFile via
- --cleanupCacheHistory via
- --content via
- --correlationId via
- --css via
- --debug via
- --debugOutput via
- --disableGitFeatures via
- --dryRun via
- --errorHandling via
- --excludedTocs via
- --exportRawModel via
- --exportViewModel via
- --falName via
- --fileMetadataFile via
- --fileMetadataFiles via
- --force via
- --forcePostProcess via
- --generatesAppendices via
- --generatesExternalLink via
- --globalMetadata via
- --globalMetadataFile via
- --globalMetadataFiles via
- --help via
- --host via
- --hostname via
- --intermediateFolder via
- --keepFileLink via
- --keepRawFiles via
- --locale via
- --log via
- --logLevel via
- --lruSize via
- --markdownEngineName via
- --markdownEngineProperties via
- --maxParallelism via
- --name via
- --noLangKeyword via
- --noStdin via
- --output via
- --overwrite via
- --port via
- --postProcessors via
- --rawModelOutputFolder via
- --rawOutputFolder via
- --repositoryRoot via
- --resource via
- --schemaLicense via
- --serve via
- --template via
- --theme via
- --viewModelOutputFolder via
- --warningsAsErrors via
- --xref via
- public static IReadOnlyCollection DocFXPdf(Configure configurator) => new DocFXTasks().Run(configurator.Invoke(new DocFXPdfSettings()));
- /// Generate pdf file.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <configFile> via
- --basePath via
- --changesFile via
- --cleanupCacheHistory via
- --content via
- --correlationId via
- --css via
- --debug via
- --debugOutput via
- --disableGitFeatures via
- --dryRun via
- --errorHandling via
- --excludedTocs via
- --exportRawModel via
- --exportViewModel via
- --falName via
- --fileMetadataFile via
- --fileMetadataFiles via
- --force via
- --forcePostProcess via
- --generatesAppendices via
- --generatesExternalLink via
- --globalMetadata via
- --globalMetadataFile via
- --globalMetadataFiles via
- --help via
- --host via
- --hostname via
- --intermediateFolder via
- --keepFileLink via
- --keepRawFiles via
- --locale via
- --log via
- --logLevel via
- --lruSize via
- --markdownEngineName via
- --markdownEngineProperties via
- --maxParallelism via
- --name via
- --noLangKeyword via
- --noStdin via
- --output via
- --overwrite via
- --port via
- --postProcessors via
- --rawModelOutputFolder via
- --rawOutputFolder via
- --repositoryRoot via
- --resource via
- --schemaLicense via
- --serve via
- --template via
- --theme via
- --viewModelOutputFolder via
- --warningsAsErrors via
- --xref via
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <configFile> via
- --basePath via
- --changesFile via
- --cleanupCacheHistory via
- --content via
- --correlationId via
- --css via
- --debug via
- --debugOutput via
- --disableGitFeatures via
- --dryRun via
- --errorHandling via
- --excludedTocs via
- --exportRawModel via
- --exportViewModel via
- --falName via
- --fileMetadataFile via
- --fileMetadataFiles via
- --force via
- --forcePostProcess via
- --generatesAppendices via
- --generatesExternalLink via
- --globalMetadata via
- --globalMetadataFile via
- --globalMetadataFiles via
- --help via
- --host via
- --hostname via
- --intermediateFolder via
- --keepFileLink via
- --keepRawFiles via
- --locale via
- --log via
- --logLevel via
- --lruSize via
- --markdownEngineName via
- --markdownEngineProperties via
- --maxParallelism via
- --name via
- --noLangKeyword via
- --noStdin via
- --output via
- --overwrite via
- --port via
- --postProcessors via
- --rawModelOutputFolder via
- --rawOutputFolder via
- --repositoryRoot via
- --resource via
- --schemaLicense via
- --serve via
- --template via
- --theme via
- --viewModelOutputFolder via
- --warningsAsErrors via
- --xref via
+ public static IReadOnlyCollection DocFXPdf(DocFXPdfSettings options = null) => new DocFXTasks().Run(options);
+ ///
+ public static IReadOnlyCollection DocFXPdf(Configure configurator) => new DocFXTasks().Run(configurator.Invoke(new DocFXPdfSettings()));
+ ///
public static IEnumerable<(DocFXPdfSettings Settings, IReadOnlyCollection Output)> DocFXPdf(CombinatorialConfigure configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(DocFXPdf, degreeOfParallelism, completeOnFailure);
/// Host a local static website.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <folder> via
- --help via
- --hostname via
- --port via
- public static IReadOnlyCollection DocFXServe(DocFXServeSettings options = null) => new DocFXTasks().Run(options);
- /// Host a local static website.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <folder> via
- --help via
- --hostname via
- --port via
- public static IReadOnlyCollection DocFXServe(Configure configurator) => new DocFXTasks().Run(configurator.Invoke(new DocFXServeSettings()));
- /// Host a local static website.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <folder> via
- --help via
- --hostname via
- --port via
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <folder> via
- --help via
- --hostname via
- --port via
+ public static IReadOnlyCollection DocFXServe(DocFXServeSettings options = null) => new DocFXTasks().Run(options);
+ ///
+ public static IReadOnlyCollection DocFXServe(Configure configurator) => new DocFXTasks().Run(configurator.Invoke(new DocFXServeSettings()));
+ ///
public static IEnumerable<(DocFXServeSettings Settings, IReadOnlyCollection Output)> DocFXServe(CombinatorialConfigure configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(DocFXServe, degreeOfParallelism, completeOnFailure);
/// List or export existing template.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <command> via
- --all via
- --help via
- --output via
- public static IReadOnlyCollection DocFXTemplate(DocFXTemplateSettings options = null) => new DocFXTasks().Run(options);
- /// List or export existing template.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <command> via
- --all via
- --help via
- --output via
- public static IReadOnlyCollection DocFXTemplate(Configure configurator) => new DocFXTasks().Run(configurator.Invoke(new DocFXTemplateSettings()));
- /// List or export existing template.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <command> via
- --all via
- --help via
- --output via
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <command> via
- --all via
- --help via
- --output via
+ public static IReadOnlyCollection DocFXTemplate(DocFXTemplateSettings options = null) => new DocFXTasks().Run(options);
+ ///
+ public static IReadOnlyCollection DocFXTemplate(Configure configurator) => new DocFXTasks().Run(configurator.Invoke(new DocFXTemplateSettings()));
+ ///
public static IEnumerable<(DocFXTemplateSettings Settings, IReadOnlyCollection Output)> DocFXTemplate(CombinatorialConfigure configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(DocFXTemplate, degreeOfParallelism, completeOnFailure);
}
#region DocFXBuildSettings
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
[Command(Type = typeof(DocFXTasks), Command = nameof(DocFXTasks.DocFXBuild), Arguments = "build")]
@@ -217,7 +197,7 @@ public partial class DocFXBuildSettings : ToolOptions
}
#endregion
#region DocFXDependencySettings
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
[Command(Type = typeof(DocFXTasks), Command = nameof(DocFXTasks.DocFXDependency), Arguments = "dependency")]
@@ -234,7 +214,7 @@ public partial class DocFXDependencySettings : ToolOptions
}
#endregion
#region DocFXDownloadSettings
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
[Command(Type = typeof(DocFXTasks), Command = nameof(DocFXTasks.DocFXDownload), Arguments = "download")]
@@ -249,7 +229,7 @@ public partial class DocFXDownloadSettings : ToolOptions
}
#endregion
#region DocFXHelpSettings
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
[Command(Type = typeof(DocFXTasks), Command = nameof(DocFXTasks.DocFXHelp), Arguments = "help")]
@@ -260,7 +240,7 @@ public partial class DocFXHelpSettings : ToolOptions
}
#endregion
#region DocFXInitSettings
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
[Command(Type = typeof(DocFXTasks), Command = nameof(DocFXTasks.DocFXInit), Arguments = "init")]
@@ -283,7 +263,7 @@ public partial class DocFXInitSettings : ToolOptions
}
#endregion
#region DocFXMergeSettings
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
[Command(Type = typeof(DocFXTasks), Command = nameof(DocFXTasks.DocFXMerge), Arguments = "merge")]
@@ -316,7 +296,7 @@ public partial class DocFXMergeSettings : ToolOptions
}
#endregion
#region DocFXMetadataSettings
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
[Command(Type = typeof(DocFXTasks), Command = nameof(DocFXTasks.DocFXMetadata), Arguments = "metadata")]
@@ -357,7 +337,7 @@ public partial class DocFXMetadataSettings : ToolOptions
}
#endregion
#region DocFXPdfSettings
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
[Command(Type = typeof(DocFXTasks), Command = nameof(DocFXTasks.DocFXPdf), Arguments = "pdf")]
@@ -478,7 +458,7 @@ public partial class DocFXPdfSettings : ToolOptions
}
#endregion
#region DocFXServeSettings
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
[Command(Type = typeof(DocFXTasks), Command = nameof(DocFXTasks.DocFXServe), Arguments = "serve")]
@@ -495,7 +475,7 @@ public partial class DocFXServeSettings : ToolOptions
}
#endregion
#region DocFXTemplateSettings
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
[Command(Type = typeof(DocFXTasks), Command = nameof(DocFXTasks.DocFXTemplate), Arguments = "template")]
@@ -512,7 +492,7 @@ public partial class DocFXTemplateSettings : ToolOptions
}
#endregion
#region DocFXBuildSettingsExtensions
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
public static partial class DocFXBuildSettingsExtensions
@@ -1124,7 +1104,7 @@ [Pure] [Builder(Type = typeof(DocFXBuildSettings), Property = nameof(DocFXBuildS
}
#endregion
#region DocFXDependencySettingsExtensions
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
public static partial class DocFXDependencySettingsExtensions
@@ -1173,7 +1153,7 @@ [Pure] [Builder(Type = typeof(DocFXDependencySettings), Property = nameof(DocFXD
}
#endregion
#region DocFXDownloadSettingsExtensions
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
public static partial class DocFXDownloadSettingsExtensions
@@ -1214,7 +1194,7 @@ [Pure] [Builder(Type = typeof(DocFXDownloadSettings), Property = nameof(DocFXDow
}
#endregion
#region DocFXHelpSettingsExtensions
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
public static partial class DocFXHelpSettingsExtensions
@@ -1230,7 +1210,7 @@ [Pure] [Builder(Type = typeof(DocFXHelpSettings), Property = nameof(DocFXHelpSet
}
#endregion
#region DocFXInitSettingsExtensions
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
public static partial class DocFXInitSettingsExtensions
@@ -1330,7 +1310,7 @@ [Pure] [Builder(Type = typeof(DocFXInitSettings), Property = nameof(DocFXInitSet
}
#endregion
#region DocFXMergeSettingsExtensions
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
public static partial class DocFXMergeSettingsExtensions
@@ -1482,7 +1462,7 @@ [Pure] [Builder(Type = typeof(DocFXMergeSettings), Property = nameof(DocFXMergeS
}
#endregion
#region DocFXMetadataSettingsExtensions
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
public static partial class DocFXMetadataSettingsExtensions
@@ -1705,7 +1685,7 @@ [Pure] [Builder(Type = typeof(DocFXMetadataSettings), Property = nameof(DocFXMet
}
#endregion
#region DocFXPdfSettingsExtensions
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
public static partial class DocFXPdfSettingsExtensions
@@ -2464,7 +2444,7 @@ [Pure] [Builder(Type = typeof(DocFXPdfSettings), Property = nameof(DocFXPdfSetti
}
#endregion
#region DocFXServeSettingsExtensions
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
public static partial class DocFXServeSettingsExtensions
@@ -2513,7 +2493,7 @@ [Pure] [Builder(Type = typeof(DocFXServeSettings), Property = nameof(DocFXServeS
}
#endregion
#region DocFXTemplateSettingsExtensions
-/// Used within .
+///
[PublicAPI]
[ExcludeFromCodeCoverage]
public static partial class DocFXTemplateSettingsExtensions
diff --git a/source/Nuke.Common/Tools/Docker/Docker.Generated.cs b/source/Nuke.Common/Tools/Docker/Docker.Generated.cs
index 9909ff519..b5759aa9e 100644
--- a/source/Nuke.Common/Tools/Docker/Docker.Generated.cs
+++ b/source/Nuke.Common/Tools/Docker/Docker.Generated.cs
@@ -23,1705 +23,1329 @@ namespace Nuke.Common.Tools.Docker;
[PathTool(Executable = PathExecutable)]
public partial class DockerTasks : ToolTasks, IRequirePathTool
{
- public static string DockerPath => new DockerTasks().GetToolPath();
+ public static string DockerPath { get => new DockerTasks().GetToolPathInternal(); set => new DockerTasks().SetToolPath(value); }
public const string PathExecutable = "docker";
/// Docker is an open platform for developing, shipping, and running applications. Docker enables you to separate your applications from your infrastructure so you can deliver software quickly. With Docker, you can manage your infrastructure in the same ways you manage your applications. By taking advantage of Docker’s methodologies for shipping, testing, and deploying code quickly, you can significantly reduce the delay between writing code and running it in production.
For more details, visit the official website.
public static IReadOnlyCollection Docker(ArgumentStringHandler arguments, string workingDirectory = null, IReadOnlyDictionary environmentVariables = null, int? timeout = null, bool? logOutput = null, bool? logInvocation = null, Action logger = null, Func exitHandler = null) => new DockerTasks().Run(arguments, workingDirectory, environmentVariables, timeout, logOutput, logInvocation, logger, exitHandler);
/// Remove one or more configs.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <configs> via
- --config via
- --debug via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
- public static IReadOnlyCollection DockerConfigRm(DockerConfigRmSettings options = null) => new DockerTasks().Run(options);
- /// Remove one or more configs.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <configs> via
- --config via
- --debug via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
- public static IReadOnlyCollection DockerConfigRm(Configure configurator) => new DockerTasks().Run(configurator.Invoke(new DockerConfigRmSettings()));
- /// Remove one or more configs.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <configs> via
- --config via
- --debug via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <configs> via
- --config via
- --debug via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
+ public static IReadOnlyCollection DockerConfigRm(DockerConfigRmSettings options = null) => new DockerTasks().Run(options);
+ ///
+ public static IReadOnlyCollection DockerConfigRm(Configure configurator) => new DockerTasks().Run(configurator.Invoke(new DockerConfigRmSettings()));
+ ///
public static IEnumerable<(DockerConfigRmSettings Settings, IReadOnlyCollection Output)> DockerConfigRm(CombinatorialConfigure configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(DockerConfigRm, degreeOfParallelism, completeOnFailure);
/// Load an image from a tar archive or STDIN.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --input via
- --log-level via
- --quiet via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
- public static IReadOnlyCollection DockerLoad(DockerLoadSettings options = null) => new DockerTasks().Run(options);
- /// Load an image from a tar archive or STDIN.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --input via
- --log-level via
- --quiet via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
- public static IReadOnlyCollection DockerLoad(Configure configurator) => new DockerTasks().Run(configurator.Invoke(new DockerLoadSettings()));
- /// Load an image from a tar archive or STDIN.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --input via
- --log-level via
- --quiet via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --input via
- --log-level via
- --quiet via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
+ public static IReadOnlyCollection DockerLoad(DockerLoadSettings options = null) => new DockerTasks().Run(options);
+ ///
+ public static IReadOnlyCollection DockerLoad(Configure configurator) => new DockerTasks().Run(configurator.Invoke(new DockerLoadSettings()));
+ ///
public static IEnumerable<(DockerLoadSettings Settings, IReadOnlyCollection Output)> DockerLoad(CombinatorialConfigure configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(DockerLoad, degreeOfParallelism, completeOnFailure);
/// Remove all stopped containers.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --filter via
- --force via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
- public static IReadOnlyCollection DockerContainerPrune(DockerContainerPruneSettings options = null) => new DockerTasks().Run(options);
- /// Remove all stopped containers.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --filter via
- --force via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
- public static IReadOnlyCollection DockerContainerPrune(Configure configurator) => new DockerTasks().Run(configurator.Invoke(new DockerContainerPruneSettings()));
- /// Remove all stopped containers.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --filter via
- --force via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --filter via
- --force via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
+ public static IReadOnlyCollection DockerContainerPrune(DockerContainerPruneSettings options = null) => new DockerTasks().Run(options);
+ ///
+ public static IReadOnlyCollection DockerContainerPrune(Configure configurator) => new DockerTasks().Run(configurator.Invoke(new DockerContainerPruneSettings()));
+ ///
public static IEnumerable<(DockerContainerPruneSettings Settings, IReadOnlyCollection Output)> DockerContainerPrune(CombinatorialConfigure configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(DockerContainerPrune, degreeOfParallelism, completeOnFailure);
/// Manage trust on Docker images.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
- public static IReadOnlyCollection DockerTrust(DockerTrustSettings options = null) => new DockerTasks().Run(options);
- /// Manage trust on Docker images.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
- public static IReadOnlyCollection DockerTrust(Configure configurator) => new DockerTasks().Run(configurator.Invoke(new DockerTrustSettings()));
- /// Manage trust on Docker images.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
+ public static IReadOnlyCollection DockerTrust(DockerTrustSettings options = null) => new DockerTasks().Run(options);
+ ///
+ public static IReadOnlyCollection DockerTrust(Configure configurator) => new DockerTasks().Run(configurator.Invoke(new DockerTrustSettings()));
+ ///
public static IEnumerable<(DockerTrustSettings Settings, IReadOnlyCollection Output)> DockerTrust(CombinatorialConfigure configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(DockerTrust, degreeOfParallelism, completeOnFailure);
/// Manage Docker stacks.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --kubeconfig via
- --log-level via
- --orchestrator via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
- public static IReadOnlyCollection DockerStack(DockerStackSettings options = null) => new DockerTasks().Run(options);
- /// Manage Docker stacks.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --kubeconfig via
- --log-level via
- --orchestrator via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
- public static IReadOnlyCollection DockerStack(Configure configurator) => new DockerTasks().Run(configurator.Invoke(new DockerStackSettings()));
- /// Manage Docker stacks.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --kubeconfig via
- --log-level via
- --orchestrator via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --kubeconfig via
- --log-level via
- --orchestrator via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
+ public static IReadOnlyCollection DockerStack(DockerStackSettings options = null) => new DockerTasks().Run(options);
+ ///
+ public static IReadOnlyCollection DockerStack(Configure configurator) => new DockerTasks().Run(configurator.Invoke(new DockerStackSettings()));
+ ///
public static IEnumerable<(DockerStackSettings Settings, IReadOnlyCollection Output)> DockerStack(CombinatorialConfigure configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(DockerStack, degreeOfParallelism, completeOnFailure);
/// Display the running processes of a container.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <container> via
- <options> via
- --config via
- --debug via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
- public static IReadOnlyCollection DockerTop(DockerTopSettings options = null) => new DockerTasks().Run(options);
- /// Display the running processes of a container.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <container> via
- <options> via
- --config via
- --debug via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
- public static IReadOnlyCollection DockerTop(Configure configurator) => new DockerTasks().Run(configurator.Invoke(new DockerTopSettings()));
- /// Display the running processes of a container.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <container> via
- <options> via
- --config via
- --debug via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <container> via
- <options> via
- --config via
- --debug via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
+ public static IReadOnlyCollection DockerTop(DockerTopSettings options = null) => new DockerTasks().Run(options);
+ ///
+ public static IReadOnlyCollection DockerTop(Configure configurator) => new DockerTasks().Run(configurator.Invoke(new DockerTopSettings()));
+ ///
public static IEnumerable<(DockerTopSettings Settings, IReadOnlyCollection Output)> DockerTop(CombinatorialConfigure configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(DockerTop, degreeOfParallelism, completeOnFailure);
/// Pull an image or a repository from a registry.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <name> via
- --all-tags via
- --config via
- --debug via
- --disable-content-trust via
- --log-level via
- --platform via
- --quiet via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
- public static IReadOnlyCollection DockerPull(DockerPullSettings options = null) => new DockerTasks().Run(options);
- /// Pull an image or a repository from a registry.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <name> via
- --all-tags via
- --config via
- --debug via
- --disable-content-trust via
- --log-level via
- --platform via
- --quiet via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
- public static IReadOnlyCollection DockerPull(Configure configurator) => new DockerTasks().Run(configurator.Invoke(new DockerPullSettings()));
- /// Pull an image or a repository from a registry.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <name> via
- --all-tags via
- --config via
- --debug via
- --disable-content-trust via
- --log-level via
- --platform via
- --quiet via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- <name> via
- --all-tags via
- --config via
- --debug via
- --disable-content-trust via
- --log-level via
- --platform via
- --quiet via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
+ public static IReadOnlyCollection DockerPull(DockerPullSettings options = null) => new DockerTasks().Run(options);
+ ///
+ public static IReadOnlyCollection DockerPull(Configure configurator) => new DockerTasks().Run(configurator.Invoke(new DockerPullSettings()));
+ ///
public static IEnumerable<(DockerPullSettings Settings, IReadOnlyCollection Output)> DockerPull(CombinatorialConfigure configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(DockerPull, degreeOfParallelism, completeOnFailure);
/// Sign an image.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
- public static IReadOnlyCollection DockerTrustSign(DockerTrustSignSettings options = null) => new DockerTasks().Run(options);
- /// Sign an image.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
- public static IReadOnlyCollection DockerTrustSign(Configure configurator) => new DockerTasks().Run(configurator.Invoke(new DockerTrustSignSettings()));
- /// Sign an image.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
+ public static IReadOnlyCollection DockerTrustSign(DockerTrustSignSettings options = null) => new DockerTasks().Run(options);
+ ///
+ public static IReadOnlyCollection DockerTrustSign(Configure configurator) => new DockerTasks().Run(configurator.Invoke(new DockerTrustSignSettings()));
+ ///
public static IEnumerable<(DockerTrustSignSettings Settings, IReadOnlyCollection Output)> DockerTrustSign(CombinatorialConfigure configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(DockerTrustSign, degreeOfParallelism, completeOnFailure);
/// Manage checkpoints.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
- public static IReadOnlyCollection DockerCheckpoint(DockerCheckpointSettings options = null) => new DockerTasks().Run(options);
- /// Manage checkpoints.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
- public static IReadOnlyCollection DockerCheckpoint(Configure configurator) => new DockerTasks().Run(configurator.Invoke(new DockerCheckpointSettings()));
- /// Manage checkpoints.
For more details, visit the official website.
- /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
+ /// This is a CLI wrapper with fluent API that allows to modify the following arguments:
- --config via
- --debug via
- --log-level via
- --tls via
- --tlscacert via
- --tlscert via
- --tlskey via
- --tlsverify via
+ public static IReadOnlyCollection DockerCheckpoint(DockerCheckpointSettings options = null) => new DockerTasks().Run(options);
+ ///
+ public static IReadOnlyCollection DockerCheckpoint(Configure configurator) => new DockerTasks().Run(configurator.Invoke(new DockerCheckpointSettings()));
+ ///
public static IEnumerable<(DockerCheckpointSettings Settings, IReadOnlyCollection Output)> DockerCheckpoint(CombinatorialConfigure