Downloads:
65,681
Downloads of v 1.3.0:
3,816
Last Update:
07 Oct 2021
Package Maintainer(s):
- gep13
- patriksvensson
- agc93
- mholo65
- daveaglick
- nilsandresen
- augustoproiete
- devlead
- cake-build
- pascalberger
Software Author(s):
- Patrik Svensson
- Mattias Karlsson
- Gary Ewan Park
- Alistair Chapman
- Martin Björkström
- Dave Glick
- Pascal Berger
- Jérémie Desautels
- Enrico Campidoglio
- C. Augusto Proiete
- Nils Andresen
- and contributors
Tags:
cake script build- Software Specific:
- Software Site
- Software Source
- Software License
- Software Docs
- Software Issues
- Package Specific:
- Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
Cake.Portable
- 1
- 2
- 3
1.3.0 | Updated: 07 Oct 2021
- Software Specific:
- Software Site
- Software Source
- Software License
- Software Docs
- Software Issues
- Package Specific:
- Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
Downloads:
65,681
Downloads of v 1.3.0:
3,816
Maintainer(s):
Software Author(s):
- Patrik Svensson
- Mattias Karlsson
- Gary Ewan Park
- Alistair Chapman
- Martin Björkström
- Dave Glick
- Pascal Berger
- Jérémie Desautels
- Enrico Campidoglio
- C. Augusto Proiete
- Nils Andresen
- and contributors
Cake.Portable 1.3.0
Legal Disclaimer: Neither this package nor Chocolatey Software, Inc. are affiliated with or endorsed by Patrik Svensson, Mattias Karlsson, Gary Ewan Park, Alistair Chapman, Martin Björkström, Dave Glick, Pascal Berger, Jérémie Desautels, Enrico Campidoglio, C. Augusto Proiete, Nils Andresen, and contributors. The inclusion of Patrik Svensson, Mattias Karlsson, Gary Ewan Park, Alistair Chapman, Martin Björkström, Dave Glick, Pascal Berger, Jérémie Desautels, Enrico Campidoglio, C. Augusto Proiete, Nils Andresen, and contributors trademark(s), if any, upon this webpage is solely to identify Patrik Svensson, Mattias Karlsson, Gary Ewan Park, Alistair Chapman, Martin Björkström, Dave Glick, Pascal Berger, Jérémie Desautels, Enrico Campidoglio, C. Augusto Proiete, Nils Andresen, and contributors goods or services and not for commercial purposes.
- 1
- 2
- 3
All Checks are Passing
3 Passing Tests
Deployment Method: Individual Install, Upgrade, & Uninstall
To install Cake.Portable, run the following command from the command line or from PowerShell:
To upgrade Cake.Portable, run the following command from the command line or from PowerShell:
To uninstall Cake.Portable, run the following command from the command line or from PowerShell:
Deployment Method:
This applies to both open source and commercial editions of Chocolatey.
1. Enter Your Internal Repository Url
(this should look similar to https://community.chocolatey.org/api/v2/)
2. Setup Your Environment
1. Ensure you are set for organizational deployment
Please see the organizational deployment guide
2. Get the package into your environment
Option 1: Cached Package (Unreliable, Requires Internet - Same As Community)-
Open Source or Commercial:
- Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
- You can also just download the package and push it to a repository Download
-
Open Source
-
Download the package:
Download - Follow manual internalization instructions
-
-
Package Internalizer (C4B)
-
Run: (additional options)
choco download cake.portable --internalize --source=https://community.chocolatey.org/api/v2/
-
For package and dependencies run:
choco push --source="'INTERNAL REPO URL'"
- Automate package internalization
-
Run: (additional options)
3. Copy Your Script
choco upgrade cake.portable -y --source="'INTERNAL REPO URL'" [other options]
See options you can pass to upgrade.
See best practices for scripting.
Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.
If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:
choco upgrade cake.portable -y --source="'INTERNAL REPO URL'"
$exitCode = $LASTEXITCODE
Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
Exit 0
}
Exit $exitCode
- name: Install cake.portable
win_chocolatey:
name: cake.portable
version: '1.3.0'
source: INTERNAL REPO URL
state: present
See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.
chocolatey_package 'cake.portable' do
action :install
source 'INTERNAL REPO URL'
version '1.3.0'
end
See docs at https://docs.chef.io/resource_chocolatey_package.html.
cChocoPackageInstaller cake.portable
{
Name = "cake.portable"
Version = "1.3.0"
Source = "INTERNAL REPO URL"
}
Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.
package { 'cake.portable':
ensure => '1.3.0',
provider => 'chocolatey',
source => 'INTERNAL REPO URL',
}
Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.
4. If applicable - Chocolatey configuration/installation
See infrastructure management matrix for Chocolatey configuration elements and examples.
This package is likely a meta/virtual (*) or an installer (*.install) or portable (*.portable) application package.
- Meta/virtual (*) - has a dependency on the *.install or the *.portable package - it is provided for discoverability and for other packages to take a dependency on.
- Portable (*.portable/*.commandline (deprecated naming convention)/*.tool (deprecated naming convention)) - usually zips or archives that require no administrative access to install.
- Install (*.install/*.app (deprecated naming convention)) - uses native installers, usually requires administrative access to install.
Learn more about chocolatey's distinction of installed versus portable apps and/or learn about this kind of package.
This package was approved as a trusted package on 23 Nov 2024.
The Cake script runner.
md5: B15629E60CCE8152376EDB4C4796952B | sha1: C2CD5E2C3FF6C8C7015FA40E3DD72818660EED67 | sha256: 429B5E05E81115D6FC8CAD42DCCFAA96E71A67BCA98CC1BE32DCF52CBCABA0B7 | sha512: AAAF28728A157751D6335ACC094C8319B0201E2D985CCC05C29A77C102FFFE6416BD1CE5C2C49AE897FCD69222667CEF5C7B0DE66E513B7F35FA483A8C29CE8D
md5: 000E7BDED1FECDEC63097B4A4B27E7AD | sha1: E721CF4E07C6821C882B3EB42C4A82E56C676FF3 | sha256: 52953EA8DB0C474C67682C264FDDD28B99201AAAF45DA773E0A6BEEA0676C68B | sha512: 6CD62170FCC7F922D1F2F1B9301EBA01CE91F97C0807D524624223CB0712A10C2BB817754E593C69F8A34D90887870F5A97B7807978F12694F841F5D67154462
<?xml version="1.0"?>
<doc>
<assembly>
<name>Cake.Cli</name>
</assembly>
<members>
<member name="T:Cake.Cli.ICakeInfoFeature">
<summary>
Represents a feature that writes information about Cake to the console.
</summary>
</member>
<member name="M:Cake.Cli.ICakeInfoFeature.Run(Cake.Core.IConsole)">
<summary>
Runs the feature.
</summary>
<param name="console">The console to write to.</param>
</member>
<member name="T:Cake.Cli.InfoFeature">
<summary>
Writes information about Cake to the console.
</summary>
</member>
<member name="M:Cake.Cli.InfoFeature.#ctor(Cake.Cli.IVersionResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Cli.InfoFeature"/> class.
</summary>
<param name="resolver">The version resolver.</param>
</member>
<member name="M:Cake.Cli.InfoFeature.Run(Cake.Core.IConsole)">
<inheritdoc/>
</member>
<member name="T:Cake.Cli.ICakeVersionFeature">
<summary>
Represents a feature that writes the Cake version to the console.
</summary>
</member>
<member name="M:Cake.Cli.ICakeVersionFeature.Run(Cake.Core.IConsole)">
<summary>
Writes the Cake version to the console.
</summary>
<param name="console">The console to write to.</param>
</member>
<member name="T:Cake.Cli.VersionFeature">
<summary>
Writes the Cake version to the console.
</summary>
</member>
<member name="M:Cake.Cli.VersionFeature.#ctor(Cake.Cli.IVersionResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Cli.VersionFeature"/> class.
</summary>
<param name="resolver">The version resolver.</param>
</member>
<member name="M:Cake.Cli.VersionFeature.Run(Cake.Core.IConsole)">
<inheritdoc/>
</member>
<member name="T:Cake.Cli.IVersionResolver">
<summary>
Represents a version resolver.
</summary>
</member>
<member name="M:Cake.Cli.IVersionResolver.GetVersion">
<summary>
Gets the version.
</summary>
<returns>The version.</returns>
</member>
<member name="M:Cake.Cli.IVersionResolver.GetProductVersion">
<summary>
Gets the product version.
</summary>
<returns>The product version.</returns>
</member>
<member name="T:Cake.Cli.VersionResolver">
<summary>
The Cake version resolver.
</summary>
</member>
<member name="M:Cake.Cli.VersionResolver.GetVersion">
<inheritdoc/>
</member>
<member name="M:Cake.Cli.VersionResolver.GetProductVersion">
<inheritdoc/>
</member>
<member name="T:Cake.Cli.BuildScriptHost">
<summary>
The script host used to execute Cake scripts.
</summary>
</member>
<member name="M:Cake.Cli.BuildScriptHost.#ctor(Cake.Core.ICakeEngine,Cake.Core.IExecutionStrategy,Cake.Core.ICakeContext,Cake.Core.ICakeReportPrinter,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Cli.BuildScriptHost"/> class.
</summary>
<param name="engine">The engine.</param>
<param name="executionStrategy">The execution strategy.</param>
<param name="context">The context.</param>
<param name="reportPrinter">The report printer.</param>
<param name="log">The log.</param>
</member>
<member name="T:Cake.Cli.BuildScriptHost`1">
<summary>
The script host used to execute Cake scripts.
</summary>
<typeparam name="TContext">The context type.</typeparam>
</member>
<member name="M:Cake.Cli.BuildScriptHost`1.#ctor(Cake.Core.ICakeEngine,Cake.Core.IExecutionStrategy,`0,Cake.Core.ICakeReportPrinter,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Cli.BuildScriptHost`1"/> class.
</summary>
<param name="engine">The engine.</param>
<param name="executionStrategy">The execution strategy.</param>
<param name="context">The context.</param>
<param name="reportPrinter">The report printer.</param>
<param name="log">The log.</param>
</member>
<member name="M:Cake.Cli.BuildScriptHost`1.RunTargetAsync(System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Cli.DescriptionScriptHost">
<summary>
The script host used for showing task descriptions.
</summary>
</member>
<member name="M:Cake.Cli.DescriptionScriptHost.#ctor(Cake.Core.ICakeEngine,Cake.Core.ICakeContext,Cake.Core.IConsole)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Cli.DescriptionScriptHost"/> class.
</summary>
<param name="engine">The engine.</param>
<param name="context">The context.</param>
<param name="console">The console.</param>
</member>
<member name="M:Cake.Cli.DescriptionScriptHost.RunTargetAsync(System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Cli.DryRunScriptHost">
<summary>
The script host used to dry run Cake scripts.
</summary>
</member>
<member name="M:Cake.Cli.DryRunScriptHost.#ctor(Cake.Core.ICakeEngine,Cake.Core.ICakeContext,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Cli.DryRunScriptHost"/> class.
</summary>
<param name="engine">The engine.</param>
<param name="context">The context.</param>
<param name="log">The log.</param>
</member>
<member name="T:Cake.Cli.DryRunScriptHost`1">
<summary>
The script host used to dry run Cake scripts.
</summary>
<typeparam name="TContext">The context.</typeparam>
</member>
<member name="M:Cake.Cli.DryRunScriptHost`1.#ctor(Cake.Core.ICakeEngine,`0,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Cli.DryRunScriptHost`1"/> class.
</summary>
<param name="engine">The engine.</param>
<param name="context">The context.</param>
<param name="log">The log.</param>
</member>
<member name="M:Cake.Cli.DryRunScriptHost`1.RunTargetAsync(System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Cli.TreeScriptHost">
<summary>
The script host used for showing task descriptions.
</summary>
</member>
<member name="M:Cake.Cli.TreeScriptHost.#ctor(Cake.Core.ICakeEngine,Cake.Core.ICakeContext,Cake.Core.IConsole)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Cli.TreeScriptHost"/> class.
</summary>
<param name="engine">The engine.</param>
<param name="context">The context.</param>
<param name="console">The console.</param>
</member>
<member name="M:Cake.Cli.TreeScriptHost.RunTargetAsync(System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Cli.ExceptionLogger">
<summary>
Exception logging extension methods for the ICakeLog.
</summary>
</member>
<member name="M:Cake.Cli.ExceptionLogger.LogException``1(Cake.Core.Diagnostics.ICakeLog,``0)">
<summary>
Logs exception and returns exit code if available in exception.
</summary>
<typeparam name="T">The exception type.</typeparam>
<param name="log">The log.</param>
<param name="ex">The exception.</param>
<returns>1 or exit code provided by <see cref="P:Cake.Core.CakeException.ExitCode"/>.</returns>
</member>
<member name="T:Cake.Cli.FilePathConverter">
<summary>
A type converter for <see cref="T:Cake.Core.IO.FilePath"/>.
</summary>
</member>
<member name="M:Cake.Cli.FilePathConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
<inheritdoc/>
</member>
<member name="T:Cake.Cli.DirectoryPathConverter">
<summary>
A type converter for <see cref="T:Cake.Core.IO.DirectoryPath"/>.
</summary>
</member>
<member name="M:Cake.Cli.DirectoryPathConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
<inheritdoc/>
</member>
<member name="T:Cake.Cli.VerbosityConverter">
<summary>
A type converter for <see cref="T:Cake.Core.Diagnostics.Verbosity"/>.
</summary>
</member>
<member name="M:Cake.Cli.VerbosityConverter.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Cli.VerbosityConverter"/> class.
</summary>
</member>
<member name="M:Cake.Cli.VerbosityConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
<inheritdoc/>
</member>
</members>
</doc>
md5: 4E51667CBD2BDABC08536AE2F1894009 | sha1: D8E13494137EBB716BDCB3D595C3EEA201992716 | sha256: 3149FD4469B77903C27BDBDA40DC7FF7C54191DB8F8C1C73CA5B48455BDB8BCE | sha512: 03DCBDBCD363C99815AA4A25B0FA0BCD9DB601CA27CD8DB7F9D611E2440A8F10DA82A2C2066482E2701EF8FED71205FF4EAFCAE1D579712EFE19279D340DD7C8
<?xml version="1.0"?>
<doc>
<assembly>
<name>Cake.Common</name>
</assembly>
<members>
<member name="T:Cake.Common.ArgumentAliases">
<summary>
Contains functionality related to arguments.
</summary>
</member>
<member name="M:Cake.Common.ArgumentAliases.HasArgument(Cake.Core.ICakeContext,System.String)">
<summary>
Determines whether or not the specified argument exist.
</summary>
<param name="context">The context.</param>
<param name="name">The argument name.</param>
<returns>Whether or not the specified argument exist.</returns>
<example>
This sample shows how to call the <see cref="M:Cake.Common.ArgumentAliases.HasArgument(Cake.Core.ICakeContext,System.String)"/> method.
<code>
var argumentName = "myArgument";
// Cake.exe .\hasargument.cake -myArgument="is specified"
if (HasArgument(argumentName))
{
Information("{0} is specified", argumentName);
}
// Cake.exe .\hasargument.cake
else
{
Warning("{0} not specified", argumentName);
}
</code>
</example>
</member>
<member name="M:Cake.Common.ArgumentAliases.Argument``1(Cake.Core.ICakeContext,System.String)">
<summary>
Gets an argument and throws if the argument is missing.
</summary>
<typeparam name="T">The argument type.</typeparam>
<param name="context">The context.</param>
<param name="name">The argument name.</param>
<returns>The value of the argument.</returns>
<example>
<code>
// Cake.exe .\argument.cake --myArgument="is valid" --loopCount=5
Information("Argument {0}", Argument<string>("myArgument"));
var loopCount = Argument<int>("loopCount");
for(var index = 0;index<loopCount; index++)
{
Information("Index {0}", index);
}
</code>
</example>
<exception cref="T:Cake.Core.CakeException">Argument value is null.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="context"/> is null.</exception>
</member>
<member name="M:Cake.Common.ArgumentAliases.Arguments``1(Cake.Core.ICakeContext,System.String)">
<summary>
Gets all arguments with the specific name and throws if the argument is missing.
</summary>
<typeparam name="T">The argument type.</typeparam>
<param name="context">The context.</param>
<param name="name">The argument name.</param>
<returns>The argument values.</returns>
<example>
<code>
// Cake.exe .\argument.cake --foo="foo" --foo="bar"
var arguments = Arguments<string>("foo");
Information("Arguments: {0}", string.Join(", ", arguments));
</code>
</example>
</member>
<member name="M:Cake.Common.ArgumentAliases.Arguments``1(Cake.Core.ICakeContext,System.String,``0)">
<summary>
Gets all arguments with the specific name and returns the
provided <paramref name="defaultValue"/> if the argument is missing.
</summary>
<typeparam name="T">The argument type.</typeparam>
<param name="context">The context.</param>
<param name="name">The argument name.</param>
<param name="defaultValue">The value to return if the argument is missing.</param>
<returns>The argument values.</returns>
<example>
<code>
// Cake.exe .\argument.cake --foo="foo" --foo="bar"
var arguments = Arguments<string>("foo", "default");
Information("Arguments: {0}", string.Join(", ", arguments));
</code>
</example>
</member>
<member name="M:Cake.Common.ArgumentAliases.Argument``1(Cake.Core.ICakeContext,System.String,``0)">
<summary>
Gets an argument and returns the provided <paramref name="defaultValue"/> if the argument is missing.
</summary>
<typeparam name="T">The argument type.</typeparam>
<param name="context">The context.</param>
<param name="name">The argument name.</param>
<param name="defaultValue">The value to return if the argument is missing.</param>
<returns>The value of the argument if it exist; otherwise <paramref name="defaultValue"/>.</returns>
<example>
<code>
// Cake.exe .\argument.cake --myArgument="is valid" --loopCount=5
Information("Argument {0}", Argument<string>("myArgument", "is NOT valid"));
var loopCount = Argument<int>("loopCount", 10);
for(var index = 0;index<loopCount; index++)
{
Information("Index {0}", index);
}
</code>
</example>
</member>
<member name="M:Cake.Common.ArgumentAliases.Arguments(Cake.Core.ICakeContext)">
<summary>
Retrieves all command line arguments.
</summary>
<example>
<code>
var args = context.Arguments();
if (args.ContainsKey("verbose"))
{
Information("Verbose output enabled");
}
foreach(var arg in args)
{
Information(
"Key: {0}\tValue: \"{1}\"",
arg.Key,
string.Join(";", arg.Value)
);
}
</code>
</example>
<param name="context">The context.</param>
<returns>The command line arguments.</returns>
</member>
<member name="T:Cake.Common.Build.AppVeyor.AppVeyorInfo">
<summary>
Base class used to provide information about the AppVeyor environment.
</summary>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AppVeyor.AppVeyorInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="T:Cake.Common.Build.AppVeyor.AppVeyorMessageCategoryType">
<summary>
AppVeyor AddMessage categories.
</summary>
</member>
<member name="F:Cake.Common.Build.AppVeyor.AppVeyorMessageCategoryType.Information">
<summary>
Informational message
</summary>
</member>
<member name="F:Cake.Common.Build.AppVeyor.AppVeyorMessageCategoryType.Warning">
<summary>
Warning message
</summary>
</member>
<member name="F:Cake.Common.Build.AppVeyor.AppVeyorMessageCategoryType.Error">
<summary>
Error message
</summary>
</member>
<member name="T:Cake.Common.Build.AppVeyor.AppVeyorProvider">
<summary>
Responsible for communicating with AppVeyor.
</summary>
</member>
<member name="P:Cake.Common.Build.AppVeyor.AppVeyorProvider.IsRunningOnAppVeyor">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.AppVeyor.AppVeyorProvider.Environment">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorProvider.#ctor(Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AppVeyor.AppVeyorProvider"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="log">The cake log.</param>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorProvider.UploadArtifact(Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorProvider.UploadArtifact(Cake.Core.IO.FilePath,Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactsSettings)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorProvider.UploadArtifact(Cake.Core.IO.FilePath,System.Action{Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactsSettings})">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorProvider.UploadTestResults(Cake.Core.IO.FilePath,Cake.Common.Build.AppVeyor.AppVeyorTestResultsType)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorProvider.UpdateBuildVersion(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorProvider.AddMessage(System.String,Cake.Common.Build.AppVeyor.AppVeyorMessageCategoryType,System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.AppVeyor.AppVeyorProviderAddMessageExtensions">
<summary>
AddMessage extension methods for the IAppVeyorProvider.
</summary>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorProviderAddMessageExtensions.AddInformationalMessage(Cake.Common.Build.AppVeyor.IAppVeyorProvider,System.String,System.Object[])">
<summary>
Adds an informational message to the AppVeyor build log.
</summary>
<param name="provider">The AppVeyor provider.</param>
<param name="format">The message.</param>
<param name="args">The args.</param>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorProviderAddMessageExtensions.AddWarningMessage(Cake.Common.Build.AppVeyor.IAppVeyorProvider,System.String,System.Object[])">
<summary>
Adds a warning message to the AppVeyor build log.
</summary>
<param name="provider">The AppVeyor provider.</param>
<param name="format">The message.</param>
<param name="args">The args.</param>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorProviderAddMessageExtensions.AddErrorMessage(Cake.Common.Build.AppVeyor.IAppVeyorProvider,System.String,System.Object[])">
<summary>
Adds a warning message to the AppVeyor build log.
</summary>
<param name="provider">The AppVeyor provider.</param>
<param name="format">The message.</param>
<param name="args">The args.</param>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorProviderAddMessageExtensions.AddErrorMessage(Cake.Common.Build.AppVeyor.IAppVeyorProvider,System.String,System.Exception)">
<summary>
Adds a warning message to the AppVeyor build log.
</summary>
<param name="provider">The AppVeyor provider.</param>
<param name="message">The message.</param>
<param name="exception">The exception.</param>
</member>
<member name="T:Cake.Common.Build.AppVeyor.AppVeyorTestResultsType">
<summary>
Provides the known values for the AppVeyor test results types.
</summary>
</member>
<member name="F:Cake.Common.Build.AppVeyor.AppVeyorTestResultsType.MSTest">
<summary>
MSTest test results.
</summary>
</member>
<member name="F:Cake.Common.Build.AppVeyor.AppVeyorTestResultsType.XUnit">
<summary>
XUnit test results.
</summary>
</member>
<member name="F:Cake.Common.Build.AppVeyor.AppVeyorTestResultsType.NUnit">
<summary>
NUnit test results.
</summary>
</member>
<member name="F:Cake.Common.Build.AppVeyor.AppVeyorTestResultsType.NUnit3">
<summary>
NUnit v3 test results.
</summary>
</member>
<member name="F:Cake.Common.Build.AppVeyor.AppVeyorTestResultsType.JUnit">
<summary>
JUnit test results.
</summary>
</member>
<member name="T:Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactsSettings">
<summary>
AppVeyor upload artifacts settings.
</summary>
</member>
<member name="P:Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactsSettings.ArtifactType">
<summary>
Gets or sets a value indicating the type of artifact being uploaded to AppVeyor.
</summary>
</member>
<member name="P:Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactsSettings.DeploymentName">
<summary>
Gets or sets a value indicating a deployment name to set for the uploaded artifact.
</summary>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactsSettings.SetArtifactType(Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactType)">
<summary>
Sets the type of artifact being uploaded to AppVeyor.
</summary>
<param name="type">The type of artifact being uploaded.</param>
<returns>The settings.</returns>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactsSettings.SetDeploymentName(System.String)">
<summary>
Sets the deployment name.
</summary>
<param name="deploymentName">The deployment name to attach to the artifact, required when using the AppVeyor deployment agent. <paramref name="deploymentName"/> should not have any spaces.</param>
<returns>The settings.</returns>
</member>
<member name="T:Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactType">
<summary>
Provides the known artifact upload types for the AppVeyor.
</summary>
</member>
<member name="F:Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactType.Auto">
<summary>
Automatically deploy artifact type
</summary>
</member>
<member name="F:Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactType.WebDeployPackage">
<summary>
The artifact is a web deploy package (.zip)
</summary>
</member>
<member name="F:Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactType.NuGetPackage">
<summary>
The artifact is a NuGet package (.nupkg)
</summary>
</member>
<member name="T:Cake.Common.Build.AppVeyor.Data.AppVeyorBuildInfo">
<summary>
Provides AppVeyor build information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorBuildInfo.Folder">
<summary>
Gets the path to the clone directory.
</summary>
<value>
The path to the clone directory.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorBuildInfo.Id">
<summary>
Gets the AppVeyor unique build ID.
</summary>
<value>
The AppVeyor unique build ID.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorBuildInfo.Number">
<summary>
Gets the build number.
</summary>
<value>
The build number.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorBuildInfo.Version">
<summary>
Gets the build version.
</summary>
<value>
The build version.
</value>
</member>
<member name="M:Cake.Common.Build.AppVeyor.Data.AppVeyorBuildInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AppVeyor.Data.AppVeyorBuildInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.AppVeyor.Data.AppVeyorCommitInfo">
<summary>
Provides AppVeyor commit information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorCommitInfo.Id">
<summary>
Gets commit ID (SHA).
</summary>
<value>
The commit ID (SHA).
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorCommitInfo.Author">
<summary>
Gets the commit author's name.
</summary>
<value>
The commit author's name.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorCommitInfo.Email">
<summary>
Gets the commit author's email address.
</summary>
<value>
The commit author's email address.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorCommitInfo.Timestamp">
<summary>
Gets the commit date/time.
</summary>
<value>
The commit date/time.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorCommitInfo.Message">
<summary>
Gets the commit message.
</summary>
<value>
The commit message.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorCommitInfo.ExtendedMessage">
<summary>
Gets the rest of commit message after line break (if exists).
</summary>
<value>
The rest of commit message after line break (if exists).
</value>
</member>
<member name="M:Cake.Common.Build.AppVeyor.Data.AppVeyorCommitInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AppVeyor.Data.AppVeyorCommitInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo">
<summary>
Provides AppVeyor environment information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo.ApiUrl">
<summary>
Gets the AppVeyor build agent API URL.
</summary>
<value>
The AppVeyor build agent API URL.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"API URL:{0},
BuildSystem.AppVeyor.Environment.ApiUrl
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"API URL:{0},
AppVeyor.Environment.ApiUrl
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo.JobId">
<summary>
Gets the AppVeyor unique job ID.
</summary>
<value>
The AppVeyor unique job ID.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Job Id:{0},
BuildSystem.AppVeyor.Environment.JobId
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Job Id:{0},
AppVeyor.Environment.JobId
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo.JobName">
<summary>
Gets the AppVeyor Job Name.
</summary>
<value>
The AppVeyor Job Name.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Job Name:{0},
BuildSystem.AppVeyor.Environment.JobName
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Job Name:{0},
AppVeyor.Environment.JobName
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo.ScheduledBuild">
<summary>
Gets a value indicating whether the build runs by scheduler.
</summary>
<value>
<c>true</c> if the build runs by scheduler; otherwise, <c>false</c>.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Scheduled Build:{0},
BuildSystem.AppVeyor.Environment.ScheduledBuild
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Scheduled Build:{0},
AppVeyor.Environment.ScheduledBuild
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo.Platform">
<summary>
Gets the platform name set on build tab of project settings (or through platform parameter in appveyor.yml).
</summary>
<value>
The platform name set on build tab of project settings (or through platform parameter in appveyor.yml).
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Platform:{0},
BuildSystem.AppVeyor.Environment.Platform
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Platform:{0},
AppVeyor.Environment.Platform
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo.Configuration">
<summary>
Gets the configuration name set on build tab of project settings (or through configuration parameter in appveyor.yml).
</summary>
<value>
The configuration name set on build tab of project settings (or through configuration parameter in appveyor.yml).
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Configuration:{0},
BuildSystem.AppVeyor.Environment.Configuration
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Configuration:{0},
AppVeyor.Environment.Configuration
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo.Project">
<summary>
Gets AppVeyor project information.
</summary>
<value>
The AppVeyor project information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Project:
Id: {0}
Name: {1}
Slug: {2}",
BuildSystem.AppVeyor.Environment.Project.Id,
BuildSystem.AppVeyor.Environment.Project.Name,
BuildSystem.AppVeyor.Environment.Project.Slug
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
// via AppVeyor
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Project:
Id: {0}
Name: {1}
Slug: {2}",
AppVeyor.Environment.Project.Id,
AppVeyor.Environment.Project.Name,
AppVeyor.Environment.Project.Slug
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo.Build">
<summary>
Gets AppVeyor build information.
</summary>
<value>
The AppVeyor build information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Build:
Folder: {0}
Id: {1}
Number: {2}
Version: {3}",
BuildSystem.AppVeyor.Environment.Build.Folder,
BuildSystem.AppVeyor.Environment.Build.Id,
BuildSystem.AppVeyor.Environment.Build.Number,
BuildSystem.AppVeyor.Environment.Build.Version
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Build:
Folder: {0}
Id: {1}
Number: {2}
Version: {3}",
AppVeyor.Environment.Build.Folder,
AppVeyor.Environment.Build.Id,
AppVeyor.Environment.Build.Number,
AppVeyor.Environment.Build.Version
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo.PullRequest">
<summary>
Gets AppVeyor pull request information.
</summary>
<value>
The AppVeyor pull request information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Number: {1}
Title: {2}",
BuildSystem.AppVeyor.Environment.PullRequest.IsPullRequest,
BuildSystem.AppVeyor.Environment.PullRequest.Number,
BuildSystem.AppVeyor.Environment.PullRequest.Title
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Number: {1}
Title: {2}",
AppVeyor.Environment.PullRequest.IsPullRequest,
AppVeyor.Environment.PullRequest.Number,
AppVeyor.Environment.PullRequest.Title
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo.Repository">
<summary>
Gets AppVeyor repository information.
</summary>
<value>
The AppVeyor repository information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Repository:
Branch: {0}
Name: {1}
Provider: {2}
Scm: {3}",
BuildSystem.AppVeyor.Environment.Repository.Branch,
BuildSystem.AppVeyor.Environment.Repository.Name,
BuildSystem.AppVeyor.Environment.Repository.Provider,
BuildSystem.AppVeyor.Environment.Repository.Scm
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Repository:
Branch: {0}
Name: {1}
Provider: {2}
Scm: {3}",
AppVeyor.Environment.Repository.Branch,
AppVeyor.Environment.Repository.Name,
AppVeyor.Environment.Repository.Provider,
AppVeyor.Environment.Repository.Scm
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.AppVeyor.Data.AppVeyorProjectInfo">
<summary>
Provides AppVeyor project information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorProjectInfo.Id">
<summary>
Gets the AppVeyor unique project ID.
</summary>
<value>
The AppVeyor unique project ID.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorProjectInfo.Name">
<summary>
Gets the project name.
</summary>
<value>
The project name.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorProjectInfo.Slug">
<summary>
Gets the project slug (as seen in project details URL).
</summary>
<value>
The project slug (as seen in project details URL).
</value>
</member>
<member name="M:Cake.Common.Build.AppVeyor.Data.AppVeyorProjectInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AppVeyor.Data.AppVeyorProjectInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.AppVeyor.Data.AppVeyorPullRequestInfo">
<summary>
Provides AppVeyor pull request information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorPullRequestInfo.IsPullRequest">
<summary>
Gets a value indicating whether the current build was started by a pull request.
</summary>
<value>
<c>true</c> if the current build was started by a pull request; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorPullRequestInfo.Number">
<summary>
Gets the GitHub pull request number.
</summary>
<value>
The GitHub pull request number.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorPullRequestInfo.Title">
<summary>
Gets the GitHub pull request title.
</summary>
<value>
The GitHub pull request title.
</value>
</member>
<member name="M:Cake.Common.Build.AppVeyor.Data.AppVeyorPullRequestInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AppVeyor.Data.AppVeyorPullRequestInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.AppVeyor.Data.AppVeyorRepositoryInfo">
<summary>
Provides AppVeyor repository information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorRepositoryInfo.Provider">
<summary>
Gets the repository provider.
<list type="bullet">
<item>
<description>github</description>
</item>
<item>
<description>bitbucket</description>
</item>
<item>
<description>kiln</description>
</item>
<item>
<description>vso</description>
</item>
<item>
<description>gitlab</description>
</item>
</list>
</summary>
<value>
The repository provider.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorRepositoryInfo.Scm">
<summary>
Gets the revision control system.
<list type="bullet">
<item>
<description>git</description>
</item>
<item>
<description>mercurial</description>
</item>
</list>
</summary>
<value>
The revision control system.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorRepositoryInfo.Name">
<summary>
Gets the repository name in format owner-name/repo-name.
</summary>
<value>
The repository name.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorRepositoryInfo.Branch">
<summary>
Gets the build branch. For pull request commits it is base branch PR is merging into.
</summary>
<value>
The build branch.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorRepositoryInfo.Tag">
<summary>
Gets the tag information for the build.
</summary>
<value>
The tag information for the build.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Repository:
IsTag: {0}
Name: {1}",
BuildSystem.AppVeyor.Environment.Repository.Tag.IsTag,
BuildSystem.AppVeyor.Environment.Repository.Tag.Name
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Repository:
IsTag: {0}
Name: {1}",
AppVeyor.Environment.Repository.Tag.IsTag,
AppVeyor.Environment.Repository.Tag.Name
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorRepositoryInfo.Commit">
<summary>
Gets the commit information for the build.
</summary>
<value>
The commit information for the build.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Repository:
Author: {0}
Email: {1}
ExtendedMessage: {2}
Id: {3}
Message: {4}
Timestamp: {5}",
BuildSystem.AppVeyor.Environment.Repository.Commit.Author,
BuildSystem.AppVeyor.Environment.Repository.Commit.Email,
BuildSystem.AppVeyor.Environment.Repository.Commit.ExtendedMessage,
BuildSystem.AppVeyor.Environment.Repository.Commit.Id,
BuildSystem.AppVeyor.Environment.Repository.Commit.Message,
BuildSystem.AppVeyor.Environment.Repository.Commit.Timestamp
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Repository:
Author: {0}
Email: {1}
ExtendedMessage: {2}
Id: {3}
Message: {4}
Timestamp: {5}",
AppVeyor.Environment.Repository.Commit.Author,
AppVeyor.Environment.Repository.Commit.Email,
AppVeyor.Environment.Repository.Commit.ExtendedMessage,
AppVeyor.Environment.Repository.Commit.Id,
AppVeyor.Environment.Repository.Commit.Message,
AppVeyor.Environment.Repository.Commit.Timestamp
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.AppVeyor.Data.AppVeyorRepositoryInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AppVeyor.Data.AppVeyorRepositoryInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.AppVeyor.Data.AppVeyorTagInfo">
<summary>
Provides AppVeyor tag information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorTagInfo.IsTag">
<summary>
Gets a value indicating whether build was started by pushed tag.
</summary>
<value>
<c>true</c> if build was started by pushed tag; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorTagInfo.Name">
<summary>
Gets the name for builds started by tag; otherwise this variable is undefined.
</summary>
<value>
The name of the tag.
</value>
</member>
<member name="M:Cake.Common.Build.AppVeyor.Data.AppVeyorTagInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AppVeyor.Data.AppVeyorTagInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.AppVeyor.Data.NamespaceDoc">
<summary>
This namespace contain types
representing data used for interaction with AppVeyor.
</summary>
</member>
<member name="T:Cake.Common.Build.AppVeyor.IAppVeyorProvider">
<summary>
Represents a service that communicates with AppVeyor.
</summary>
</member>
<member name="P:Cake.Common.Build.AppVeyor.IAppVeyorProvider.IsRunningOnAppVeyor">
<summary>
Gets a value indicating whether the current build is running on AppVeyor.
</summary>
<value>
<c>true</c> if the current build is running on AppVeyor.; otherwise, <c>false</c>.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information("Running on AppVeyor");
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information("Running on AppVeyor");
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AppVeyor.IAppVeyorProvider.Environment">
<summary>
Gets the AppVeyor environment.
</summary>
<value>
The AppVeyor environment.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Environment:
ApiUrl: {0}
Configuration: {1}
JobId: {2}
JobName: {3}
Platform: {4}
ScheduledBuild: {5}",
BuildSystem.AppVeyor.Environment.ApiUrl,
BuildSystem.AppVeyor.Environment.Configuration,
BuildSystem.AppVeyor.Environment.JobId,
BuildSystem.AppVeyor.Environment.JobName,
BuildSystem.AppVeyor.Environment.Platform,
BuildSystem.AppVeyor.Environment.ScheduledBuild
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Environment:
ApiUrl: {0}
Configuration: {1}
JobId: {2}
JobName: {3}
Platform: {4}
ScheduledBuild: {5}",
AppVeyor.Environment.ApiUrl,
AppVeyor.Environment.Configuration,
AppVeyor.Environment.JobId,
AppVeyor.Environment.JobName,
AppVeyor.Environment.Platform,
AppVeyor.Environment.ScheduledBuild
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.AppVeyor.IAppVeyorProvider.UploadArtifact(Cake.Core.IO.FilePath)">
<summary>
Uploads an AppVeyor artifact.
</summary>
<param name="path">The file path of the artifact to upload.</param>
</member>
<member name="M:Cake.Common.Build.AppVeyor.IAppVeyorProvider.UploadArtifact(Cake.Core.IO.FilePath,Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactsSettings)">
<summary>
Uploads an AppVeyor artifact.
</summary>
<param name="path">The file path of the artifact to upload.</param>
<param name="settings">The settings to apply when uploading an artifact.</param>
</member>
<member name="M:Cake.Common.Build.AppVeyor.IAppVeyorProvider.UploadArtifact(Cake.Core.IO.FilePath,System.Action{Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactsSettings})">
<summary>
Uploads an AppVeyor artifact.
</summary>
<param name="path">The file path of the artifact to upload.</param>
<param name="settingsAction">The settings to apply when uploading an artifact.</param>
</member>
<member name="M:Cake.Common.Build.AppVeyor.IAppVeyorProvider.UploadTestResults(Cake.Core.IO.FilePath,Cake.Common.Build.AppVeyor.AppVeyorTestResultsType)">
<summary>
Uploads test results XML file to AppVeyor. Results type can be one of the following: mstest, xunit, nunit, nunit3, junit.
</summary>
<param name="path">The file path of the test results XML to upload.</param>
<param name="resultsType">The results type. Can be mstest, xunit, nunit, nunit3 or junit.</param>
</member>
<member name="M:Cake.Common.Build.AppVeyor.IAppVeyorProvider.UpdateBuildVersion(System.String)">
<summary>
Updates the build version.
</summary>
<param name="version">The new build version.</param>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
BuildSystem.AppVeyor.UpdateBuildVersion("2.0.0.0");
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
AppVeyor.UpdateBuildVersion("2.0.0.0");
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.AppVeyor.IAppVeyorProvider.AddMessage(System.String,Cake.Common.Build.AppVeyor.AppVeyorMessageCategoryType,System.String)">
<summary>
Adds a message to the AppVeyor build log. Messages can be categorised as: Information, Warning or Error.
</summary>
<param name="message">A short message to display.</param>
<param name="category">The category of the message.</param>
<param name="details">Additional message details.</param>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
BuildSystem.AppVeyor.AddMessage(
"This is a error message.",
AppVeyorMessageCategoryType.Error,
"Error details."
);
BuildSystem.AppVeyor.AddMessage(
"This is a information message.",
AppVeyorMessageCategoryType.Information,
"Information details."
);
BuildSystem.AppVeyor.AddMessage(
"This is a warning message.",
AppVeyorMessageCategoryType.Warning,
"Warning details."
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
AppVeyor.AddMessage(
"This is a error message.",
AppVeyorMessageCategoryType.Error,
"Error details."
);
AppVeyor.AddMessage(
"This is a information message.",
AppVeyorMessageCategoryType.Information,
"Information details."
);
AppVeyor.AddMessage(
"This is a warning message.",
AppVeyorMessageCategoryType.Warning,
"Warning details."
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="T:Cake.Common.Build.AppVeyor.NamespaceDoc">
<summary>
This namespace contain types used
to interact with AppVeyor.
</summary>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands">
<summary>
Responsible for issuing Azure Pipelines agent commands (see <see href="https://github.com/microsoft/azure-pipelines-tasks/blob/master/docs/authoring/commands.md"/>).
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.#ctor(Cake.Core.ICakeEnvironment,Cake.Common.Build.IBuildSystemServiceMessageWriter)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="writer">The build system service message writer.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.WriteWarning(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.WriteWarning(System.String,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesMessageData)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.WriteError(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.WriteError(System.String,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesMessageData)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.SetProgress(System.Int32,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.CompleteCurrentTask">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.CompleteCurrentTask(Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskResult)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.CreateNewRecord(System.String,System.String,System.Int32)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.CreateNewRecord(System.String,System.String,System.Int32,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRecordData)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.UpdateRecord(System.Guid,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRecordData)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.SetVariable(System.String,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.SetOutputVariable(System.String,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.SetSecretVariable(System.String,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.UploadTaskSummary(Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.UploadTaskLogFile(Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.LinkArtifact(System.String,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesArtifactType,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.UploadArtifact(System.String,Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.UploadArtifact(System.String,Cake.Core.IO.FilePath,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.UploadArtifactDirectory(Cake.Core.IO.DirectoryPath)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.UploadArtifactDirectory(Cake.Core.IO.DirectoryPath,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.UploadBuildLogFile(Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.UpdateBuildNumber(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.AddBuildTag(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.PublishTestResults(Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishTestResultsData)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.PublishCodeCoverage(Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishCodeCoverageData)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.PublishCodeCoverage(Cake.Core.IO.FilePath,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishCodeCoverageData)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.PublishCodeCoverage(Cake.Core.IO.FilePath,System.Action{Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishCodeCoverageData})">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.AzurePipelinesInfo">
<summary>
Base class used to provide information about the Azure Pipelines environment.
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AzurePipelines.AzurePipelinesInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesInfo.GetEnvironmentUri(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Uri"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesInfo.GetRepositoryType(System.String)">
<summary>
Gets the current repository type as a <see cref="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryType"/> from an environment variable.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The current repository type.</returns>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.AzurePipelinesProvider">
<summary>
Responsible for communicating with Azure Pipelines.
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesProvider.#ctor(Cake.Core.ICakeEnvironment,Cake.Common.Build.IBuildSystemServiceMessageWriter)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AzurePipelines.AzurePipelinesProvider"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="writer">The build system service message writer.</param>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.AzurePipelinesProvider.IsRunningOnAzurePipelines">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.AzurePipelinesProvider.IsRunningOnAzurePipelinesHosted">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.AzurePipelinesProvider.Environment">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.AzurePipelinesProvider.Commands">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.AzurePipelinesProvider.IsHostedAgent">
<summary>
Gets a value indicating whether the current build is running on a hosted build agent.
</summary>
<value>
<c>true</c> if the current build is running on a hosted agent; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo">
<summary>
Provides Azure Pipelines agent info for the current build and build agent.
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo.BuildDirectory">
<summary>
Gets the local path on the agent where all folders for a given build definition are created.
</summary>
<value>
The local path on the agent where all folders for a given build definition are created.
</value>
<example><c>c:\agent\_work\1</c>.</example>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo.HomeDirectory">
<summary>
Gets the directory the agent is installed into. This contains the agent software.
</summary>
<remarks>If you are using a self-hosted agent, this directory is specified by you.</remarks>
<value>
The directory the agent is installed into.
</value>
<example><c>c:\agent\</c>.</example>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo.WorkingDirectory">
<summary>
Gets the working directory for this agent.
</summary>
<value>
The working directory for this agent.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo.Id">
<summary>
Gets the ID of the agent.
</summary>
<value>
The ID of the agent.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo.JobName">
<summary>
Gets the display name of the running job.
</summary>
<value>
The display name of the running job.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo.JobStatus">
<summary>
Gets the status of the build.
</summary>
<value>
The status of the build.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo.Name">
<summary>
Gets the name of the agent that is registered with the pool.
</summary>
<remarks>If you are using a self-hosted agent, this is specified by you.</remarks>
<value>
The name of the agent that is registered with the pool.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo.MachineName">
<summary>
Gets the name of the machine on which the agent is installed.
</summary>
<value>
The name of the machine on which the agent is installed.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo.ToolsDirectory">
<summary>
Gets the directory used by tasks such as Node Tool Installer and Use Python Version to switch between multiple versions of a tool.
</summary>
<remarks>
These tasks will add tools from this directory to PATH so that subsequent build steps can use them.
</remarks>
<value>
The task directory.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo.IsHosted">
<summary>
Gets a value indicating whether the current agent is a hosted agent.
</summary>
<value>
<c>true</c> if the current agent is a hosted agent; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesArtifactType">
<summary>
Provides the type of an Azure Pipelines artifact.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesArtifactType.Container">
<summary>
The container type.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesArtifactType.FilePath">
<summary>
The file path type.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesArtifactType.VersionControl">
<summary>
The version control path type.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesArtifactType.GitRef">
<summary>
The Git reference type.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesArtifactType.TFVCLabel">
<summary>
The TFVC label type.
</summary>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo">
<summary>
Provides Azure Pipelines Build info for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.AccessToken">
<summary>
Gets the a special variable that carries the security token used by the running build.
</summary>
<value>
The security token.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.Debug">
<summary>
Gets a value indicating whether more detailed logs to debug pipeline problems is enabled.
</summary>
<value>
True if more detailed logs are enabled.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.ArtifactStagingDirectory">
<summary>
Gets the local path on the agent where any artifacts are copied to before being pushed to their destination.
</summary>
<value>
The path of the staging directory.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.BinariesDirectory">
<summary>
Gets the local path on the agent you can use as an output folder for compiled binaries.
</summary>
<value>
The path to the binaries directory.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.Id">
<summary>
Gets the ID of the record for the completed build.
</summary>
<value>
The ID of the record for the completed build.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.Number">
<summary>
Gets the name of the completed build.
</summary>
<remarks>You can specify the build number format that generates this value in the build definition.</remarks>
<value>
The name of the completed build.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.Uri">
<summary>
Gets the URI for the build.
</summary>
<example><c>vstfs:///Build/Build/1430</c>.</example>
<value>
The URI for the build.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.QueuedBy">
<summary>
Gets the user who queued the build.
</summary>
<value>
The user who queued the build.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.Reason">
<summary>
Gets the event that caused the build to run.
</summary>
<value>
The event name.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.RequestedFor">
<summary>
Gets the user the build was requested for.
</summary>
<value>
The user the build was requested for.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.RequestedForEmail">
<summary>
Gets the email of the user the build was requested for.
</summary>
<value>
The email of the user the build was requested for.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.SourcesDirectory">
<summary>
Gets the local path on the agent where your source code files are downloaded.
</summary>
<value>
The source code directory.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.StagingDirectory">
<summary>
Gets the local path on the agent where any artifacts are copied to before being pushed to their destination.
</summary>
<value>
The staging directory.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.TestResultsDirectory">
<summary>
Gets local path on the agent where the test results are created.
</summary>
<value>
The test result directory.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.TriggeredBy">
<summary>
Gets Azure Pipelines Build TriggeredBy information.
</summary>
<remarks>
This is only populated if the build was triggered by another build.
</remarks>
<value>
The Azure Pipelines Build Trigger information.
</value>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesCodeCoverageToolType">
<summary>
Provides the known values for the Code Coverage tool formats.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesCodeCoverageToolType.JaCoCo">
<summary>
JaCoCo code coverage format
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesCodeCoverageToolType.Cobertura">
<summary>
Cobertura code coverage format
</summary>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesDefinitionInfo">
<summary>
Provides Azure Pipelines definition information for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesDefinitionInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesDefinitionInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesDefinitionInfo.Id">
<summary>
Gets the build definition ID.
</summary>
<value>
The build definition ID.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesDefinitionInfo.Name">
<summary>
Gets the build definition name.
</summary>
<value>
The build definition name.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesDefinitionInfo.Version">
<summary>
Gets the build definition version.
</summary>
<value>
The build definition version.
</value>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesEnvironmentInfo">
<summary>
Provides Azure Pipelines environment information for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesEnvironmentInfo.Repository">
<summary>
Gets Azure Pipelines repository information.
</summary>
<value>
The Azure Pipelines repository information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"Repository:
Branch: {0}
SourceVersion: {1}
Shelveset: {2}",
BuildSystem.AzurePipelines.Environment.Repository.Branch,
BuildSystem.AzurePipelines.Environment.Repository.SourceVersion,
BuildSystem.AzurePipelines.Environment.Repository.Shelveset
);
}
else
{
Information("Not running on Azure Pipelines");
}
</code>
</example>
<para>Via AzurePipelines.</para>
<example>
<code>
if (AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"Repository:
Branch: {0}
SourceVersion: {1}
Shelveset: {2}",
AzurePipelines.Environment.Repository.Branch,
AzurePipelines.Environment.Repository.SourceVersion,
AzurePipelines.Environment.Repository.Shelveset
);
}
else
{
Information("Not running on Azure Pipelines");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesEnvironmentInfo.BuildDefinition">
<summary>
Gets Azure Pipelines Build Definition information.
</summary>
<value>
The Azure Pipelines Build Definition.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"BuildDefinition:
Id: {0}
Name: {1}
Version: {2}",
BuildSystem.AzurePipelines.Environment.BuildDefinition.Id,
BuildSystem.AzurePipelines.Environment.BuildDefinition.Name,
BuildSystem.AzurePipelines.Environment.BuildDefinition.Version
);
}
else
{
Information("Not running on AzurePipelines");
}
</code>
</example>
<para>Via AzurePipelines.</para>
<example>
<code>
if (AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"BuildDefinition:
Id: {0}
Name: {1}
Version: {2}",
AzurePipelines.Environment.BuildDefinition.Id,
AzurePipelines.Environment.BuildDefinition.Name,
AzurePipelines.Environment.BuildDefinition.Version
);
}
else
{
Information("Not running on AzurePipelines");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesEnvironmentInfo.Build">
<summary>
Gets Azure Pipelines Build information.
</summary>
<value>
The Azure Pipelines Build.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"Build:
Id: {0}
Number: {1}
QueuedBy: {2}",
BuildSystem.AzurePipelines.Environment.Build.Id,
BuildSystem.AzurePipelines.Environment.Build.Number,
BuildSystem.AzurePipelines.Environment.Build.QueuedBy
);
}
else
{
Information("Not running on Azure Pipelines");
}
</code>
</example>
<para>Via AzurePipelines.</para>
<example>
<code>
if (AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"Build:
Id: {0}
Number: {1}
QueuedBy: {2}",
AzurePipelines.Environment.Build.Id,
AzurePipelines.Environment.Build.Number,
AzurePipelines.Environment.Build.QueuedBy
);
}
else
{
Information("Not running on Azure Pipelines");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesEnvironmentInfo.PullRequest">
<summary>
Gets Azure Pipelines pull request information.
</summary>
<value>
The Azure Pipelines pull request information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Id: {1}
Number: {2}",
BuildSystem.AzurePipelines.Environment.PullRequest.IsPullRequest,
BuildSystem.AzurePipelines.Environment.PullRequest.Id,
BuildSystem.AzurePipelines.Environment.PullRequest.Number
);
}
else
{
Information("Not running on Azure Pipelines");
}
</code>
</example>
<para>Via AzurePipelines.</para>
<example>
<code>
if (AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Id: {1}
Number: {2}",
AzurePipelines.Environment.PullRequest.IsPullRequest,
AzurePipelines.Environment.PullRequest.Id,
AzurePipelines.Environment.PullRequest.Number
);
}
else
{
Information("Not running on Azure Pipelines");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesEnvironmentInfo.TeamProject">
<summary>
Gets Azure Pipeline Team Project information.
</summary>
<value>
The Azure Pipelines Team Project.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"TeamProject:
Id: {0}
Name: {1}",
BuildSystem.AzurePipelines.Environment.TeamProject.Id,
BuildSystem.AzurePipelines.Environment.TeamProject.Name
);
}
else
{
Information("Not running on Azure Pipelines");
}
</code>
</example>
<para>Via AzurePipelines.</para>
<example>
<code>
if (AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"TeamProject:
Id: {0}
Name: {1}",
AzurePipelines.Environment.TeamProject.Id,
AzurePipelines.Environment.TeamProject.Name
);
}
else
{
Information("Not running on Azure Pipelines");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesEnvironmentInfo.Agent">
<summary>
Gets Azure Pipelines agent information.
</summary>
<value>
The Azure Pipelines agent.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"Agent:
Id: {0}
Name: {1}",
BuildSystem.AzurePipelines.Environment.Agent.Id,
BuildSystem.AzurePipelines.Environment.Agent.Name
);
}
else
{
Information("Not running on Azure Pipelines");
}
</code>
</example>
<para>Via AzurePipelines.</para>
<example>
<code>
if (AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"Agent:
Id: {0}
Name: {1}",
AzurePipelines.Environment.Agent.Id,
AzurePipelines.Environment.Agent.Name
);
}
else
{
Information("Not running on Azure Pipelines");
}
</code>
</example>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesMessageData">
<summary>
Provides optional data associated with a Azure Pipelines logging message.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesMessageData.SourcePath">
<summary>
Gets or sets the source file path the message should originate from.
</summary>
<value>
The path of the originating file.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesMessageData.LineNumber">
<summary>
Gets or sets the line number the message relates to.
</summary>
<value>
The line number.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesMessageData.ColumnNumber">
<summary>
Gets or sets the column number the message relates to.
</summary>
<value>
The column number.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesMessageData.ErrorCode">
<summary>
Gets or sets the error code of the warning or error message.
</summary>
<value>
The error code of the warning or error.
</value>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishCodeCoverageData">
<summary>
Description of code coverage information to publish to Azure Pipelines.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishCodeCoverageData.CodeCoverageTool">
<summary>
Gets or sets the tool from which code coverage results are generated.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishCodeCoverageData.SummaryFileLocation">
<summary>
Gets or sets the path of the summary file containing code coverage statistics, such as line, method, and class coverage.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishCodeCoverageData.ReportDirectory">
<summary>
Gets or sets the path of the code coverage HTML report directory. The report directory is published for later viewing as an artifact of the build.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishCodeCoverageData.AdditionalCodeCoverageFiles">
<summary>
Gets or sets the file paths for any additional code coverage files to be published as artifacts of the build.
</summary>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishTestResultsData">
<summary>
Description of test result information to publish to Azure Pipelines.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishTestResultsData.TestRunner">
<summary>
Gets or sets the type test runner the results are formatted in.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishTestResultsData.TestResultsFiles">
<summary>
Gets or sets the list of test result files to publish.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishTestResultsData.MergeTestResults">
<summary>
Gets or sets whether to merge all test result files into one run.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishTestResultsData.Platform">
<summary>
Gets or sets the platform for which the tests were run on.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishTestResultsData.Configuration">
<summary>
Gets or sets the configuration for which the tests were run on.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishTestResultsData.TestRunTitle">
<summary>
Gets or sets a name for the test run.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishTestResultsData.PublishRunAttachments">
<summary>
Gets or sets whether to opt in/out of publishing test run level attachments.
</summary>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPullRequestInfo">
<summary>
Provides Azure Pipelines pull request information for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPullRequestInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPullRequestInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPullRequestInfo.IsFork">
<summary>
Gets a value indicating whether the pull request is from a fork of the repository.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPullRequestInfo.IsPullRequest">
<summary>
Gets a value indicating whether the current build was started by a pull request.
</summary>
<value>
<c>true</c> if the current build was started by a pull request; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPullRequestInfo.Id">
<summary>
Gets the ID of the pull request that caused this build.
This value is set only if the build ran because of a Git PR affected by a branch policy.
</summary>
<value>
The ID of the pull request that caused this build.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPullRequestInfo.Number">
<summary>
Gets the number of the pull request that caused this build.
This value is set for pull requests from GitHub which have a different pull request ID and pull request number.
</summary>
<value>
The number of the pull request that caused this build.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPullRequestInfo.SourceBranch">
<summary>
Gets the branch that is being reviewed in a pull request.
</summary>
<remarks>
This property is populated only if the build ran because of a Git PR affected by a branch policy.
</remarks>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPullRequestInfo.SourceRepositoryUri">
<summary>
Gets the URL to the repo that contains the pull requests.
</summary>
<remarks>
This property is populated only if the build ran because of a Git PR affected by a branch policy. It is not initialized for GitHub PRs.
</remarks>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPullRequestInfo.TargetBranch">
<summary>
Gets the branch that is the target of a pull request.
</summary>
<remarks>
This property is populated only if the build ran because of a Git PR affected by a branch policy.
</remarks>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRecordData">
<summary>
Provides optional data associated with an Azure Pipelines timeline record.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRecordData.ParentRecord">
<summary>
Gets or sets the parent record of a new or existing timeline record.
</summary>
<value>
The ID of the parent record.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRecordData.StartTime">
<summary>
Gets or sets the start time of this record.
</summary>
<value>
The start time of this record.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRecordData.FinishTime">
<summary>
Gets or sets the finish time of this record.
</summary>
<value>
The finish time of this record.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRecordData.Progress">
<summary>
Gets or sets the current progress of this record.
</summary>
<value>
The current progress of this record.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRecordData.Status">
<summary>
Gets or sets the current status of this record.
</summary>
<value>
The current status of this record.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRecordData.Result">
<summary>
Gets or sets the result of this record.
</summary>
<value>
The result of this record.
</value>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryInfo">
<summary>
Provides Azure Pipelines Repository information for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryInfo.SourceBranch">
<summary>
Gets the branch the build was queued for.
</summary>
<value>
The full SCM branch.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryInfo.SourceBranchName">
<summary>
Gets name of the branch the build was queued for.
</summary>
<value>
The SCM branch name.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryInfo.SourceVersion">
<summary>
Gets the latest version control change that is included in this build.
</summary>
<remarks>Note: for Git this is the commit ID. For TFVC this is the changeset.</remarks>
<value>
The SCM source version.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryInfo.SourceVersionMessage">
<summary>
Gets the comment of the commit or changeset.
</summary>
<remarks>Note: This variable is available in TFS 2015.4.</remarks>
<value>
The comment.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryInfo.Shelveset">
<summary>
Gets the name of the shelveset you are building, if you are running a gated build or a shelveset build.
</summary>
<remarks>Defined only if your repository is Team Foundation Version Control.</remarks>
<value>
The shelveset name.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryInfo.RepoName">
<summary>
Gets the name of the repository.
</summary>
<value>
The name of the repository.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryInfo.Provider">
<summary>
Gets the type of the current repository.
</summary>
<value>
The type of the current repository.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryInfo.GitSubmoduleCheckout">
<summary>
Gets the value you've selected for Checkout submodules on the repository tab.
</summary>
<value>
The checkout submodule value.
</value>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryType">
<summary>
Provides the known values for the Azure Pipelines Repository types.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryType.TfsGit">
<summary>
TFS Git repository.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryType.TfsVersionControl">
<summary>
Team Foundation Version Control repository.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryType.Git">
<summary>
Git repository hosted on an external server.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryType.GitHub">
<summary>
GitHub repository.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryType.Svn">
<summary>
Subversion repository.
</summary>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskResult">
<summary>
Provides the result of an Azure Pipelines task record.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskResult.Succeeded">
<summary>
Succeeded status.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskResult.SucceededWithIssues">
<summary>
Succeeded with issues status.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskResult.Failed">
<summary>
Failed status.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskResult.Cancelled">
<summary>
Cancelled status.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskResult.Skipped">
<summary>
Skipped status.
</summary>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskStatus">
<summary>
Provides the status of an Azure Pipelines task record.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskStatus.Unknown">
<summary>
Unknown status.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskStatus.Initialized">
<summary>
Initialized status.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskStatus.InProgress">
<summary>
In progress status.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskStatus.Completed">
<summary>
Completed status.
</summary>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTeamProjectInfo">
<summary>
Provides Azure Pipelines Team Project information for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTeamProjectInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTeamProjectInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTeamProjectInfo.Name">
<summary>
Gets the name of the team project that contains this build.
</summary>
<value>
The name of the team project that contains this build.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTeamProjectInfo.Id">
<summary>
Gets the ID of the team project that contains this build.
</summary>
<value>
The ID of the team project that contains this build.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTeamProjectInfo.CollectionUri">
<summary>
Gets the URI of the team foundation collection.
</summary>
<value>
The URI of the team foundation collection.
</value>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTestRunnerType">
<summary>
Test runner file formats supported on Azure Pipelines.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTestRunnerType.JUnit">
<summary>
JUnit Test Result Format
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTestRunnerType.NUnit">
<summary>
NUnit (v2) Test Result Format
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTestRunnerType.VSTest">
<summary>
Visual Studio (MSTest) Test Result Format
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTestRunnerType.XUnit">
<summary>
XUnit Test Result Format
</summary>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTriggeredBy">
<summary>
Provides Azure Pipelines Trigger information for the current build.
</summary>
<remarks>
Only populated if the build was triggered by another build.
</remarks>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTriggeredBy.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTriggeredBy"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTriggeredBy.BuildId">
<summary>
Gets the BuildID of the triggering build.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTriggeredBy.DefinitionId">
<summary>
Gets the DefinitionID of the triggering build.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTriggeredBy.DefinitionName">
<summary>
Gets the name of the triggering build pipeline.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTriggeredBy.BuildNumber">
<summary>
Gets the number of the triggering build.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTriggeredBy.ProjectId">
<summary>
Gets the ID of the project that contains the triggering build.
</summary>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands">
<summary>
Represents an Azure Pipelines command provider.
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.WriteWarning(System.String)">
<summary>
Log a warning issue to timeline record of current task.
</summary>
<param name="message">The warning message.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.WriteWarning(System.String,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesMessageData)">
<summary>
Log a warning issue with detailed data to timeline record of current task.
</summary>
<param name="message">The warning message.</param>
<param name="data">The message data.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.WriteError(System.String)">
<summary>
Log an error to timeline record of current task.
</summary>
<param name="message">The error message.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.WriteError(System.String,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesMessageData)">
<summary>
Log an error with detailed data to timeline record of current task.
</summary>
<param name="message">The error message.</param>
<param name="data">The message data.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.SetProgress(System.Int32,System.String)">
<summary>
Set progress and current operation for current task.
</summary>
<param name="progress">Current progress as percentage.</param>
<param name="currentOperation">The current operation.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.CompleteCurrentTask">
<summary>
Finish timeline record for current task and set task result to succeeded.
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.CompleteCurrentTask(Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskResult)">
<summary>
Finish timeline record for current task and set task result.
</summary>
<param name="result">The task result status.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.CreateNewRecord(System.String,System.String,System.Int32)">
<summary>
Create detail timeline record.
</summary>
<param name="name">Name of the new timeline record.</param>
<param name="type">Type of the new timeline record.</param>
<param name="order">Order of the timeline record.</param>
<returns>The timeline record ID.</returns>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.CreateNewRecord(System.String,System.String,System.Int32,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRecordData)">
<summary>
Create detail timeline record.
</summary>
<param name="name">Name of the new timeline record.</param>
<param name="type">Type of the new timeline record.</param>
<param name="order">Order of the timeline record.</param>
<param name="data">Additional data for the new timeline record.</param>
<returns>The timeline record ID.</returns>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.UpdateRecord(System.Guid,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRecordData)">
<summary>
Update an existing detail timeline record.
</summary>
<param name="id">The ID of the existing timeline record.</param>
<param name="data">Additional data for the timeline record.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.SetVariable(System.String,System.String)">
<summary>
Sets a variable in the variable service of the task context.
</summary>
<remarks>
The variable is exposed to following tasks as an environment variable.
</remarks>
<param name="name">The variable name.</param>
<param name="value">The variable value.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.SetOutputVariable(System.String,System.String)">
<summary>
Sets a output variable in the variable service of the task context.
</summary>
<remarks>
The variable is exposed to following tasks as an environment variable.
</remarks>
<param name="name">The variable name.</param>
<param name="value">The variable value.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.SetSecretVariable(System.String,System.String)">
<summary>
Sets a secret variable in the variable service of the task context.
</summary>
<remarks>
The variable is not exposed to following tasks as an environment variable, and must be passed as inputs.
</remarks>
<param name="name">The variable name.</param>
<param name="value">The variable value.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.UploadTaskSummary(Cake.Core.IO.FilePath)">
<summary>
Upload and attach summary markdown to current timeline record.
</summary>
<remarks>
This summary is added to the build/release summary and is not available for download with logs.
</remarks>
<param name="markdownPath">Path to the summary markdown file.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.UploadTaskLogFile(Cake.Core.IO.FilePath)">
<summary>
Upload file as additional log information to the current timeline record.
</summary>
<remarks>
<para>
The file shall be available for download along with task logs.
</para>
<para>
Requires agent version 1.101.
</para>
</remarks>
<param name="logFile">Path to the additional log file.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.LinkArtifact(System.String,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesArtifactType,System.String)">
<summary>
Create an artifact link, such as a file or folder path or a version control path.
</summary>
<param name="name">The artifact name.</param>
<param name="type">The artifact type.</param>
<param name="location">The link path or value.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.UploadArtifact(System.String,Cake.Core.IO.FilePath)">
<summary>
Upload local file into a file container folder.
</summary>
<param name="folderName">Folder that the file will upload to.</param>
<param name="file">Path to the local file.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.UploadArtifact(System.String,Cake.Core.IO.FilePath,System.String)">
<summary>
Upload local file into a file container folder, and create an artifact.
</summary>
<param name="folderName">Folder that the file will upload to.</param>
<param name="file">Path to the local file.</param>
<param name="artifactName">The artifact name.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.UploadArtifactDirectory(Cake.Core.IO.DirectoryPath)">
<summary>
Upload local directory as a container folder, and create an artifact.
</summary>
<param name="directory">Path to the local directory.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.UploadArtifactDirectory(Cake.Core.IO.DirectoryPath,System.String)">
<summary>
Upload local directory as a container folder, and create an artifact with the specified name.
</summary>
<param name="directory">Path to the local directory.</param>
<param name="artifactName">The artifact name.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.UploadBuildLogFile(Cake.Core.IO.FilePath)">
<summary>
Upload additional log to build container's <c>logs/tool</c> folder.
</summary>
<param name="logFile">The log file.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.UpdateBuildNumber(System.String)">
<summary>
Update build number for current build.
</summary>
<remarks>
Requires agent version 1.88.
</remarks>
<param name="buildNumber">The build number.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.AddBuildTag(System.String)">
<summary>
Add a tag for current build.
</summary>
<remarks>
Requires agent version 1.95.
</remarks>
<param name="tag">The tag.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.PublishTestResults(Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishTestResultsData)">
<summary>
Publishes and uploads tests results.
</summary>
<param name="data">The publish test results data.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.PublishCodeCoverage(Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishCodeCoverageData)">
<summary>
Publishes and uploads code coverage results.
</summary>
<param name="data">The code coverage data.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.PublishCodeCoverage(Cake.Core.IO.FilePath,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishCodeCoverageData)">
<summary>
Publishes and uploads code coverage results.
</summary>
<param name="summaryFilePath">The code coverage summary file path.</param>
<param name="data">The code coverage data.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.PublishCodeCoverage(Cake.Core.IO.FilePath,System.Action{Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishCodeCoverageData})">
<summary>
Publishes and uploads code coverage results.
</summary>
<param name="summaryFilePath">The code coverage summary file path.</param>
<param name="action">The configuration action for the code coverage data.</param>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.IAzurePipelinesProvider">
<summary>
Represents a Azure Pipelines provider.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.IAzurePipelinesProvider.IsRunningOnAzurePipelines">
<summary>
Gets a value indicating whether the current build is running on Azure Pipelines.
</summary>
<value>
<c>true</c> if the current build is running on Azure Pipelines; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.IAzurePipelinesProvider.IsRunningOnAzurePipelinesHosted">
<summary>
Gets a value indicating whether the current build is running on hosted Azure Pipelines.
</summary>
<value>
<c>true</c> if the current build is running on hosted Azure Pipelines; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.IAzurePipelinesProvider.Environment">
<summary>
Gets the Azure Pipelines environment.
</summary>
<value>
The Azure Pipelines environment.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.IAzurePipelinesProvider.Commands">
<summary>
Gets the Azure Pipelines Commands provider.
</summary>
<value>
The Azure Pipelines commands provider.
</value>
</member>
<member name="T:Cake.Common.Build.Bamboo.BambooInfo">
<summary>
Base class used to provide information about the Bamboo environment.
</summary>
</member>
<member name="M:Cake.Common.Build.Bamboo.BambooInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bamboo.BambooInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.Bamboo.BambooInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.Bamboo.BambooInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.Bamboo.BambooInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="T:Cake.Common.Build.Bamboo.BambooProvider">
<summary>
Responsible for communicating with Bamboo.
</summary>
</member>
<member name="M:Cake.Common.Build.Bamboo.BambooProvider.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bamboo.BambooProvider"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.Bamboo.BambooProvider.IsRunningOnBamboo">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.Bamboo.BambooProvider.Environment">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.Bamboo.Data.BambooBuildInfo">
<summary>
Provides Bamboo build information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooBuildInfo.Folder">
<summary>
Gets the path to the clone directory.
</summary>
<value>
The path to the clone directory.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooBuildInfo.Number">
<summary>
Gets the build number.
</summary>
<value>
The build number.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooBuildInfo.BuildKey">
<summary>
Gets the job key for the current job, in the form PROJECT-PLAN-JOB, e.g. BAM-MAIN-JOBX.
</summary>
<value>
The Bamboo Build Key.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooBuildInfo.ResultKey">
<summary>
Gets the Bamboo Build Result Key.
The result key when this job executes, in the form PROJECT-PLAN-JOB-BUILD e.g. BAM-BOO-JOB1-8, where '8' is the build number.
For deployment projects this variable will not have the JOB component e.g. PROJ-TP-6.
</summary>
<value>
The Build Result Key.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooBuildInfo.ResultsUrl">
<summary>
Gets the URL of the result in Bamboo once the job has finished executing.
</summary>
<value>
The Bamboo build result url.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooBuildInfo.BuildTimestamp">
<summary>
Gets the time when build was started in ISO 8601 format e.g. 2010-01-01T01:00:00.000+01:00.
</summary>
<value>
The Bamboo build timestamp.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooBuildInfo.CustomBuild">
<summary>
Gets Bamboo custom build information.
</summary>
<value>
The Bamboo custom build information.
</value>
</member>
<member name="M:Cake.Common.Build.Bamboo.Data.BambooBuildInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bamboo.Data.BambooBuildInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bamboo.Data.BambooCommitInfo">
<summary>
Provides Bamboo commit information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooCommitInfo.RepositoryRevision">
<summary>
Gets the revision use to build this release. Format depends on the VCS used.
</summary>
<value>
The commit ID (SHA).
</value>
</member>
<member name="M:Cake.Common.Build.Bamboo.Data.BambooCommitInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bamboo.Data.BambooCommitInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bamboo.Data.BambooCustomBuildInfo">
<summary>
Provides Bamboo tag information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooCustomBuildInfo.IsCustomBuild">
<summary>
Gets a value indicating whether build was started by pushed tag.
</summary>
<value>
<c>true</c> if build was started by pushed tag; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooCustomBuildInfo.RevisonName">
<summary>
Gets the name for builds started by tag; otherwise this variable is undefined.
</summary>
<value>
The name of the tag.
</value>
</member>
<member name="M:Cake.Common.Build.Bamboo.Data.BambooCustomBuildInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bamboo.Data.BambooCustomBuildInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bamboo.Data.BambooEnvironmentInfo">
<summary>
Provides Bamboo environment information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooEnvironmentInfo.Plan">
<summary>
Gets Bamboo plan information.
</summary>
<value>
The Bamboo plan information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Bamboo.IsRunningOnBamboo)
{
Information(
@"Build:
Plan Name: {0}
Short Plan Name: {1}
Plan Key: {2}
Short Plan Key: {3}
Short Job Key: {4}
Short Job Name: {5}",
BuildSystem.Bamboo.Environment.Plan.PlanName,
BuildSystem.Bamboo.Environment.Plan.ShortPlanName,
BuildSystem.Bamboo.Environment.Plan.PlanKey,
BuildSystem.Bamboo.Environment.Plan.ShortPlanKey,
BuildSystem.Bamboo.Environment.Plan.ShortJobKey,
BuildSystem.Bamboo.Environment.Plan.ShortJobName
);
}
else
{
Information("Not running on Bamboo");
}
</code>
</example>
<para>Via Bamboo.</para>
<example>
<code>
if (Bamboo.IsRunningOnBamboo)
{
Information(
@"Build:
Plan Name: {0}
Short Plan Name: {1}
Plan Key: {2}
Short Plan Key: {3}
Short Job Key: {4}
Short Job Name: {5}",
Bamboo.Environment.Plan.PlanName,
Bamboo.Environment.Plan.ShortPlanName,
Bamboo.Environment.Plan.PlanKey,
Bamboo.Environment.Plan.ShortPlanKey,
Bamboo.Environment.Plan.ShortJobKey,
Bamboo.Environment.Plan.ShortJobName
);
}
else
{
Information("Not running on Bamboo");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooEnvironmentInfo.Build">
<summary>
Gets Bamboo build information.
</summary>
<value>
The Bamboo build information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Bamboo.IsRunningOnBamboo)
{
Information(
@"Build:
Folder: {0}
Number: {1}
Build Key: {2}
Result Key: {3}
Results Url: {4}
Build Timestamp: {5}
Is Custom: {6}
Revision Name: {7}",
BuildSystem.Bamboo.Environment.Build.Folder,
BuildSystem.Bamboo.Environment.Build.Number,
BuildSystem.Bamboo.Environment.Build.BuildKey,
BuildSystem.Bamboo.Environment.Build.ResultKey,
BuildSystem.Bamboo.Environment.Build.ResultsUrl,
BuildSystem.Bamboo.Environment.Build.BuildTimestamp,
BuildSystem.Bamboo.Environment.Build.CustomBuild.IsCustomBuild,
BuildSystem.Bamboo.Environment.Build.CustomBuild.RevisionName);
}
else
{
Information("Not running on Bamboo");
}
</code>
</example>
<para>Via Bamboo.</para>
<example>
<code>
if (Bamboo.IsRunningOnBamboo)
{
Information(
@"Build:
Folder: {0}
Number: {1}
Build Key: {2}
Result Key: {3}
Results Url: {4}
Build Timestamp: {5}
Is Custom: {6}
Revision Name: {7}",
Bamboo.Environment.Build.Folder,
Bamboo.Environment.Build.Number,
Bamboo.Environment.Build.BuildKey,
Bamboo.Environment.Build.ResultKey,
Bamboo.Environment.Build.ResultsUrl,
Bamboo.Environment.Build.BuildTimestamp,
Bamboo.Environment.Build.CustomBuild.IsCustomBuild,
Bamboo.Environment.Build.CustomBuild.RevisionName);
}
else
{
Information("Not running on Bamboo");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooEnvironmentInfo.Repository">
<summary>
Gets Bamboo repository information.
</summary>
<value>
The Bamboo repository information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Bamboo.IsRunningOnBamboo)
{
Information(
@"Repository:
Branch: {0}
Name: {1}
Repository Revision: {2}
Scm: {3}",
BuildSystem.Bamboo.Environment.Repository.Branch,
BuildSystem.Bamboo.Environment.Repository.Name,
BuildSystem.Bamboo.Environment.Repository.Commit.RepositoryRevision,
BuildSystem.Bamboo.Environment.Repository.Scm
);
}
else
{
Information("Not running on Bamboo");
}
</code>
</example>
<para>Via Bamboo.</para>
<example>
<code>
if (Bamboo.IsRunningOnBamboo)
{
Information(
@"Repository:
Branch: {0}
Name: {1}
Repository Revision: {2}
Scm: {3}",
Bamboo.Environment.Repository.Branch,
Bamboo.Environment.Repository.Name,
Bamboo.Environment.Repository.Commit.RepositoryRevision,
Bamboo.Environment.Repository.Scm
);
}
else
{
Information("Not running on Bamboo");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.Bamboo.Data.BambooEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bamboo.Data.BambooEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bamboo.Data.BambooPlanInfo">
<summary>
Provides Bamboo project information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooPlanInfo.PlanName">
<summary>
Gets the Bamboo Plan Name.
</summary>
<value>
The Bamboo Plan Name.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooPlanInfo.ShortPlanName">
<summary>
Gets the Bamboo short Plan Name.
</summary>
<value>
The Bamboo Plan Name in its short form.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooPlanInfo.PlanKey">
<summary>
Gets the key of the current plan, in the form PROJECT-PLAN, e.g. BAM-MAIN.
</summary>
<value>
The project name.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooPlanInfo.ShortPlanKey">
<summary>
Gets the Bamboo short Plan Key.
</summary>
<value>
The Bamboo Plan Key in its short form.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooPlanInfo.ShortJobKey">
<summary>
Gets the Bamboo short job key.
</summary>
<value>
The Bamboo job key in its short form.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooPlanInfo.ShortJobName">
<summary>
Gets the Bamboo short Job Name.
</summary>
<value>
The Bamboo Job Name in its short form.
</value>
</member>
<member name="M:Cake.Common.Build.Bamboo.Data.BambooPlanInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bamboo.Data.BambooPlanInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bamboo.Data.BambooRepositoryInfo">
<summary>
Provides Bamboo repository information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooRepositoryInfo.Scm">
<summary>
Gets the revision control system.
<list type="bullet">
<item>
<description>Subversion</description>
</item>
<item>
<description>CVS</description>
</item>
<item>
<description>Perforce</description>
</item>
<item>
<description>Git</description>
</item>
<item>
<description>Mercurial</description>
</item>
</list>
</summary>
<value>
The revision control system.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooRepositoryInfo.Name">
<summary>
Gets the repository name as named in Bamboo.
</summary>
<value>
The bamboo repository name.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooRepositoryInfo.Branch">
<summary>
Gets the build branch.
</summary>
<value>
The build branch.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooRepositoryInfo.Commit">
<summary>
Gets the commit information for the build.
</summary>
<value>
The commit information for the build.
</value>
</member>
<member name="M:Cake.Common.Build.Bamboo.Data.BambooRepositoryInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bamboo.Data.BambooRepositoryInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bamboo.IBambooProvider">
<summary>
Represents a Bamboo provider.
</summary>
</member>
<member name="P:Cake.Common.Build.Bamboo.IBambooProvider.IsRunningOnBamboo">
<summary>
Gets a value indicating whether the current build is running on Bamboo.
</summary>
<value>
<c>true</c> if the current build is running on Bamboo; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.IBambooProvider.Environment">
<summary>
Gets the Bamboo environment.
</summary>
<value>
The Bamboo environment.
</value>
</member>
<member name="T:Cake.Common.Build.BitbucketPipelines.BitbucketPipelinesInfo">
<summary>
Base class used to provide information about the Bitbucket Pipelines environment.
</summary>
</member>
<member name="M:Cake.Common.Build.BitbucketPipelines.BitbucketPipelinesInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.BitbucketPipelines.BitbucketPipelinesInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.BitbucketPipelines.BitbucketPipelinesInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.BitbucketPipelines.BitbucketPipelinesInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="T:Cake.Common.Build.BitbucketPipelines.BitbucketPipelinesProvider">
<summary>
Responsible for communicating with Pipelines.
</summary>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.BitbucketPipelinesProvider.IsRunningOnBitbucketPipelines">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.BitbucketPipelinesProvider.Environment">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.BitbucketPipelines.BitbucketPipelinesProvider.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.BitbucketPipelines.BitbucketPipelinesProvider"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesEnvironmentInfo">
<summary>
Provides Bitbucket Pipelines environment information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesEnvironmentInfo.Repository">
<summary>
Gets Bitbucket Pipelines repository information.
</summary>
<value>
The repository.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.BitbucketPipelines.IsRunningOnBitbucketPipelines)
{
Information(
@"Repository:
Branch: {0}
Tag: {1}
Commit: {2}
Repo Owner: {3}
Repo Slug: {4}",
BuildSystem.BitbucketPipelines.Environment.Repository.Branch,
BuildSystem.BitbucketPipelines.Environment.Repository.Tag,
BuildSystem.BitbucketPipelines.Environment.Repository.Commit,
BuildSystem.BitbucketPipelines.Environment.Repository.RepoOwner,
BuildSystem.BitbucketPipelines.Environment.Repository.RepoSlug
);
}
else
{
Information("Not running on BitbucketPipelines");
}
</code>
</example>
<para>Via BitbucketPipelines.</para>
<example>
<code>
if (BitbucketPipelines.IsRunningOnBitbucketPipelines)
{
Information(
@"Repository:
Branch: {0}
Tag: {1}
Commit: {2}
Repo Owner: {3}
Repo Slug: {4}",
BitbucketPipelines.Environment.Repository.Branch,
BitbucketPipelines.Environment.Repository.Tag,
BitbucketPipelines.Environment.Repository.Commit,
BitbucketPipelines.Environment.Repository.RepoOwner,
BitbucketPipelines.Environment.Repository.RepoSlug
);
}
else
{
Information("Not running on BitbucketPipelines");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesEnvironmentInfo.PullRequest">
<summary>
Gets Bitbucket Pipelines pull request information.
</summary>
<value>
The Bitbucket Pipelines pull request information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.BitbucketPipelines.IsRunningOnBitbucketPipelines)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Id: {1}",
BuildSystem.BitbucketPipelines.Environment.PullRequest.IsPullRequest,
BuildSystem.BitbucketPipelines.Environment.PullRequest.Id
);
}
else
{
Information("Not running on BitbucketPipelines");
}
</code>
</example>
<para>Via BitbucketPipelines.</para>
<example>
<code>
if (BitbucketPipelines.IsRunningOnBitbucketPipelines)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Id: {1}",
BitbucketPipelines.Environment.PullRequest.IsPullRequest,
BitbucketPipelines.Environment.PullRequest.Id
);
}
else
{
Information("Not running on BitbucketPipelines");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesPullRequestInfo">
<summary>
Provides BitbucketPipelines pull request information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesPullRequestInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesPullRequestInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesPullRequestInfo.IsPullRequest">
<summary>
Gets a value indicating whether the current build was started by a pull request.
</summary>
<value>
<c>true</c> if the current build was started by a pull request; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesPullRequestInfo.Id">
<summary>
Gets the pull request id.
</summary>
<value>
The pull request id.
</value>
</member>
<member name="T:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo">
<summary>
Provides Bitbucket Pipelines repository information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo.Branch">
<summary>
Gets the branch on which the build was kicked off. This value is only available on branches.
</summary>
<remarks>Note: <see cref="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo.Branch"/> and <see cref="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo.Tag"/> are mutually exclusive. If you use both, only one will have a value.</remarks>
<value>
The SCM branch.
</value>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo.Tag">
<summary>
Gets the tag on which the build was kicked off. This value is only available when tagged.
</summary>
<remarks>Note: <see cref="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo.Branch"/> and <see cref="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo.Tag"/> are mutually exclusive. If you use both, only one will have a value.</remarks>
<value>
The SCM tag.
</value>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo.Commit">
<summary>
Gets the commit hash of a commit that kicked off the build.
</summary>
<value>
The SCM commit.
</value>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo.RepoOwner">
<summary>
Gets the name of the account in which the repository lives.
</summary>
<value>
The repository owner account.
</value>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo.RepoSlug">
<summary>
Gets the URL-friendly version of a repository name.
</summary>
<value>
The URL-friendly repository name.
</value>
</member>
<member name="M:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.BitbucketPipelines.IBitbucketPipelinesProvider">
<summary>
Represents a Bitrise provider.
</summary>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.IBitbucketPipelinesProvider.IsRunningOnBitbucketPipelines">
<summary>
Gets a value indicating whether the current build is running on Bitbucket Pipelines.
</summary>
<value>
<c>true</c> if the current build is running on Bitbucket Pipelines; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.IBitbucketPipelinesProvider.Environment">
<summary>
Gets the Bitbucket Pipelines environment.
</summary>
<value>
The Bitbucket Pipelines environment.
</value>
</member>
<member name="T:Cake.Common.Build.Bitrise.BitriseInfo">
<summary>
Base class used to provide information about the Bamboo environment.
</summary>
</member>
<member name="M:Cake.Common.Build.Bitrise.BitriseInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bitrise.BitriseInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.Bitrise.BitriseInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.Bitrise.BitriseInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.Bitrise.BitriseInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="T:Cake.Common.Build.Bitrise.BitriseProvider">
<summary>
Responsible for communicating with Bitrise.
</summary>
</member>
<member name="P:Cake.Common.Build.Bitrise.BitriseProvider.IsRunningOnBitrise">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.Bitrise.BitriseProvider.Environment">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.Bitrise.BitriseProvider.#ctor(Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bitrise.BitriseProvider"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
</member>
<member name="M:Cake.Common.Build.Bitrise.BitriseProvider.SetEnvironmentString(System.String,System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.Bitrise.Data.BitriseApplicationInfo">
<summary>
Provides Bitrise application information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseApplicationInfo.ApplicationTitle">
<summary>
Gets the application title.
</summary>
<value>
The application title.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseApplicationInfo.ApplicationUrl">
<summary>
Gets the application URL.
</summary>
<value>
The application URL.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseApplicationInfo.AppSlug">
<summary>
Gets the application slug.
</summary>
<value>
The application slug.
</value>
</member>
<member name="M:Cake.Common.Build.Bitrise.Data.BitriseApplicationInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bitrise.Data.BitriseApplicationInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bitrise.Data.BitriseBuildInfo">
<summary>
Provides Bitrise build information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseBuildInfo.BuildNumber">
<summary>
Gets the build number.
</summary>
<value>
The build number.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseBuildInfo.BuildUrl">
<summary>
Gets the build URL.
</summary>
<value>
The build URL.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseBuildInfo.BuildSlug">
<summary>
Gets the build slug.
</summary>
<value>
The build slug.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseBuildInfo.BuildTriggerTimestamp">
<summary>
Gets the build trigger timestamp.
</summary>
<value>
The build trigger timestamp.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseBuildInfo.BuildStatus">
<summary>
Gets a value indicating whether the build is passing.
</summary>
<value>
<c>true</c> if [build status]; otherwise, <c>false</c>.
</value>
</member>
<member name="M:Cake.Common.Build.Bitrise.Data.BitriseBuildInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bitrise.Data.BitriseBuildInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bitrise.Data.BitriseDirectoryInfo">
<summary>
Provides Bitrise directory information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseDirectoryInfo.SourceDirectory">
<summary>
Gets the source directory.
</summary>
<value>
The source directory.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseDirectoryInfo.DeployDirectory">
<summary>
Gets the deploy directory.
</summary>
<value>
The deploy directory.
</value>
</member>
<member name="M:Cake.Common.Build.Bitrise.Data.BitriseDirectoryInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bitrise.Data.BitriseDirectoryInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bitrise.Data.BitriseEnvironmentInfo">
<summary>
Provides Bitrise environment information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseEnvironmentInfo.Application">
<summary>
Gets Bitrise application information.
</summary>
<value>
The application.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Bitrise.IsRunningOnBitrise)
{
Information(
@"Application:
Title: {0}
Url: {1}
Slug: {2}",
BuildSystem.Bitrise.Environment.Application.ApplicationTitle,
BuildSystem.Bitrise.Environment.Application.ApplicationUrl,
BuildSystem.Bitrise.Environment.Application.AppSlug
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
<para>Via Bitrise.</para>
<example>
<code>
if (Bitrise.IsRunningOnBitrise)
{
Information(
@"Application:
Title: {0}
Url: {1}
Slug: {2}",
Bitrise.Environment.Application.ApplicationTitle,
Bitrise.Environment.Application.ApplicationUrl,
Bitrise.Environment.Application.AppSlug
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseEnvironmentInfo.Build">
<summary>
Gets Bitrise build information.
</summary>
<value>
The build.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Bitrise.IsRunningOnBitrise)
{
Information(
@"Build:
Build Number: {0}
Build Url: {1}
Build Slug: {2}
Build Trigger Timestamp: {3}
Build Status: {4}",
BuildSystem.Bitrise.Environment.Build.BuildNumber,
BuildSystem.Bitrise.Environment.Build.BuildUrl,
BuildSystem.Bitrise.Environment.Build.BuildSlug,
BuildSystem.Bitrise.Environment.Build.BuildTriggerTimestamp,
BuildSystem.Bitrise.Environment.Build.BuildStatus
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
<para>Via Bitrise.</para>
<example>
<code>
if (Bitrise.IsRunningOnBitrise)
{
Information(
@"Build:
Build Number: {0}
Build Url: {1}
Build Slug: {2}
Build Trigger Timestamp: {3}
Build Status: {4}",
Bitrise.Environment.Build.BuildNumber,
Bitrise.Environment.Build.BuildUrl,
Bitrise.Environment.Build.BuildSlug,
Bitrise.Environment.Build.BuildTriggerTimestamp,
Bitrise.Environment.Build.BuildStatus
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseEnvironmentInfo.PullRequest">
<summary>
Gets Bitrise pull request information.
</summary>
<value>
The Bitrise pull request information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Bitrise.IsRunningOnBitrise)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Id: {1}",
BuildSystem.Bitrise.Environment.PullRequest.IsPullRequest,
BuildSystem.Bitrise.Environment.PullRequest.Id
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
<para>Via Bitrise.</para>
<example>
<code>
if (Bitrise.IsRunningOnBitrise)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Id: {1}",
Bitrise.Environment.PullRequest.IsPullRequest,
Bitrise.Environment.PullRequest.Id
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseEnvironmentInfo.Directory">
<summary>
Gets Bitrise directory information.
</summary>
<value>
The directory.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Bitrise.IsRunningOnBitrise)
{
Information(
@"Directory:
Source Directory: {0}
Deploy Directory: {1}",
BuildSystem.Bitrise.Environment.Directory.SourceDirectory,
BuildSystem.Bitrise.Environment.Directory.DeployDirectory
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
<para>Via Bitrise.</para>
<example>
<code>
if (Bitrise.IsRunningOnBitrise)
{
Information(
@"Directory:
Source Directory: {0}
Deploy Directory: {1}",
Bitrise.Environment.Directory.SourceDirectory,
Bitrise.Environment.Directory.DeployDirectory
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseEnvironmentInfo.Provisioning">
<summary>
Gets Bitrise provisioning information.
</summary>
<value>
The provisioning.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Bitrise.IsRunningOnBitrise)
{
Information(
@"Provisioning:
Provision Url: {0}
Certificate Url: {1}
Certificate Passphrase: {2}",
BuildSystem.Bitrise.Environment.Provisioning.ProvisionUrl,
BuildSystem.Bitrise.Environment.Provisioning.CertificateUrl,
BuildSystem.Bitrise.Environment.Provisioning.CertificatePassphrase
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
<para>Via Bitrise.</para>
<example>
<code>
if (Bitrise.IsRunningOnBitrise)
{
Information(
@"Provisioning:
Provision Url: {0}
Certificate Url: {1}
Certificate Passphrase: {2}",
Bitrise.Environment.Provisioning.ProvisionUrl,
Bitrise.Environment.Provisioning.CertificateUrl,
Bitrise.Environment.Provisioning.CertificatePassphrase
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseEnvironmentInfo.Repository">
<summary>
Gets Bitrise repository information.
</summary>
<value>
The repository.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Bitrise.IsRunningOnBitrise)
{
Information(
@"Repository:
Git Repository Url: {0}
Git Branch: {1}
Git Tag: {2}
Git Commit: {3}
Pull Request: {4}",
BuildSystem.Bitrise.Environment.Repository.GitRepositoryUrl,
BuildSystem.Bitrise.Environment.Repository.GitBranch,
BuildSystem.Bitrise.Environment.Repository.GitTag,
BuildSystem.Bitrise.Environment.Repository.GitCommit,
BuildSystem.Bitrise.Environment.Repository.PullRequest
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
<para>Via Bitrise.</para>
<example>
<code>
if (Bitrise.IsRunningOnBitrise)
{
Information(
@"Repository:
Git Repository Url: {0}
Git Branch: {1}
Git Tag: {2}
Git Commit: {3}
Pull Request: {4}",
Bitrise.Environment.Repository.GitRepositoryUrl,
Bitrise.Environment.Repository.GitBranch,
Bitrise.Environment.Repository.GitTag,
Bitrise.Environment.Repository.GitCommit,
Bitrise.Environment.Repository.PullRequest
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseEnvironmentInfo.Workflow">
<summary>
Gets Bitrise workflow information.
</summary>
<value>
The workflow.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Bitrise.IsRunningOnBitrise)
{
Information(
@"Workflow:
Workflow Id: {0}
Workflow Title: {1}",
BuildSystem.Bitrise.Environment.Workflow.WorkflowId,
BuildSystem.Bitrise.Environment.Workflow.WorkflowTitle
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
<para>Via Bitrise.</para>
<example>
<code>
if (Bitrise.IsRunningOnBitrise)
{
Information(
@"Workflow:
Workflow Id: {0}
Workflow Title: {1}",
Bitrise.Environment.Workflow.WorkflowId,
Bitrise.Environment.Workflow.WorkflowTitle
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.Bitrise.Data.BitriseEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bitrise.Data.BitriseEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bitrise.Data.BitriseProvisioningInfo">
<summary>
Provides Bitrise provisioning information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseProvisioningInfo.ProvisionUrl">
<summary>
Gets the provision URL.
</summary>
<value>
The provision URL.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseProvisioningInfo.CertificateUrl">
<summary>
Gets the certificate URL.
</summary>
<value>
The certificate URL.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseProvisioningInfo.CertificatePassphrase">
<summary>
Gets the certificate passphrase.
</summary>
<value>
The certificate passphrase.
</value>
</member>
<member name="M:Cake.Common.Build.Bitrise.Data.BitriseProvisioningInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bitrise.Data.BitriseProvisioningInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bitrise.Data.BitrisePullRequestInfo">
<summary>
Provides Bitrise pull request information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.Bitrise.Data.BitrisePullRequestInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bitrise.Data.BitrisePullRequestInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitrisePullRequestInfo.IsPullRequest">
<summary>
Gets a value indicating whether the current build was started by a pull request.
</summary>
<value>
<c>true</c> if the current build was started by a pull request; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitrisePullRequestInfo.Id">
<summary>
Gets the pull request id.
</summary>
<value>
The pull request id.
</value>
</member>
<member name="T:Cake.Common.Build.Bitrise.Data.BitriseRepositoryInfo">
<summary>
Provides Bitrise repository information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseRepositoryInfo.GitRepositoryUrl">
<summary>
Gets the Git repository URL.
</summary>
<value>
The Git repository URL.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseRepositoryInfo.GitBranch">
<summary>
Gets the Git branch.
</summary>
<value>
The Git branch.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseRepositoryInfo.GitTag">
<summary>
Gets the Git tag.
</summary>
<value>
The Git tag.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseRepositoryInfo.GitCommit">
<summary>
Gets the Git commit.
</summary>
<value>
The Git commit.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseRepositoryInfo.PullRequest">
<summary>
Gets the pull request.
</summary>
<value>
The pull request.
</value>
</member>
<member name="M:Cake.Common.Build.Bitrise.Data.BitriseRepositoryInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bitrise.Data.BitriseRepositoryInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bitrise.Data.BitriseWorkflowInfo">
<summary>
Provides Bitrise workflow information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseWorkflowInfo.WorkflowId">
<summary>
Gets the workflow identifier.
</summary>
<value>
The workflow identifier.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseWorkflowInfo.WorkflowTitle">
<summary>
Gets the workflow title.
</summary>
<value>
The workflow title.
</value>
</member>
<member name="M:Cake.Common.Build.Bitrise.Data.BitriseWorkflowInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bitrise.Data.BitriseWorkflowInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bitrise.IBitriseProvider">
<summary>
Represents a Bitrise provider.
</summary>
</member>
<member name="P:Cake.Common.Build.Bitrise.IBitriseProvider.IsRunningOnBitrise">
<summary>
Gets a value indicating whether the current build is running on Bitrise.
</summary>
<value>
<c>true</c> if the current build is running on Bitrise; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.IBitriseProvider.Environment">
<summary>
Gets the Bitrise environment.
</summary>
<value>
The Bitrise environment.
</value>
</member>
<member name="M:Cake.Common.Build.Bitrise.IBitriseProvider.SetEnvironmentString(System.String,System.String)">
<summary>
Sets and environment variable that can be used in next steps on Bitrise.
</summary>
<param name="variable">The variable.</param>
<param name="value">The value.</param>
</member>
<member name="T:Cake.Common.Build.BuildProvider">
<summary>
Represents a build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.Local">
<summary>
Local build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.AppVeyor">
<summary>
AppVeyor build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.TeamCity">
<summary>
TeamCity build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.MyGet">
<summary>
MyGet build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.Bamboo">
<summary>
Bamboo build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.ContinuaCI">
<summary>
ContinuaCI build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.Jenkins">
<summary>
Jenkins build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.Bitrise">
<summary>
Bitrise build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.TravisCI">
<summary>
TravisCI build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.BitbucketPipelines">
<summary>
BitbucketPipelines build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.GoCD">
<summary>
GoCD build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.GitLabCI">
<summary>
GitLabCI build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.AzurePipelines">
<summary>
AzurePipelines build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.AzurePipelinesHosted">
<summary>
AzurePipelinesHosted build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.GitHubActions">
<summary>
GitHubActions build provider.
</summary>
</member>
<member name="T:Cake.Common.Build.BuildSystem">
<summary>
Provides functionality for interacting with
different build systems.
</summary>
</member>
<member name="M:Cake.Common.Build.BuildSystem.#ctor(Cake.Common.Build.AppVeyor.IAppVeyorProvider,Cake.Common.Build.TeamCity.ITeamCityProvider,Cake.Common.Build.MyGet.IMyGetProvider,Cake.Common.Build.Bamboo.IBambooProvider,Cake.Common.Build.ContinuaCI.IContinuaCIProvider,Cake.Common.Build.Jenkins.IJenkinsProvider,Cake.Common.Build.Bitrise.IBitriseProvider,Cake.Common.Build.TravisCI.ITravisCIProvider,Cake.Common.Build.BitbucketPipelines.IBitbucketPipelinesProvider,Cake.Common.Build.GoCD.IGoCDProvider,Cake.Common.Build.GitLabCI.IGitLabCIProvider,Cake.Common.Build.TFBuild.ITFBuildProvider,Cake.Common.Build.GitHubActions.IGitHubActionsProvider,Cake.Common.Build.AzurePipelines.IAzurePipelinesProvider)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.BuildSystem" /> class.
</summary>
<param name="appVeyorProvider">The AppVeyor Provider.</param>
<param name="teamCityProvider">The TeamCity Provider.</param>
<param name="myGetProvider">The MyGet Provider.</param>
<param name="bambooProvider">The Bamboo Provider.</param>
<param name="continuaCIProvider">The Continua CI Provider.</param>
<param name="jenkinsProvider">The Jenkins Provider.</param>
<param name="bitriseProvider">The Bitrise Provider.</param>
<param name="travisCIProvider">The Travis CI provider.</param>
<param name="bitbucketPipelinesProvider">The Bitbucket Pipelines provider.</param>
<param name="goCDProvider">The Go.CD provider.</param>
<param name="gitLabCIProvider">The GitLab CI provider.</param>
<param name="tfBuildProvider">The TF Build provider.</param>
<param name="gitHubActionsProvider">The GitHub Actions provider.</param>
<param name="azurePipelinesProvider">The Azure Pipelines provider.</param>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnAppVeyor">
<summary>
Gets a value indicating whether the current build is running on AppVeyor.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnAppVeyor)
{
// Upload artifact to AppVeyor.
AppVeyor.UploadArtifact("./build/release_x86.zip");
}
</code>
</example>
<value>
<c>true</c> if the build currently is running on AppVeyor; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.AppVeyor">
<summary>
Gets the AppVeyor Provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnAppVeyor)
{
// Upload artifact to AppVeyor.
BuildSystem.AppVeyor.UploadArtifact("./build/release_x86.zip");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnTeamCity">
<summary>
Gets a value indicating whether the current build is running on TeamCity.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnTeamCity)
{
TeamCity.ProgressMessage("Doing an action...");
// Do action...
}
</code>
</example>
<value>
<c>true</c> if the build currently is running on TeamCity; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.TeamCity">
<summary>
Gets the TeamCity Provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnTeamCity)
{
// Set the build number.
BuildSystem.TeamCity.SetBuildNumber("1.2.3.4");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnMyGet">
<summary>
Gets a value indicating whether the current build is running on MyGet.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnMyGet)
{
MyGet.BuildProblem("Something went wrong...");
// Do action...
}
</code>
</example>
<value>
<c>true</c> if the build currently is running on MyGet; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.MyGet">
<summary>
Gets the MyGet Provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnMyGet)
{
// Set the build number.
BuildSystem.MyGet.SetBuildNumber("1.2.3.4");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnBamboo">
<summary>
Gets a value indicating whether the current build is running on Bamboo.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnBamboo)
{
// Get the build number.
var buildNumber = BuildSystem.Bamboo.Number;
}
</code>
</example>
<value>
<c>true</c> if the build currently is running on Bamboo; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.Bamboo">
<summary>
Gets the Bamboo Provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnBamboo)
{
//Get the Bamboo Plan Name
var planName = BuildSystem.Bamboo.Project.PlanName
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnContinuaCI">
<summary>
Gets a value indicating whether the current build is running on Continua CI.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnContinuaCI)
{
// Get the build version.
var buildVersion = BuildSystem.ContinuaCI.Environment.Build.Version;
}
</code>
</example>
<value>
<c>true</c> if the build currently is running on Continua CI; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.ContinuaCI">
<summary>
Gets the Continua CI Provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnContinuaCI)
{
//Get the Continua CI Project Name
var projectName = BuildSystem.ContinuaCI.Environment.Project.Name;
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnJenkins">
<summary>
Gets a value indicating whether this instance is running on Jenkins.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnJenkins)
{
// Get the build number.
var buildNumber = BuildSystem.Jenkins.Environment.Build.BuildNumber;
}
</code>
</example>
<value>
<c>true</c> if this instance is running on jenkins; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.Jenkins">
<summary>
Gets the Jenkins Provider.
</summary>
<value>
The jenkins.
</value>
<example>
<code>
if (BuildSystem.IsRunningOnJenkins)
{
// Get the job name.
var jobName = BuildSystem.Jenkins.Environment.Build.JobName;
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnBitrise">
<summary>
Gets a value indicating whether this instance is running on Bitrise.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnBitrise)
{
// Get the build number.
var buildNumber = BuildSystem.Bitrise.Environment.Build.BuildNumber;
}
</code>
</example>
<value>
<c>true</c> if this instance is running on bitrise; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.Bitrise">
<summary>
Gets the Bitrise Provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnBitrise)
{
// Get the provision profile url.
var buildNumber = BuildSystem.Bitrise.Environment.Provisioning.ProvisionUrl;
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnTravisCI">
<summary>
Gets a value indicating whether this instance is running on Travis CI.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnTravisCI)
{
// Get the build directory.
var buildDirectory = BuildSystem.TravisCI.Environment.Build.BuildDirectory;
}
</code>
</example>
<value>
<c>true</c> if this instance is running on Travis CI; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.TravisCI">
<summary>
Gets the Travis CI provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnTravisCI)
{
// Get the operating system name.
var osName = BuildSystem.TravisCI.Environment.Job.OSName;
}
</code>
</example>
<value>
The Travis CI.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnBitbucketPipelines">
<summary>
Gets a value indicating whether this instance is running on Bitbucket Pipelines.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnBitbucketPipelines)
{
// Get the build commit hash.
var commitHash = BuildSystem.BitbucketPipelines.Environment.Repository.Commit;
}
</code>
</example>
<value>
<c>true</c> if this instance is running on Bitbucket Pipelines; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.BitbucketPipelines">
<summary>
Gets the Bitbucket Pipelines Provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnBitbucketPipelines)
{
// Get the URL friendly repo name.
var repoSlug = BuildSystem.BitbucketPipelines.Environment.Repository.RepoSlug;
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnGoCD">
<summary>
Gets a value indicating whether the current build is running on Go.CD.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnGoCD)
{
// Get the build counter.
var counter = BuildSystem.GoCD.Environment.Pipeline.Counter;
}
</code>
</example>
<value>
<c>true</c> if the build currently is running on Go.CD; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.GoCD">
<summary>
Gets the Go.CD Provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnGoCD)
{
// Get the pipeline counter.
var counter = BuildSystem.GoCD.Environment.Environment.Pipeline.Counter;
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.GitLabCI">
<summary>
Gets the GitLab CI Provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnGitLabCI)
{
// Get the build commit hash.
var commitHash = BuildSystem.GitLabCI.Environment.Build.Reference;
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnGitLabCI">
<summary>
Gets a value indicating whether this instance is running on GitLab CI.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnGitLabCI)
{
// Get the build commit hash.
var commitHash = BuildSystem.GitLabCI.Environment.Build.Reference;
}
</code>
</example>
<value>
<c>true</c> if this instance is running on GitLab CI; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnAzurePipelines">
<summary>
Gets a value indicating whether this instance is running on Azure Pipelines.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnAzurePipelines)
{
// Get the build commit hash.
var commitHash = BuildSystem.AzurePipelines.Environment.Repository.SourceVersion;
}
</code>
</example>
<value>
<c>true</c> if this instance is running on Azure Pipelines; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnAzurePipelinesHosted">
<summary>
Gets a value indicating whether this instance is running on hosted Azure Pipelines.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnAzurePipelinesHosted)
{
// Get the build commit hash.
var commitHash = BuildSystem.AzurePipelines.Environment.Repository.SourceVersion;
}
</code>
</example>
<value>
<c>true</c> if this instance is running on hosted Azure Pipelines; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.AzurePipelines">
<summary>
Gets the Azure Pipelines Provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnAzurePipelines)
{
// Get the build definition name.
var definitionName = BuildSystem.AzurePipelines.Environment.BuildDefinition.Name;
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnGitHubActions">
<summary>
Gets a value indicating whether this instance is running on GitHub Actions.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnGitHubActions)
{
// Get the workflow name.
var workflow = BuildSystem.GitHubActions.Environment.Workflow.Workflow;
}
</code>
</example>
<value>
<c>true</c> if this instance is running on GitHub Actions; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.GitHubActions">
<summary>
Gets the GitHub Actions Provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnGitHubActions)
{
// Get the workflow name.
var workflow = BuildSystem.GitHubActions.Environment.Workflow.Workflow;
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.Provider">
<summary>
Gets the current build provider.
</summary>
<value>The current build provider.</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsLocalBuild">
<summary>
Gets a value indicating whether the current build is local build.
</summary>
<example>
<code>
// Gets a flag telling us if this is a local build or not.
var isLocal = BuildSystem.IsLocalBuild;
// Define a task that only runs locally.
Task("LocalOnly")
.WithCriteria(isLocal)
.Does(() =>
{
});
</code>
</example>
<value>
<c>true</c> if the current build is local build; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsPullRequest">
<summary>
Gets a value indicating whether the current build was started by a pull request.
</summary>
<value>
<c>true</c> if the current build was started by a pull request; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Build.BuildSystemAliases">
<summary>
Contains functionality related to build systems.
</summary>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.BuildSystem(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.BuildSystem"/> instance that can
be used to query for information about the current build system.
</summary>
<example>
<code>
var isLocal = BuildSystem.IsLocalBuild;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="T:Cake.Common.Build.BuildSystem"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.AppVeyor(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.AppVeyor.AppVeyorProvider"/> instance that can
be used to manipulate the AppVeyor environment.
</summary>
<example>
<code>
var isAppVeyorBuild = AppVeyor.IsRunningOnAppVeyor;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.AppVeyor"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.TeamCity(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.TeamCity.TeamCityProvider"/> instance that can
be used to manipulate the TeamCity environment.
</summary>
<example>
<code>
var isTeamCityBuild = TeamCity.IsRunningOnTeamCity;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.TeamCity"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.MyGet(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.MyGet.MyGetProvider"/> instance that can
be used to manipulate the MyGet environment.
</summary>
<example>
<code>
var isMyGetBuild = MyGet.IsRunningOnMyGet;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.MyGet"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.Bamboo(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.Bamboo.BambooProvider"/> instance that can
be used to manipulate the Bamboo environment.
</summary>
<example>
<code>
var isBambooBuild = Bamboo.IsRunningOnBamboo;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.Bamboo"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.ContinuaCI(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.ContinuaCI.ContinuaCIProvider"/> instance that can
be used to manipulate the Continua CI environment.
</summary>
<example>
<code>
var isContinuaCIBuild = ContinuaCI.IsRunningContinuaCI;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.ContinuaCI"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.Jenkins(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.Jenkins.JenkinsProvider"/> instance that can be used to
obtain information from the Jenkins environment.
</summary>
<example>
<code>
var isJenkinsBuild = Jenkins.IsRunningOnJenkins;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.Jenkins"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.Bitrise(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.Bitrise.BitriseProvider"/> instance that can be used to
obtain information from the Bitrise environment.
</summary>
<example>
<code>
var isBitriseBuild = Bitrise.IsRunningOnBitrise;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.Bitrise"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.TravisCI(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.TravisCI.TravisCIProvider"/> instance that can be used to
obtain information from the Travis CI environment.
</summary>
<example>
<code>
var isTravisCIBuild = TravisCI.IsRunningOnTravisCI;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.TravisCI"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.BitbucketPipelines(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.BitbucketPipelines.BitbucketPipelinesProvider"/> instance that can be used to
obtain information from the Bitbucket Pipelines environment.
</summary>
<example>
<code>
var isBitbucketPipelinesBuild = BitbucketPipelines.IsRunningOnBitbucketPipelines;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.BitbucketPipelines"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.GoCD(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.GoCD.GoCDProvider"/> instance that can be used to
obtain information from the Go.CD environment.
</summary>
<example>
<code>
var isGoCDBuild = GoCD.IsRunningOnGoCD;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.GoCD"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.GitLabCI(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.GitLabCI.GitLabCIProvider"/> instance that can be used to
obtain information from the GitLab CI environment.
</summary>
<example>
<code>
var isGitLabCIBuild = GitLabCI.IsRunningOnGitLabCI;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.GitLabCI"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.GitHubActions(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.GitHubActions.GitHubActionsProvider"/> instance that can be used to
obtain information from the GitHub Actions environment.
</summary>
<example>
<code>
var isGitHubActionsBuild = GitHubActions.IsRunningOnGitHubActions;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.GitHubActions"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.AzurePipelines(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.AzurePipelines.AzurePipelinesProvider"/> instance that can be used to
obtain information from the Azure Pipelines environment.
</summary>
<example>
<code>
var isAzurePipelines = AzurePipelines.IsRunningOnAzurePipelines;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.AzurePipelines"/> instance.</returns>
</member>
<member name="T:Cake.Common.Build.ContinuaCI.ContinuaCIInfo">
<summary>
Base class used to provide information about the Continua CI environment.
</summary>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.ContinuaCI.ContinuaCIInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIInfo.GetEnvironmentDateTime(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.DateTime"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIInfo.GetEnvironmentLong(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int64"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIInfo.GetEnvironmentTimeSpan(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.TimeSpan"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIInfo.GetEnvironmentStringList(System.String)">
<summary>
Gets an environment variable as an array of <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable value split by comma into an array of values.</returns>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIInfo.GetEnvironmentStringDictionary(System.String)">
<summary>
Gets matching list of environment variables as an dictionary of <see cref="T:System.String"/>.
</summary>
<param name="variablePrefix">The prefix for the environment variables name.</param>
<returns>A dictionary of environment variables starting with variablePrefix.</returns>
</member>
<member name="T:Cake.Common.Build.ContinuaCI.ContinuaCIMessageType">
<summary>
Provides the known values for Continua CI Message Types.
</summary>
</member>
<member name="F:Cake.Common.Build.ContinuaCI.ContinuaCIMessageType.Debug">
<summary>
Debug Message
</summary>
</member>
<member name="F:Cake.Common.Build.ContinuaCI.ContinuaCIMessageType.Success">
<summary>
Success Message
</summary>
</member>
<member name="F:Cake.Common.Build.ContinuaCI.ContinuaCIMessageType.Information">
<summary>
Information Message
</summary>
</member>
<member name="F:Cake.Common.Build.ContinuaCI.ContinuaCIMessageType.Warning">
<summary>
Warning Message
</summary>
</member>
<member name="F:Cake.Common.Build.ContinuaCI.ContinuaCIMessageType.Error">
<summary>
Error Message
</summary>
</member>
<member name="F:Cake.Common.Build.ContinuaCI.ContinuaCIMessageType.Fatal">
<summary>
Fatal Message
</summary>
</member>
<member name="T:Cake.Common.Build.ContinuaCI.ContinuaCIProvider">
<summary>
Responsible for communicating with Continua CI.
</summary>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIProvider.#ctor(Cake.Core.ICakeEnvironment,Cake.Common.Build.IBuildSystemServiceMessageWriter)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.ContinuaCI.ContinuaCIProvider"/> class.
</summary>
<param name="environment">The cake environment.</param>
<param name="writer">The build system service message writer.</param>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.ContinuaCIProvider.IsRunningOnContinuaCI">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.ContinuaCIProvider.Environment">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIProvider.WriteMessage(System.String,Cake.Common.Build.ContinuaCI.ContinuaCIMessageType)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIProvider.WriteStartGroup(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIProvider.WriteEndBlock(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIProvider.SetVariable(System.String,System.String,System.Boolean)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIProvider.SetBuildVersion(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIProvider.SetBuildStatus(System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo">
<summary>
Provides Continua CI build information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.#ctor(Cake.Core.ICakeEnvironment,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="prefix">The prefix for environment variables in this class.</param>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.Id">
<summary>
Gets the build id.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.Version">
<summary>
Gets the build version.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.StartedBy">
<summary>
Gets the name of the user or trigger starting the build.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.IsFeatureBranchBuild">
<summary>
Gets a value indicating whether the build uses the feature branch.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.BuildNumber">
<summary>
Gets the build number.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.Started">
<summary>
Gets the build start date and time.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.UsesDefaultBranch">
<summary>
Gets a value indicating whether the build uses the default branch.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.HasNewChanges">
<summary>
Gets a value indicating whether the build has new changes.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.ChangesetCount">
<summary>
Gets build the number of changesets associated with this build.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.IssueCount">
<summary>
Gets build the number of issues associated with this build.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.Elapsed">
<summary>
Gets build elapsed time on queue as a time span.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.TimeOnQueue">
<summary>
Gets build time on queue in ticks.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.Repositories">
<summary>
Gets list of repository names.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.RepositoryBranches">
<summary>
Gets list of repository branch names.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.TriggeringBranch">
<summary>
Gets triggering branch name.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.ChangesetRevisions">
<summary>
Gets list of changeset revisions.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.ChangesetUserNames">
<summary>
Gets list of changeset user names.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.ChangesetTagNames">
<summary>
Gets list of changeset tag names.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.LatestChangeset">
<summary>
Gets the latest build changeset.
</summary>
</member>
<member name="T:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo">
<summary>
Provides Continua CI changeset information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo.#ctor(Cake.Core.ICakeEnvironment,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="prefix">The environment variable key prefix.</param>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo.Revision">
<summary>
Gets the revision used to build this release. Format depends on the VCS used.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo.Branch">
<summary>
Gets the changeset branch name.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo.Created">
<summary>
Gets the changeset created date and time.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo.FileCount">
<summary>
Gets the count of the number of files in the changeset.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo.UserName">
<summary>
Gets the changeset author user/committer name.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo.TagCount">
<summary>
Gets the count of the number of tags associated with the changeset.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo.IssueCount">
<summary>
Gets the count of the number of tags associated with the changeset.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo.TagNames">
<summary>
Gets list of changeset tag names.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo.IssueNames">
<summary>
Gets list of changeset issue names.
</summary>
</member>
<member name="T:Cake.Common.Build.ContinuaCI.Data.ContinuaCIConfigurationInfo">
<summary>
Provides Continua CI configuration information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.Data.ContinuaCIConfigurationInfo.#ctor(Cake.Core.ICakeEnvironment,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.ContinuaCI.Data.ContinuaCIConfigurationInfo"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="prefix">The environment variable key prefix.</param>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIConfigurationInfo.Name">
<summary>
Gets the Continua CI Configuration Name.
</summary>
<value>
The Continua CI Configuration Name.
</value>
</member>
<member name="T:Cake.Common.Build.ContinuaCI.Data.ContinuaCIEnvironmentInfo">
<summary>
Provides Continua CI environment information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.Data.ContinuaCIEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.ContinuaCI.Data.ContinuaCIEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIEnvironmentInfo.Configuration">
<summary>
Gets Continua CI configuration information.
</summary>
<value>
The Continua CI configuration information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Configuration:
Name: {0}",
BuildSystem.ContinuaCI.Environment.Configuration.Name
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
<para>Via ContinuaCI.</para>
<example>
<code>
if (ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Configuration:
Name: {0}",
ContinuaCI.Environment.Configuration.Name
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIEnvironmentInfo.Project">
<summary>
Gets Continua CI project information.
</summary>
<value>
The Continua CI project information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Project:
Name: {0}",
BuildSystem.ContinuaCI.Environment.Project.Name
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
<para>Via ContinuaCI.</para>
<example>
<code>
if (ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Project:
Name: {0}",
ContinuaCI.Environment.Project.Name
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIEnvironmentInfo.Build">
<summary>
Gets Continua CI build information.
</summary>
<value>
The Continua CI build information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Build:
Id: {0}
Version: {1}
Started By: {2}
Is Feature Branch Build: {3}
Build Number: {4}
Started: {5}",
BuildSystem.ContinuaCI.Environment.Build.Id,
BuildSystem.ContinuaCI.Environment.Build.Version,
BuildSystem.ContinuaCI.Environment.Build.StartedBy,
BuildSystem.ContinuaCI.Environment.Build.IsFeatureBranchBuild,
BuildSystem.ContinuaCI.Environment.Build.BuildNumber,
BuildSystem.ContinuaCI.Environment.Build.Started
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
<para>Via ContinuaCI.</para>
<example>
<code>
if (ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Build:
Id: {0}
Version: {1}
Started By: {2}
Is Feature Branch Build: {3}
Build Number: {4}
Started: {5}",
ContinuaCI.Environment.Build.Id,
ContinuaCI.Environment.Build.Version,
ContinuaCI.Environment.Build.StartedBy,
ContinuaCI.Environment.Build.IsFeatureBranchBuild,
ContinuaCI.Environment.Build.BuildNumber,
ContinuaCI.Environment.Build.Started
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIEnvironmentInfo.Variable">
<summary>
Gets Continua CI build variables.
</summary>
<value>
The Continua CI build variables.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Variables:
{0}",
BuildSystem.ContinuaCI.Environment.Variable.Aggregate(
new StringBuilder(),(builder, pair) => builder.AppendLine(
string.Format(":", pair.Key, pair.Value)),
builder => builder.ToString())
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
<para>Via ContinuaCI.</para>
<example>
<code>
if (ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Variables:
{0}",
ContinuaCI.Environment.Variable.Aggregate(
new StringBuilder(),(builder, pair) => builder.AppendLine(
string.Format(":", pair.Key, pair.Value)),
builder => builder.ToString())
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIEnvironmentInfo.AgentProperty">
<summary>
Gets Continua CI build agent properties.
</summary>
<value>
The Continua CI build agent properties.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Agent Property:
{0}",
BuildSystem.ContinuaCI.Environment.AgentProperty.Aggregate(
new StringBuilder(),(builder, pair) => builder.AppendLine(
string.Format(":", pair.Key, pair.Value)),
builder => builder.ToString())
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
<para>Via ContinuaCI.</para>
<example>
<code>
if (ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Variables:
{0}",
ContinuaCI.Environment.AgentProperty.Aggregate(
new StringBuilder(),(builder, pair) => builder.AppendLine(
string.Format(":", pair.Key, pair.Value)),
builder => builder.ToString())
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIEnvironmentInfo.Version">
<summary>
Gets Continua CI product version.
</summary>
<value>
The Continua CI product version.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Version: {0}",
BuildSystem.ContinuaCI.Environment.Version
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
<para>Via ContinuaCI.</para>
<example>
<code>
if (ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Version: {0}",
ContinuaCI.Environment.Version
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
</member>
<member name="T:Cake.Common.Build.ContinuaCI.Data.ContinuaCIProjectInfo">
<summary>
Provides Continua CI project information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.Data.ContinuaCIProjectInfo.#ctor(Cake.Core.ICakeEnvironment,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.ContinuaCI.Data.ContinuaCIProjectInfo"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="prefix">The environment variable key prefix.</param>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIProjectInfo.Name">
<summary>
Gets the Continua CI Project Name.
</summary>
<value>
The Continua CI Project Name.
</value>
</member>
<member name="T:Cake.Common.Build.ContinuaCI.IContinuaCIProvider">
<summary>
Represents a Continua CI provider.
</summary>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.IContinuaCIProvider.WriteMessage(System.String,Cake.Common.Build.ContinuaCI.ContinuaCIMessageType)">
<summary>
Write a status message to the Continua CI build log.
</summary>
<param name="message">Message contents.</param>
<param name="status">Build status.</param>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.IContinuaCIProvider.WriteStartGroup(System.String)">
<summary>
Write the start of a message group to the Continua CI build log.
</summary>
<param name="groupName">Group name.</param>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.IContinuaCIProvider.WriteEndBlock(System.String)">
<summary>
Write the end of a message block to the Continua CI build log.
</summary>
<param name="groupName">Group name.</param>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.IContinuaCIProvider.SetVariable(System.String,System.String,System.Boolean)">
<summary>
Set a Continua CI build variable.
</summary>
<param name="name">Name of the variable to set.</param>
<param name="value">Value to assign to the variable.</param>
<param name="skipIfNotDefined">Set to 'true' to prevent the build failing if the variable has not been defined for the configuration.</param>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.IContinuaCIProvider.SetBuildVersion(System.String)">
<summary>
Set a Continua CI build version.
</summary>
<param name="version">The new build version.</param>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.IContinuaCIProvider.SetBuildStatus(System.String)">
<summary>
Set a Continua CI build status message, which is shown on the build details page when a build is running.
</summary>
<param name="text">The new build status text.</param>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.IContinuaCIProvider.IsRunningOnContinuaCI">
<summary>
Gets a value indicating whether the current build is running on Continua CI.
</summary>
<value>
<c>true</c> if the current build is running on Continua CI; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.IContinuaCIProvider.Environment">
<summary>
Gets the Continua CI environment.
</summary>
<value>
The Continua CI environment.
</value>
</member>
<member name="T:Cake.Common.Build.GitHubActions.Data.GitHubActionsEnvironmentInfo">
<summary>
Provides GitHub Actions environment information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Data.GitHubActionsEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitHubActions.Data.GitHubActionsEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsEnvironmentInfo.Home">
<summary>
Gets the GitHub Actions home directory.
</summary>
<value>
The home.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GitHubActions.IsRunningOnGitHubActions)
{
Information(
@"Home: {0}",
BuildSystem.GitHubActions.Environment.Home
);
}
else
{
Information("Not running on GitHubActions");
}
</code>
</example>
<para>Via GitHubActions.</para>
<example>
<code>
if (GitHubActions.IsRunningOnGitHubActions)
{
Information(
@"Home: {0}",
GitHubActions.Environment.Home
);
}
else
{
Information("Not running on GitHubActions");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsEnvironmentInfo.Runner">
<summary>
Gets GitHub Actions runner information.
</summary>
<value>
The GitHub Actions runner information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GitHubActions.IsRunningOnGitHubActions)
{
Information(
@"Runner:
OS: {0}
Temp: {1}
ToolCache: {2}
Workspace: {3}",
BuildSystem.GitHubActions.Environment.Runner.OS,
BuildSystem.GitHubActions.Environment.Runner.Temp,
BuildSystem.GitHubActions.Environment.Runner.ToolCache,
BuildSystem.GitHubActions.Environment.Runner.Workspace
);
}
else
{
Information("Not running on GitHubActions");
}
</code>
</example>
<para>Via GitHubActions.</para>
<example>
<code>
if (GitHubActions.IsRunningOnGitHubActions)
{
Information(
@"Runner:
OS: {0}
Temp: {1}
ToolCache: {2}
Workspace: {3}",
GitHubActions.Environment.Runner.OS,
GitHubActions.Environment.Runner.Temp,
GitHubActions.Environment.Runner.ToolCache,
GitHubActions.Environment.Runner.Workspace
);
}
else
{
Information("Not running on GitHubActions");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsEnvironmentInfo.Workflow">
<summary>
Gets the GitHub Actions workflow information.
</summary>
<value>
The GitHub Actions workflow information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GitHubActions.IsRunningOnGitHubActions)
{
Information(
@"Workflow:
Workflow: {0}
Action: {1}
Actor: {2}",
BuildSystem.GitHubActions.Environment.Workflow.Workflow,
BuildSystem.GitHubActions.Environment.Workflow.Action,
BuildSystem.GitHubActions.Environment.Workflow.Actor
);
}
else
{
Information("Not running on GitHubActions");
}
</code>
</example>
<para>Via GitHubActions.</para>
<example>
<code>
Information(
@"Workflow:
Workflow: {0}
Action: {1}
Actor: {2}",
GitHubActions.Environment.Workflow.Workflow,
GitHubActions.Environment.Workflow.Action,
GitHubActions.Environment.Workflow.Actor
);
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsEnvironmentInfo.PullRequest">
<summary>
Gets GitHub Actions pull request information.
</summary>
<value>
The GitHub Actions pull request information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GitHubActions.IsRunningOnGitHubActions)
{
Information(
@"PullRequest:
IsPullRequest: {0}",
BuildSystem.GitHubActions.Environment.PullRequest.IsPullRequest
);
}
else
{
Information("Not running on GitHubActions");
}
</code>
</example>
<para>Via GitHubActions.</para>
<example>
<code>
if (GitHubActions.IsRunningOnGitHubActions)
{
Information(
@"PullRequest:
IsPullRequest: {0}",
GitHubActions.Environment.PullRequest.IsPullRequest
);
}
else
{
Information("Not running on GitHubActions");
}
</code>
</example>
</member>
<member name="T:Cake.Common.Build.GitHubActions.Data.GitHubActionsPullRequestInfo">
<summary>
Provides GitHub Actions pull request information for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Data.GitHubActionsPullRequestInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitHubActions.Data.GitHubActionsPullRequestInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsPullRequestInfo.IsPullRequest">
<summary>
Gets a value indicating whether the current build was started by a pull request.
</summary>
<value>
<c>true</c> if the current build was started by a pull request; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Build.GitHubActions.Data.GitHubActionsRunnerInfo">
<summary>
Provides GitHub Actions runner information for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Data.GitHubActionsRunnerInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitHubActions.Data.GitHubActionsRunnerInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsRunnerInfo.OS">
<summary>
Gets the operating system of the runner executing the job.
</summary>
<value>
The operating system of the runner executing the job.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsRunnerInfo.Temp">
<summary>
Gets the path of the temporary directory for the runner.
</summary>
<value>
The path of the temporary directory for the runner.
This directory is guaranteed to be empty at the start of each job, even on self-hosted runners.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsRunnerInfo.ToolCache">
<summary>
Gets the path of the directory containing some of the pre-installed tools for GitHub-hosted runners.
</summary>
<value>
The path of the directory containing some of the pre-installed tools for GitHub-hosted runners.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsRunnerInfo.Workspace">
<summary>
Gets the runner workspace directory path.
</summary>
<value>
The runner workspace directory path.
</value>
</member>
<member name="T:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo">
<summary>
Provide GitHub Actions workflow information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.Action">
<summary>
Gets the unique identifier of the action.
</summary>
<value>
The unique identifier of the action.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.Actor">
<summary>
Gets the name of the person or app that initiated the workflow.
</summary>
<value>
The name of the person or app that initiated the workflow.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.ApiUrl">
<summary>
Gets the API URL.
</summary>
<value>
The API URL. For example: https://api.github.com.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.BaseRef">
<summary>
Gets the branch of the base repository.
</summary>
<value>
The branch of the base repository. Only set for forked repositories.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.EventName">
<summary>
Gets the name of the webhook event that triggered the workflow.
</summary>
<value>
The name of the webhook event that triggered the workflow.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.EventPath">
<summary>
Gets the path of the file with the complete webhook event payload.
</summary>
<value>
The path of the file with the complete webhook event payload.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.GraphQLUrl">
<summary>
Gets the GraphQL API URL.
</summary>
<value>
The GraphQL API URL. For example: https://api.github.com/graphql.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.HeadRef">
<summary>
Gets the branch of the head repository.
</summary>
<value>
The branch of the head repository. Only set for forked repositories.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.Job">
<summary>
Gets the job name.
</summary>
<value>
The job name.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.Ref">
<summary>
Gets the branch or tag ref that triggered the workflow.
</summary>
<value>
The branch or tag ref that triggered the workflow.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.Repository">
<summary>
Gets the owner and repository name.
</summary>
<value>
The owner and repository name.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.RepositoryOwner">
<summary>
Gets the repository owner.
</summary>
<value>
The repository owner.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.RunId">
<summary>
Gets the unique number for each run within the repository.
</summary>
<value>
The unique number for each run within the repository.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.RunNumber">
<summary>
Gets the unique number for each run of a particular workflow in the repository.
</summary>
<value>
The unique number for each run of a particular workflow in the repository.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.ServerUrl">
<summary>
Gets the URL of the GitHub server.
</summary>
<value>
The URL of the GitHub server. For example: https://github.com.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.Sha">
<summary>
Gets the commit SHA that triggered the workflow.
</summary>
<value>
The commit SHA that triggered the workflow.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.Workflow">
<summary>
Gets the name of the workflow.
</summary>
<value>
The name of the workflow.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.Workspace">
<summary>
Gets the GitHub workspace directory path.
</summary>
<value>
The GitHub workspace directory path.
</value>
</member>
<member name="T:Cake.Common.Build.GitHubActions.GitHubActionsInfo">
<summary>
Base class used to provide information about the GitHub Actions environment.
</summary>
</member>
<member name="M:Cake.Common.Build.GitHubActions.GitHubActionsInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitHubActions.GitHubActionsInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.GitHubActions.GitHubActionsInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.GitHubActions.GitHubActionsInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.GitHubActions.GitHubActionsInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="T:Cake.Common.Build.GitHubActions.GitHubActionsProvider">
<summary>
Responsible for communicating with GitHub Actions.
</summary>
</member>
<member name="M:Cake.Common.Build.GitHubActions.GitHubActionsProvider.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitHubActions.GitHubActionsProvider"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitHubActions.GitHubActionsProvider.IsRunningOnGitHubActions">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.GitHubActions.GitHubActionsProvider.Environment">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.GitHubActions.IGitHubActionsProvider">
<summary>
Represents a GitHub Actions provider.
</summary>
</member>
<member name="P:Cake.Common.Build.GitHubActions.IGitHubActionsProvider.IsRunningOnGitHubActions">
<summary>
Gets a value indicating whether the current build is running on GitHub Actions.
</summary>
<value>
<c>true</c> if the current build is running on GitHub Actions; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.IGitHubActionsProvider.Environment">
<summary>
Gets the GitHub Actions environment.
</summary>
<value>
The GitHub Actions environment.
</value>
</member>
<member name="T:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo">
<summary>
Provide GitLab CI build information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.Id">
<summary>
Gets the unique id of the current build that GitLab CI uses internally.
</summary>
<value>
The build ID.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.Reference">
<summary>
Gets the commit revision for which project is built.
</summary>
<value>
The commit revision hash.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.Tag">
<summary>
Gets the commit tag name. Present only when building tags.
</summary>
<value>
The build tag name.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.Name">
<summary>
Gets the name of the build as defined in .gitlab-ci.yml.
</summary>
<value>
The name of the build.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.Stage">
<summary>
Gets the name of the stage as defined in .gitlab-ci.yml.
</summary>
<value>
The name of the current stage.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.RefName">
<summary>
Gets the branch or tag name for which project is built.
</summary>
<value>
The branch or tag for this build.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.RepoUrl">
<summary>
Gets the URL to clone the Git repository.
</summary>
<value>
The repository URL.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.Triggered">
<summary>
Gets a value indicating whether the build was triggered.
</summary>
<value>
<c>True</c> if the build was triggered, otherwise <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.Manual">
<summary>
Gets a value indicating whether the build was manually started.
</summary>
<value>
<c>True</c> if the build was started manually, otherwise <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.Token">
<summary>
Gets the token used for authenticating with the GitLab Container Registry.
</summary>
<value>
The build authorisation token.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.PipelineId">
<summary>
Gets the unique id of the current pipeline that GitLab CI uses internally.
</summary>
<value>
The unique build ID.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.PipelineIId">
<summary>
Gets the unique id of the current pipeline scoped to the project.
</summary>
<value>
The unique build ID.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.UserId">
<summary>
Gets the id of the user who started the build.
</summary>
<value>
The user ID.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.UserEmail">
<summary>
Gets the email of the user who started the build.
</summary>
<value>
The email address of the user.
</value>
</member>
<member name="T:Cake.Common.Build.GitLabCI.Data.GitLabCIEnvironmentInfo">
<summary>
Provides GitLab CI environment information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitLabCI.Data.GitLabCIEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitLabCI.Data.GitLabCIEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIEnvironmentInfo.Runner">
<summary>
Gets the GitLab CI runner information.
</summary>
<value>
The GitLab CI runner information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GitLabCI.IsRunningOnGitLabCI)
{
Information(
@"Runner:
Id: {0}
Description: {1}
Tags: {2}",
BuildSystem.GitLabCI.Environment.Runner.Id,
BuildSystem.GitLabCI.Environment.Runner.Description,
BuildSystem.GitLabCI.Environment.Runner.Tags
);
}
else
{
Information("Not running on GitLabCI");
}
</code>
</example>
<para>Via GitLabCI.</para>
<example>
<code>
if (GitLabCI.IsRunningOnGitLabCI)
{
Information(
@"Runner:
Id: {0}
Description: {1}
Tags: {2}",
GitLabCI.Environment.Runner.Id,
GitLabCI.Environment.Runner.Description,
GitLabCI.Environment.Runner.Tags
);
}
else
{
Information("Not running on GitLabCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIEnvironmentInfo.Server">
<summary>
Gets the GitLab CI server information.
</summary>
<value>
The GitLab CI server information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GitLabCI.IsRunningOnGitLabCI)
{
Information(
@"Server:
Name: {0}
Version: {1}
Revision: {2}",
BuildSystem.GitLabCI.Environment.Server.Name,
BuildSystem.GitLabCI.Environment.Server.Version,
BuildSystem.GitLabCI.Environment.Server.Revision
);
}
else
{
Information("Not running on GitLabCI");
}
</code>
</example>
<para>Via GitLabCI.</para>
<example>
<code>
if (GitLabCI.IsRunningOnGitLabCI)
{
Information(
@"Server:
Name: {0}
Version: {1}
Revision: {2}",
GitLabCI.Environment.Server.Name,
GitLabCI.Environment.Server.Version,
GitLabCI.Environment.Server.Revision
);
}
else
{
Information("Not running on GitLabCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIEnvironmentInfo.Build">
<summary>
Gets the GitLab CI build information.
</summary>
<value>
The GitLab CI build information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GitLabCI.IsRunningOnGitLabCI)
{
Information(
@"Build:
Id: {0}
Reference: {1}
Tag: {2}
Name: {3}
Stage: {4}",
BuildSystem.GitLabCI.Environment.Build.Id,
BuildSystem.GitLabCI.Environment.Build.Reference,
BuildSystem.GitLabCI.Environment.Build.Tag,
BuildSystem.GitLabCI.Environment.Build.Tag,
BuildSystem.GitLabCI.Environment.Build.Stage
);
}
else
{
Information("Not running on GitLabCI");
}
</code>
</example>
<para>Via GitLabCI.</para>
<example>
<code>
Information(
@"Build:
Id: {0}
Reference: {1}
Tag: {2}
Name: {3}
Stage: {4}",
GitLabCI.Environment.Build.Id,
GitLabCI.Environment.Build.Reference,
GitLabCI.Environment.Build.Tag,
GitLabCI.Environment.Build.Tag,
GitLabCI.Environment.Build.Stage
);
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIEnvironmentInfo.PullRequest">
<summary>
Gets GitLab CI pull request information.
</summary>
<value>
The GitLab CI pull request information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GitLabCI.IsRunningOnGitLabCI)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Id: {1}
IId: {2}",
BuildSystem.GitLabCI.Environment.PullRequest.IsPullRequest,
BuildSystem.GitLabCI.Environment.PullRequest.Id,
BuildSystem.GitLabCI.Environment.PullRequest.IId
);
}
else
{
Information("Not running on GitLabCI");
}
</code>
</example>
<para>Via GitLabCI.</para>
<example>
<code>
if (GitLabCI.IsRunningOnGitLabCI)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Id: {1}
IId: {2}",
GitLabCI.Environment.PullRequest.IsPullRequest,
GitLabCI.Environment.PullRequest.Id,
GitLabCI.Environment.PullRequest.IId
);
}
else
{
Information("Not running on GitLabCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIEnvironmentInfo.Project">
<summary>
Gets the GitLab CI project information.
</summary>
<value>
The GitLab CI project information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GitLabCI.IsRunningOnGitLabCI)
{
Information(
@"Project:
Id: {0}
Name: {1}
Namespace: {2}
Path: {3}
Url: {4}
Directory: {5}",
BuildSystem.GitLabCI.Environment.Project.Id,
BuildSystem.GitLabCI.Environment.Project.Name,
BuildSystem.GitLabCI.Environment.Project.Namespace,
BuildSystem.GitLabCI.Environment.Project.Path,
BuildSystem.GitLabCI.Environment.Project.Url,
BuildSystem.GitLabCI.Environment.Project.Directory
);
}
else
{
Information("Not running on GitLabCI");
}
</code>
</example>
<para>Via GitLabCI.</para>
<example>
<code>
Information(
@"Project:
Id: {0}
Name: {1}
Namespace: {2}
Path: {3}
Url: {4}
Directory: {5}",
GitLabCI.Environment.Project.Id,
GitLabCI.Environment.Project.Name,
GitLabCI.Environment.Project.Namespace,
GitLabCI.Environment.Project.Path,
GitLabCI.Environment.Project.Url,
GitLabCI.Environment.Project.Directory
);
</code>
</example>
</member>
<member name="T:Cake.Common.Build.GitLabCI.Data.GitLabCIProjectInfo">
<summary>
Provides GitLab CI project information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitLabCI.Data.GitLabCIProjectInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitLabCI.Data.GitLabCIProjectInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIProjectInfo.Id">
<summary>
Gets the unique id of the current project that GitLab CI uses internally.
</summary>
<value>
The project ID.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIProjectInfo.Name">
<summary>
Gets the project name that is currently being built.
</summary>
<value>
The project name.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIProjectInfo.Namespace">
<summary>
Gets the project namespace (username or groupname) that is currently being built.
</summary>
<value>
The project namespace.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIProjectInfo.Path">
<summary>
Gets the namespace with project name.
</summary>
<value>
The project namespace and project name.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIProjectInfo.Url">
<summary>
Gets the HTTP address to access the project.
</summary>
<value>
The HTTP address to access the project.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIProjectInfo.Directory">
<summary>
Gets the full path where the repository is cloned and where the build is run.
</summary>
<value>
The full path where the repository is cloned and where the build is run.
</value>
</member>
<member name="T:Cake.Common.Build.GitLabCI.Data.GitLabCIPullRequestInfo">
<summary>
Provides GitLab CI pull request information for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitLabCI.Data.GitLabCIPullRequestInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitLabCI.Data.GitLabCIPullRequestInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIPullRequestInfo.IsPullRequest">
<summary>
Gets a value indicating whether the current build was started by a pull request.
</summary>
<value>
<c>true</c> if the current build was started by a pull request; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIPullRequestInfo.Id">
<summary>
Gets the pull request id that GitLab CI uses internally.
</summary>
<value>
The pull request id.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIPullRequestInfo.IId">
<summary>
Gets the pull request id scoped to the project.
</summary>
<value>
The pull request id.
</value>
</member>
<member name="T:Cake.Common.Build.GitLabCI.Data.GitLabCIRunnerInfo">
<summary>
Provides GitLab CI runner information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitLabCI.Data.GitLabCIRunnerInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitLabCI.Data.GitLabCIRunnerInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIRunnerInfo.Id">
<summary>
Gets the unique id of runner being used.
</summary>
<value>
The unique id of runner being used.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIRunnerInfo.Description">
<summary>
Gets the description of the runner as saved in GitLab.
</summary>
<value>
The description of the runner as saved in GitLab.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIRunnerInfo.Tags">
<summary>
Gets an array of the defined runner tags.
</summary>
<value>
The defined runner tags.
</value>
</member>
<member name="T:Cake.Common.Build.GitLabCI.Data.GitLabCIServerInfo">
<summary>
Provides GitLab CI server information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitLabCI.Data.GitLabCIServerInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitLabCI.Data.GitLabCIServerInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIServerInfo.Name">
<summary>
Gets the name of CI server that is used to coordinate builds.
</summary>
<value>
The name of CI server that is used to coordinate builds.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIServerInfo.Version">
<summary>
Gets the GitLab version that is used to schedule builds.
</summary>
<value>
The GitLab version that is used to schedule builds.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIServerInfo.Revision">
<summary>
Gets the GitLab revision that is used to schedule builds.
</summary>
<value>
The GitLab revision that is used to schedule builds.
</value>
</member>
<member name="T:Cake.Common.Build.GitLabCI.GitLabCIInfo">
<summary>
Base class used to provide information about the GitLab CI environment.
</summary>
</member>
<member name="M:Cake.Common.Build.GitLabCI.GitLabCIInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitLabCI.GitLabCIInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.GitLabCI.GitLabCIInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.GitLabCI.GitLabCIInfo.GetEnvironmentString(System.String,System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="primaryVariable">The primary environment variable name.</param>
<param name="secondaryVariable">The secondary environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.GitLabCI.GitLabCIInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.GitLabCI.GitLabCIInfo.GetEnvironmentInteger(System.String,System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="primaryVariable">The primary environment variable name.</param>
<param name="secondaryVariable">The secondary environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.GitLabCI.GitLabCIInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.GitLabCI.GitLabCIInfo.GetEnvironmentBoolean(System.String,System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="primaryVariable">The primary environment variable name.</param>
<param name="secondaryVariable">The secondary environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="T:Cake.Common.Build.GitLabCI.GitLabCIProvider">
<summary>
Responsible for communicating with GitLab CI.
</summary>
</member>
<member name="M:Cake.Common.Build.GitLabCI.GitLabCIProvider.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitLabCI.GitLabCIProvider"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitLabCI.GitLabCIProvider.IsRunningOnGitLabCI">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.GitLabCI.GitLabCIProvider.Environment">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.GitLabCI.IGitLabCIProvider">
<summary>
Represents a GitLab CI provider.
</summary>
</member>
<member name="P:Cake.Common.Build.GitLabCI.IGitLabCIProvider.IsRunningOnGitLabCI">
<summary>
Gets a value indicating whether the current build is running on GitLab CI.
</summary>
<value>
<c>true</c> if the current build is running on GitLab CI; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.IGitLabCIProvider.Environment">
<summary>
Gets the GitLab CI environment.
</summary>
<value>
The GitLab CI environment.
</value>
</member>
<member name="T:Cake.Common.Build.GoCD.Data.GoCDBuildCauseInfo">
<summary>
The Go.CD build cause.
</summary>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDBuildCauseInfo.Approver">
<summary>
Gets or sets the approver.
</summary>
<value>
The approver.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDBuildCauseInfo.MaterialRevisions">
<summary>
Gets or sets the material revisions.
</summary>
<value>
The material revisions.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDBuildCauseInfo.TriggerForced">
<summary>
Gets or sets a value indicating whether the trigger was forced.
</summary>
<value>
<c>true</c> if the trigger was forced; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDBuildCauseInfo.TriggerMessage">
<summary>
Gets or sets the trigger message.
</summary>
<value>
The trigger message.
</value>
</member>
<member name="T:Cake.Common.Build.GoCD.Data.GoCDEnvironmentInfo">
<summary>
Provides Go.CD environment information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDEnvironmentInfo.Pipeline">
<summary>
Gets GoCD pipeline information.
</summary>
<value>
The GoCD pipeline information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GoCD.IsRunningOnGoCD)
{
Information(
@"Pipeline:
Name: {0}
Counter: {1}
Label: {2}",
BuildSystem.GoCD.Environment.Pipeline.Name,
BuildSystem.GoCD.Environment.Pipeline.Counter,
BuildSystem.GoCD.Environment.Pipeline.Label
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
<para>Via GoCD.</para>
<example>
<code>
if (GoCD.IsRunningOnGoCD)
{
Information(
@"Pipeline:
Name: {0}
Counter: {1}
Label: {2}",
GoCD.Environment.Pipeline.Name,
GoCD.Environment.Pipeline.Counter,
GoCD.Environment.Pipeline.Label
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDEnvironmentInfo.Stage">
<summary>
Gets GoCD stage information.
</summary>
<value>
The GoCD stage information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GoCD.IsRunningOnGoCD)
{
Information(
@"Stage:
Name: {0}
Counter: {1}",
BuildSystem.GoCD.Environment.Stage.Name,
BuildSystem.GoCD.Environment.Stage.Counter
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
<para>Via GoCD.</para>
<example>
<code>
if (GoCD.IsRunningOnGoCD)
{
Information(
@"Stage:
Name: {0}
Counter: {1}",
GoCD.Environment.Stage.Name,
GoCD.Environment.Stage.Counter
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDEnvironmentInfo.Repository">
<summary>
Gets GoCD repository information.
</summary>
<value>
The GoCD repository information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GoCD.IsRunningOnGoCD)
{
Information(
@"Repository:
Revision: {0}
ToRevision: {1}
FromRevision: {2}",
BuildSystem.GoCD.Environment.Repository.Revision,
BuildSystem.GoCD.Environment.Repository.ToRevision,
BuildSystem.GoCD.Environment.Repository.FromRevision
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
<para>Via GoCD.</para>
<example>
<code>
if (GoCD.IsRunningOnGoCD)
{
Information(
@"Repository:
Revision: {0}
ToRevision: {1}
FromRevision: {2}",
GoCD.Environment.Repository.Revision,
GoCD.Environment.Repository.ToRevision,
GoCD.Environment.Repository.FromRevision
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDEnvironmentInfo.GoCDUrl">
<summary>
Gets the Go.CD URL.
</summary>
<value>
The Go.CD URL.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GoCD.IsRunningOnGoCD)
{
Information(
@"GoCDUrl: {0}",
BuildSystem.GoCD.Environment.GoCDUrl
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
<para>Via GoCD.</para>
<example>
<code>
if (GoCD.IsRunningOnGoCD)
{
Information(
@"GoCDUrl: {0}",
GoCD.Environment.GoCDUrl
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDEnvironmentInfo.EnvironmentName">
<summary>
Gets the environment name. This is only set if the environment is specified. Otherwise the variable is not set.
</summary>
<value>
The environment name.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GoCD.IsRunningOnGoCD)
{
Information(
@"EnvironmentName: {0}",
BuildSystem.GoCD.Environment.EnvironmentName
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
<para>Via GoCD.</para>
<example>
<code>
if (GoCD.IsRunningOnGoCD)
{
Information(
@"EnvironmentName: {0}",
GoCD.Environment.EnvironmentName
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDEnvironmentInfo.JobName">
<summary>
Gets the name of the current job being run.
</summary>
<value>
The job name.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GoCD.IsRunningOnGoCD)
{
Information(
@"JobName: {0}",
BuildSystem.GoCD.Environment.JobName
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
<para>Via GoCD.</para>
<example>
<code>
if (GoCD.IsRunningOnGoCD)
{
Information(
@"JobName: {0}",
GoCD.Environment.JobName
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDEnvironmentInfo.User">
<summary>
Gets the username of the user that triggered the build. This will have one of three possible values:
anonymous - if there is no security.
username of the user, who triggered the build.
changes, if SCM changes auto-triggered the build.
timer, if the pipeline is triggered at a scheduled time.
</summary>
<value>
The username of the user that triggered the build.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GoCD.IsRunningOnGoCD)
{
Information(
@"User: {0}",
BuildSystem.GoCD.Environment.User
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
<para>Via GoCD.</para>
<example>
<code>
if (GoCD.IsRunningOnGoCD)
{
Information(
@"User: {0}",
GoCD.Environment.User
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.GoCD.Data.GoCDEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GoCD.Data.GoCDEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.GoCD.Data.GoCDHistoryInfo">
<summary>
The Go.CD history.
</summary>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDHistoryInfo.Pipelines">
<summary>
Gets or sets the pipelines.
</summary>
<value>
The pipelines.
</value>
</member>
<member name="T:Cake.Common.Build.GoCD.Data.GoCDMaterialRevisionsInfo">
<summary>
The Go.CD material revision information.
</summary>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDMaterialRevisionsInfo.Changed">
<summary>
Gets or sets a value indicating whether a change was made.
</summary>
<value>
<c>true</c> if changed; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDMaterialRevisionsInfo.Modifications">
<summary>
Gets or sets the modifications.
</summary>
<value>
The modifications.
</value>
</member>
<member name="T:Cake.Common.Build.GoCD.Data.GoCDModificationInfo">
<summary>
A change made in the repository since the last time the Go.CD pipeline was run.
</summary>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDModificationInfo.EmailAddress">
<summary>
Gets or sets the email address.
</summary>
<value>
The email address.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDModificationInfo.Id">
<summary>
Gets or sets the identifier.
</summary>
<value>
The identifier.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDModificationInfo.ModifiedTimeUnixMilliseconds">
<summary>
Gets or sets the modified time in milliseconds from the Unix epoch.
</summary>
<value>
The modified time in milliseconds from the Unix epoch.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDModificationInfo.ModifiedTime">
<summary>
Gets or sets the modified time.
</summary>
<value>
The modified time.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDModificationInfo.Username">
<summary>
Gets or sets the username.
</summary>
<value>
The username.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDModificationInfo.Comment">
<summary>
Gets or sets the comment.
</summary>
<value>
The comment.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDModificationInfo.Revision">
<summary>
Gets or sets the revision.
</summary>
<value>
The revision.
</value>
</member>
<member name="T:Cake.Common.Build.GoCD.Data.GoCDPipelineHistoryInfo">
<summary>
The Go.CD pipeline history.
</summary>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDPipelineHistoryInfo.BuildCause">
<summary>
Gets or sets the build cause.
</summary>
<value>
The build cause.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDPipelineHistoryInfo.Comment">
<summary>
Gets or sets the comment.
</summary>
<value>
The comment.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDPipelineHistoryInfo.Name">
<summary>
Gets or sets the name.
</summary>
<value>
The name.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDPipelineHistoryInfo.NaturalOrder">
<summary>
Gets or sets the natural order.
</summary>
<value>
The natural order.
</value>
</member>
<member name="T:Cake.Common.Build.GoCD.Data.GoCDPipelineInfo">
<summary>
Provides GoCD pipeline information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDPipelineInfo.Name">
<summary>
Gets the name of the pipeline.
</summary>
<value>
The name of the pipeline.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDPipelineInfo.Counter">
<summary>
Gets the pipeline counter, showing how many times the current pipeline has been run.
</summary>
<value>
The pipeline counter.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDPipelineInfo.Label">
<summary>
Gets the pipeline label. By default, this is set to the pipeline count.
</summary>
<value>
The pipeline label.
</value>
</member>
<member name="M:Cake.Common.Build.GoCD.Data.GoCDPipelineInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GoCD.Data.GoCDPipelineInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.GoCD.Data.GoCDRepositoryInfo">
<summary>
Provides Go.CD repository information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDRepositoryInfo.Revision">
<summary>
Gets the source control revision.
</summary>
<value>
The the source control revision.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDRepositoryInfo.ToRevision">
<summary>
Gets the last revision the build was triggered by if there were multiple revisions.
</summary>
<value>
The last revision the build was triggered by if there were multiple revisions.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDRepositoryInfo.FromRevision">
<summary>
Gets the first revision the build was triggered by if there were multiple revisions.
</summary>
<value>
The first revision the build was triggered by if there were multiple revisions.
</value>
</member>
<member name="M:Cake.Common.Build.GoCD.Data.GoCDRepositoryInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GoCD.Data.GoCDRepositoryInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.GoCD.Data.GoCDStageInfo">
<summary>
Provides Go.CD commit information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDStageInfo.Name">
<summary>
Gets the name of the current stage being run.
</summary>
<value>
The stage name.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDStageInfo.Counter">
<summary>
Gets the count of the number of times the current stage has been run.
</summary>
<value>
The stage counter.
</value>
</member>
<member name="M:Cake.Common.Build.GoCD.Data.GoCDStageInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GoCD.Data.GoCDStageInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.GoCD.GoCDInfo">
<summary>
Base class used to provide information about the Go.CD environment.
</summary>
</member>
<member name="M:Cake.Common.Build.GoCD.GoCDInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GoCD.GoCDInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.GoCD.GoCDInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.GoCD.GoCDInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.GoCD.GoCDInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="T:Cake.Common.Build.GoCD.GoCDProvider">
<summary>
Responsible for communicating with GoCD.
</summary>
</member>
<member name="M:Cake.Common.Build.GoCD.GoCDProvider.#ctor(Cake.Core.ICakeEnvironment,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GoCD.GoCDProvider" /> class.
</summary>
<param name="environment">The environment.</param>
<param name="log">The cake log.</param>
</member>
<member name="P:Cake.Common.Build.GoCD.GoCDProvider.IsRunningOnGoCD">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.GoCD.GoCDProvider.Environment">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.GoCD.GoCDProvider.GetHistory(System.String,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.GoCD.GoCDProvider.GetHistory(System.String,System.String,System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.GoCD.IGoCDProvider">
<summary>
Represents a Go.CD provider.
</summary>
</member>
<member name="P:Cake.Common.Build.GoCD.IGoCDProvider.IsRunningOnGoCD">
<summary>
Gets a value indicating whether the current build is running on Go.CD.
</summary>
<value>
<c>true</c> if the current build is running on Go.CD; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.IGoCDProvider.Environment">
<summary>
Gets the Go.CD environment.
</summary>
<value>
The Go.CD environment.
</value>
</member>
<member name="M:Cake.Common.Build.GoCD.IGoCDProvider.GetHistory(System.String,System.String)">
<summary>
Gets the Go.CD build history, including the repository modifications that caused the pipeline to start.
</summary>
<param name="username">The Go.CD username.</param>
<param name="password">The Go.CD password.</param>
<returns>The Go.CD build history.</returns>
</member>
<member name="M:Cake.Common.Build.GoCD.IGoCDProvider.GetHistory(System.String,System.String,System.String)">
<summary>
Gets the Go.CD build history, including the repository modifications that caused the pipeline to start.
</summary>
<param name="username">The Go.CD username.</param>
<param name="password">The Go.CD password.</param>
<param name="serverUrl">The Go.CD server URL.</param>
<returns>The Go.CD build history.</returns>
</member>
<member name="T:Cake.Common.Build.IBuildSystemServiceMessageWriter">
<summary>
Represents build system output.
</summary>
</member>
<member name="M:Cake.Common.Build.IBuildSystemServiceMessageWriter.Write(System.String,System.Object[])">
<summary>
Writes a message to the build system output.
</summary>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="T:Cake.Common.Build.Jenkins.Data.JenkinsBuildInfo">
<summary>
Provides Jenkins build information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsBuildInfo.BuildNumber">
<summary>
Gets the build number.
</summary>
<value>
The build number.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsBuildInfo.BuildId">
<summary>
Gets the build identifier which is identical to <see cref="P:Cake.Common.Build.Jenkins.Data.JenkinsBuildInfo.BuildNumber"/> starting from Jenkins 1.597 and a YYYY-MM-DD_hh-mm-ss timestamp for older builds.
</summary>
<value>
The build identifier.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsBuildInfo.BuildDisplayName">
<summary>
Gets the display name of the build.
</summary>
<value>
The display name of the build.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsBuildInfo.BuildTag">
<summary>
Gets the build tag which is a string of "jenkins-${JOB_NAME}-${BUILD_NUMBER}". All forward slashes (/) in the JOB_NAME are replaced with dashes (-).
</summary>
<value>
The build tag.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsBuildInfo.BuildUrl">
<summary>
Gets the build URL.
</summary>
<value>
The build URL.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsBuildInfo.ExecutorNumber">
<summary>
Gets the executor number.
</summary>
<value>
The executor number.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsBuildInfo.Workspace">
<summary>
Gets the absolute path of the workspace directory assigned to the build.
</summary>
<value>
The workspace directory path.
</value>
</member>
<member name="M:Cake.Common.Build.Jenkins.Data.JenkinsBuildInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Jenkins.Data.JenkinsBuildInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo">
<summary>
Provides Jenkins change information for the current build in multibranch projects.
</summary>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo.Id">
<summary>
Gets the change id.
</summary>
<value>
The changed id such as a pull request number.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo.IsPullRequest">
<summary>
Gets a value indicating whether the current build was started by a pull request.
</summary>
<value>
<c>true</c> if the current build was started by a pull request; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo.Url">
<summary>
Gets the change URL.
</summary>
<value>
The change URL.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo.Title">
<summary>
Gets the change title.
</summary>
<value>
The change title.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo.Author">
<summary>
Gets change author.
</summary>
<value>
The change author.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo.AuthorDisplayName">
<summary>
Gets the human name of the change author.
</summary>
<value>
The human name of the change author.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo.AuthorEmail">
<summary>
Gets the email address of the change author.
</summary>
<value>
The email address of the change author.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo.Target">
<summary>
Gets the target/base branch of the change.
</summary>
<value>
The target of the change.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo.Branch">
<summary>
Gets the origin branch of the change.
</summary>
<value>
The origin branch of the change.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo.Fork">
<summary>
Gets the fork name of the change.
</summary>
<value>
The fork name of the change.
</value>
</member>
<member name="M:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Jenkins.Data.JenkinsEnvironmentInfo">
<summary>
Provides Jenkins environment information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsEnvironmentInfo.Build">
<summary>
Gets Jenkins build information.
</summary>
<value>
The build.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Jenkins.IsRunningOnJenkins)
{
Information(
@"Build:
BuildNumber: {0}
BuildId: {1}
BuildDisplayName: {2}",
BuildSystem.Jenkins.Environment.Build.BuildNumber,
BuildSystem.Jenkins.Environment.Build.BuildId,
BuildSystem.Jenkins.Environment.Build.BuildDisplayName
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
<para>Via Jenkins.</para>
<example>
<code>
if (Jenkins.IsRunningOnJenkins)
{
Information(
@"Build:
BuildNumber: {0}
BuildId: {1}
BuildDisplayName: {2}",
Jenkins.Environment.Build.BuildNumber,
Jenkins.Environment.Build.BuildId,
Jenkins.Environment.Build.BuildDisplayName
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsEnvironmentInfo.Repository">
<summary>
Gets Jenkins repository information.
</summary>
<value>
The repository.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Jenkins.IsRunningOnJenkins)
{
Information(
@"Repository:
BranchName: {0}
GitCommitSha: {1}
GitBranch: {2}",
BuildSystem.Jenkins.Environment.Repository.BranchName,
BuildSystem.Jenkins.Environment.Repository.GitCommitSha,
BuildSystem.Jenkins.Environment.Repository.GitBranch
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
<para>Via Jenkins.</para>
<example>
<code>
if (Jenkins.IsRunningOnJenkins)
{
Information(
@"Repository:
BranchName: {0}
GitCommitSha: {1}
GitBranch: {2}",
Jenkins.Environment.Repository.BranchName,
Jenkins.Environment.Repository.GitCommitSha,
Jenkins.Environment.Repository.GitBranch
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsEnvironmentInfo.Job">
<summary>
Gets Jenkins job information.
</summary>
<value>
The job.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Jenkins.IsRunningOnJenkins)
{
Information(
@"Job:
JobName: {0}
JobBaseName: {1}
JobUrl: {2}",
BuildSystem.Jenkins.Environment.Job.JobName,
BuildSystem.Jenkins.Environment.Job.JobBaseName,
BuildSystem.Jenkins.Environment.Job.JobUrl
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
<para>Via Jenkins.</para>
<example>
<code>
if (Jenkins.IsRunningOnJenkins)
{
Information(
@"Job:
JobName: {0}
JobBaseName: {1}
JobUrl: {2}",
Jenkins.Environment.Job.JobName,
Jenkins.Environment.Job.JobBaseName,
Jenkins.Environment.Job.JobUrl
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsEnvironmentInfo.Node">
<summary>
Gets the node.
</summary>
<value>
The node.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Jenkins.IsRunningOnJenkins)
{
Information(
@"Node:
NodeName: {0}
NodeLabels: {1}",
BuildSystem.Jenkins.Environment.Node.NodeName,
BuildSystem.Jenkins.Environment.Node.NodeLabels
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
<para>Via Jenkins.</para>
<example>
<code>
if (Jenkins.IsRunningOnJenkins)
{
Information(
@"Node:
NodeName: {0}
NodeLabels: {1}",
Jenkins.Environment.Node.NodeName,
Jenkins.Environment.Node.NodeLabels
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsEnvironmentInfo.Change">
<summary>
Gets the change.
</summary>
<value>
The change.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Jenkins.IsRunningOnJenkins)
{
Information(
@"Change:
Id: {0}
Url: {1}
Title: {2}",
BuildSystem.Jenkins.Environment.Change.Id,
BuildSystem.Jenkins.Environment.Change.Url,
BuildSystem.Jenkins.Environment.Change.Title
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
<para>Via Jenkins.</para>
<example>
<code>
if (Jenkins.IsRunningOnJenkins)
{
Information(
@"Change:
Id: {0}
Url: {1}
Title: {2}",
Jenkins.Environment.Change.Id,
Jenkins.Environment.Change.Url,
Jenkins.Environment.Change.Title
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsEnvironmentInfo.JenkinsHome">
<summary>
Gets the absolute path of the directory assigned on the master node for Jenkins to store data.
</summary>
<value>
The absolute path of the directory assigned on the master node for Jenkins to store data.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Jenkins.IsRunningOnJenkins)
{
Information(
@"JenkinsHome: {0}",
BuildSystem.Jenkins.Environment.JenkinsHome
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
<para>Via Jenkins.</para>
<example>
<code>
if (Jenkins.IsRunningOnJenkins)
{
Information(
@"JenkinsHome: {0}",
Jenkins.Environment.JenkinsHome
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsEnvironmentInfo.JenkinsUrl">
<summary>
Gets the full URL of Jenkins (note: only available if Jenkins URL is set in system configuration).
</summary>
<value>
The full URL of Jenkins.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Jenkins.IsRunningOnJenkins)
{
Information(
@"JenkinsUrl: {0}",
BuildSystem.Jenkins.Environment.JenkinsUrl
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
<para>Via Jenkins.</para>
<example>
<code>
if (Jenkins.IsRunningOnJenkins)
{
Information(
@"JenkinsUrl: {0}",
Jenkins.Environment.JenkinsUrl
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.Jenkins.Data.JenkinsEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Jenkins.Data.JenkinsEnvironmentInfo" /> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Jenkins.Data.JenkinsJobInfo">
<summary>
Provides Jenkins job information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsJobInfo.JobName">
<summary>
Gets the name of the job.
</summary>
<value>
The name of the job.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsJobInfo.JobBaseName">
<summary>
Gets the short name of the project of this build stripping off folder paths, such as "foo" for "bar/foo".
</summary>
<value>
The base name of the job.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsJobInfo.JobUrl">
<summary>
Gets the URL of the job.
</summary>
<value>
The URL of the job.
</value>
</member>
<member name="M:Cake.Common.Build.Jenkins.Data.JenkinsJobInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Jenkins.Data.JenkinsJobInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Jenkins.Data.JenkinsNodeInfo">
<summary>
Provides Jenkins node information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsNodeInfo.NodeName">
<summary>
Gets the name of the node.
</summary>
<value>
The name of the node.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsNodeInfo.NodeLabels">
<summary>
Gets the node labels.
</summary>
<value>
The node labels.
</value>
</member>
<member name="M:Cake.Common.Build.Jenkins.Data.JenkinsNodeInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Jenkins.Data.JenkinsNodeInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo">
<summary>
Provides Jenkins repository information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.BranchName">
<summary>
Gets the branch name which will be build in a multibranch project.
</summary>
<value>
The branch name.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.GitCommitSha">
<summary>
Gets the Git commit sha.
</summary>
<value>
The Git commit sha.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.GitPreviousCommitSha">
<summary>
Gets the previous Git commit sha.
</summary>
<value>
The previous Git commit sha.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.GitPreviousSuccessfullCommitSha">
<summary>
Gets the previous successfull Git commit sha.
</summary>
<value>
The previous successfull Git commit sha.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.GitBranch">
<summary>
Gets the Git branch.
</summary>
<value>
The Git branch.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.GitLocalBranch">
<summary>
Gets the Git local branch.
</summary>
<value>
The Git local branch.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.GitCheckoutDirectory">
<summary>
Gets the Git checkout directory.
</summary>
<value>
The Git checkout directory.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.GitUrl">
<summary>
Gets the Git remote URL.
</summary>
<value>
The Git remote URL.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.SvnRevision">
<summary>
Gets the SVN revision.
</summary>
<value>
The SVN revision.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.CvsBranch">
<summary>
Gets the CVS branch.
</summary>
<value>
The CVS branch.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.SvnUrl">
<summary>
Gets the SVN URL.
</summary>
<value>
The SVN URL.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.MercurialRevision">
<summary>
Gets the full id of the Mercurial revision.
</summary>
<value>
The full id of the Mercurial revision.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.MercurialRevisionShort">
<summary>
Gets the abbreviated id of the Mercurial revision.
</summary>
<value>
The abbreviated id of the Mercurial revision.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.MercurialRevisionNumber">
<summary>
Gets the Mercurial revision number.
</summary>
<value>
The Mercurial revision number.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.MercurialRevisionBranch">
<summary>
Gets the Mercurial revision branch.
</summary>
<value>
The Mercurial revision branch.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.MercurialRepositoryUrl">
<summary>
Gets the Mercurial repository URL.
</summary>
<value>
The Mercurial repository URL.
</value>
</member>
<member name="M:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Jenkins.IJenkinsProvider">
<summary>
Represents a Jenkins Provider.
</summary>
</member>
<member name="P:Cake.Common.Build.Jenkins.IJenkinsProvider.IsRunningOnJenkins">
<summary>
Gets a value indicating whether this instance is running on jenkins.
</summary>
<value>
<c>true</c> if this instance is running on jenkins; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.IJenkinsProvider.Environment">
<summary>
Gets the Jenkins environment.
</summary>
<value>
The Jenkins environment.
</value>
</member>
<member name="T:Cake.Common.Build.Jenkins.JenkinsInfo">
<summary>
Base class used to provide information about the Jenkins environment.
</summary>
</member>
<member name="M:Cake.Common.Build.Jenkins.JenkinsInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Jenkins.JenkinsInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.Jenkins.JenkinsInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.Jenkins.JenkinsInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.Jenkins.JenkinsInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="T:Cake.Common.Build.Jenkins.JenkinsProvider">
<summary>
Responsible for communicating with Jenkins.
</summary>
</member>
<member name="M:Cake.Common.Build.Jenkins.JenkinsProvider.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Jenkins.JenkinsProvider"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.Jenkins.JenkinsProvider.IsRunningOnJenkins">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.Jenkins.JenkinsProvider.Environment">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.MyGet.IMyGetProvider">
<summary>
Represents a MyGet provider.
</summary>
</member>
<member name="P:Cake.Common.Build.MyGet.IMyGetProvider.IsRunningOnMyGet">
<summary>
Gets a value indicating whether the current build is running on MyGet.
</summary>
<value>
<c>true</c> if the current build is running on MyGet; otherwise, <c>false</c>.
</value>
</member>
<member name="M:Cake.Common.Build.MyGet.IMyGetProvider.BuildProblem(System.String)">
<summary>
Report a build problem to MyGet.
</summary>
<param name="description">Description of build problem.</param>
</member>
<member name="M:Cake.Common.Build.MyGet.IMyGetProvider.SetParameter(System.String,System.String)">
<summary>
Allows setting an environment variable that can be used by a future process.
</summary>
<param name="name">Name of the parameter to set.</param>
<param name="value">Value to assign to the parameter.</param>
</member>
<member name="M:Cake.Common.Build.MyGet.IMyGetProvider.WriteStatus(System.String,Cake.Common.Build.MyGet.MyGetBuildStatus,System.String)">
<summary>
Write a status message to the MyGet build log.
</summary>
<param name="message">Message contents.</param>
<param name="status">Build status.</param>
<param name="errorDetails">Error details if status is error.</param>
</member>
<member name="M:Cake.Common.Build.MyGet.IMyGetProvider.SetBuildNumber(System.String)">
<summary>
Tells MyGet to change the current build number.
</summary>
<param name="buildNumber">The required build number.</param>
</member>
<member name="T:Cake.Common.Build.MyGet.MyGetBuildStatus">
<summary>
Provides the known values for MyGet Build Status.
</summary>
</member>
<member name="F:Cake.Common.Build.MyGet.MyGetBuildStatus.Failure">
<summary>
Failure Status
</summary>
</member>
<member name="F:Cake.Common.Build.MyGet.MyGetBuildStatus.Error">
<summary>
Error Status
</summary>
</member>
<member name="F:Cake.Common.Build.MyGet.MyGetBuildStatus.Warning">
<summary>
Warning Status
</summary>
</member>
<member name="F:Cake.Common.Build.MyGet.MyGetBuildStatus.Normal">
<summary>
Normal Status
</summary>
</member>
<member name="T:Cake.Common.Build.MyGet.MyGetProvider">
<summary>
Responsible for communicating with MyGet.
</summary>
</member>
<member name="M:Cake.Common.Build.MyGet.MyGetProvider.#ctor(Cake.Core.ICakeEnvironment,Cake.Common.Build.IBuildSystemServiceMessageWriter)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.MyGet.MyGetProvider"/> class.
</summary>
<param name="environment">The cake environment.</param>
<param name="writer">The build system service message writer.</param>
</member>
<member name="P:Cake.Common.Build.MyGet.MyGetProvider.IsRunningOnMyGet">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.MyGet.MyGetProvider.BuildProblem(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.MyGet.MyGetProvider.SetParameter(System.String,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.MyGet.MyGetProvider.WriteStatus(System.String,Cake.Common.Build.MyGet.MyGetBuildStatus,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.MyGet.MyGetProvider.SetBuildNumber(System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo">
<summary>
Provides TeamCity build information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo.BuildConfName">
<summary>
Gets the build configuration name.
</summary>
<value>
The build configuration name.
</value>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo.Number">
<summary>
Gets the build number.
</summary>
<value>
The build number.
</value>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo.StartDateTime">
<summary>
Gets the build start date and time.
</summary>
<value>
The build start date and time if available, or <see langword="null"/>.
</value>
<remarks>
The build start date and time are obtained from reading two environment variables
BUILD_START_DATE (yyyyMMdd) and BUILD_START_TIME (HHmmss) are automatically set by JetBrain's
<see href="https://confluence.jetbrains.com/display/TW/Groovy+plug">Groovy plug</see> plugin.
</remarks>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo.BranchName">
<summary>
Gets the branch display name.
</summary>
<value>
The branch display name.
</value>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo.VcsBranchName">
<summary>
Gets the vcs branch name.
</summary>
<value>
The vcs branch name.
</value>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo.BuildProperties">
<summary>
Gets the TeamCity build properties.
</summary>
<value>
The TeamCity build properties as a key/value dictionary.
</value>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo.ConfigProperties">
<summary>
Gets the TeamCity config properties.
</summary>
<value>
The TeamCity config properties as a key/value dictionary.
</value>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo.RunnerProperties">
<summary>
Gets the TeamCity runner properties.
</summary>
<value>
The TeamCity runner properties as a key/value dictionary.
</value>
</member>
<member name="M:Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo.#ctor(Cake.Core.ICakeEnvironment,Cake.Core.IO.IFileSystem)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="fileSystem">The file system.</param>
</member>
<member name="T:Cake.Common.Build.TeamCity.Data.TeamCityEnvironmentInfo">
<summary>
Provides TeamCity environment information for current build.
</summary>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityEnvironmentInfo.Project">
<summary>
Gets TeamCity project information.
</summary>
<value>
The TeamCity project information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TeamCity.IsRunningOnTeamCity)
{
Information(
@"Project:
Name: {0}",
BuildSystem.TeamCity.Environment.Project.Name
);
}
else
{
Information("Not running on TeamCity");
}
</code>
</example>
<para>Via TeamCity.</para>
<example>
<code>
if (TeamCity.IsRunningOnTeamCity)
{
Information(
@"Project:
Name: {0}",
TeamCity.Environment.Project.Name
);
}
else
{
Information("Not running on TeamCity");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityEnvironmentInfo.Build">
<summary>
Gets TeamCity build information.
</summary>
<value>
The TeamCity build information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TeamCity.IsRunningOnTeamCity)
{
Information(
@"Build:
BuildConfName: {0}
Number: {1}",
BuildSystem.TeamCity.Environment.Build.BuildConfName,
BuildSystem.TeamCity.Environment.Build.Number
);
}
else
{
Information("Not running on TeamCity");
}
</code>
</example>
<para>Via TeamCity.</para>
<example>
<code>
if (TeamCity.IsRunningOnTeamCity)
{
Information(
@"Build:
BuildConfName: {0}
Number: {1}",
TeamCity.Environment.Build.BuildConfName,
TeamCity.Environment.Build.Number
);
}
else
{
Information("Not running on TeamCity");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityEnvironmentInfo.PullRequest">
<summary>
Gets TeamCity pull-request information.
</summary>
<value>
The TeamCity pull-request information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TeamCity.IsRunningOnTeamCity)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Number: {1}",
BuildSystem.TeamCity.Environment.PullRequest.IsPullRequest,
BuildSystem.TeamCity.Environment.PullRequest.Number
);
}
else
{
Information("Not running on TeamCity");
}
</code>
</example>
<para>Via TeamCity.</para>
<example>
<code>
if (TeamCity.IsRunningOnTeamCity)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Number: {1}",
TeamCity.Environment.PullRequest.IsPullRequest,
TeamCity.Environment.PullRequest.Number
);
}
else
{
Information("Not running on TeamCity");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.TeamCity.Data.TeamCityEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment,Cake.Core.IO.IFileSystem)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TeamCity.Data.TeamCityEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="fileSystem">The file system.</param>
</member>
<member name="T:Cake.Common.Build.TeamCity.Data.TeamCityProjectInfo">
<summary>
Provides TeamCity project information for current build.
</summary>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityProjectInfo.Name">
<summary>
Gets the TeamCity project name.
</summary>
<value>
The TeamCity project name.
</value>
</member>
<member name="M:Cake.Common.Build.TeamCity.Data.TeamCityProjectInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TeamCity.Data.TeamCityProjectInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.TeamCity.Data.TeamCityPullRequestInfo">
<summary>
Provides TeamCity pull request information for current build.
</summary>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityPullRequestInfo.IsPullRequest">
<summary>
Gets a value indicating whether the current build was started by a pull request.
</summary>
<value>
<c>true</c> if the current build was started by a pull request; otherwise, <c>false</c>.
</value>
<remarks>
<c>env.Git_Branch</c> is a required parameter in TeamCity for this to work.
</remarks>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityPullRequestInfo.Number">
<summary>
Gets the pull request number.
</summary>
<value>
The pull request number.
</value>
<remarks>
<c>env.Git_Branch</c> is a required parameter in TeamCity for this to work.
</remarks>
</member>
<member name="M:Cake.Common.Build.TeamCity.Data.TeamCityPullRequestInfo.#ctor(Cake.Core.ICakeEnvironment,Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TeamCity.Data.TeamCityPullRequestInfo"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="buildInfo">The TeamCity build info.</param>
</member>
<member name="T:Cake.Common.Build.TeamCity.ITeamCityProvider">
<summary>
Represents a TeamCity provider.
</summary>
</member>
<member name="P:Cake.Common.Build.TeamCity.ITeamCityProvider.IsRunningOnTeamCity">
<summary>
Gets a value indicating whether the current build is running on TeamCity.
</summary>
<value>
<c>true</c> if the current build is running on TeamCity; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.TeamCity.ITeamCityProvider.Environment">
<summary>
Gets the TeamCity environment.
</summary>
<value>
The TeamCity environment.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TeamCity.IsRunningOnTeamCity)
{
Information(
@"Environment:
PullRequest: {0}
Build Configuration Name: {1}
TeamCity Project Name: {2}",
BuildSystem.TeamCity.Environment.PullRequest.IsPullRequest,
BuildSystem.TeamCity.Environment.Build.BuildConfName,
BuildSystem.TeamCity.Environment.Project.Name
);
}
else
{
Information("Not running on TeamCity");
}
</code>
</example>
<para>Via TeamCity.</para>
<example>
<code>
if (TeamCity.IsRunningOnTeamCity)
{
Information(
@"Environment:
PullRequest: {0}
Build Configuration Name: {1}
TeamCity Project Name: {2}",
BuildSystem.TeamCity.Environment.PullRequest.IsPullRequest,
BuildSystem.TeamCity.Environment.Build.BuildConfName,
BuildSystem.TeamCity.Environment.Project.Name
);
}
else
{
Information("Not running on TeamCity");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.BuildProblem(System.String,System.String)">
<summary>
Report a build problem to TeamCity.
</summary>
<param name="description">A human-readable plain text describing the build problem. By default, the description appears in the build status text and in the list of build's problems. The text is limited to 4000 symbols, and will be truncated if the limit is exceeded.</param>
<param name="identity">A unique problem ID (optional). Different problems must have different identity, same problems - same identity, which should not change throughout builds if the same problem, for example, the same compilation error occurs. It must be a valid Java ID up to 60 characters. If omitted, the identity is calculated based on the description text.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.ImportData(System.String,Cake.Core.IO.FilePath)">
<summary>
Tell TeamCity to import data of a given type.
</summary>
<param name="type">Date type.</param>
<param name="path">Data file path.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.ImportDotCoverCoverage(Cake.Core.IO.FilePath,Cake.Core.IO.DirectoryPath)">
<summary>
Tell TeamCity to import coverage from dotCover snapshot file.
</summary>
<param name="snapshotFile">Snapshot file path.</param>
<param name="dotCoverHome">The full path to the dotCover home folder to override the bundled dotCover.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.PublishArtifacts(System.String)">
<summary>
Tells TeamCity to publish artifacts in the given directory.
</summary>
<param name="path">Path to artifacts.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.SetBuildNumber(System.String)">
<summary>
Tells TeamCity to change the current build number.
</summary>
<param name="buildNumber">The required build number.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.SetParameter(System.String,System.String)">
<summary>
Tells TeamCity to set a named parameter with a given value.
</summary>
<param name="parameterName">The name of the parameter to set.</param>
<param name="parameterValue">The value to set for the named parameter.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.WriteEndBlock(System.String)">
<summary>
Write the end of a message block to the TeamCity build log.
</summary>
<param name="blockName">Block name.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.WriteEndBuildBlock(System.String)">
<summary>
Write the end of a build block to the TeamCity build log.
</summary>
<param name="compilerName">Build compiler name.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.WriteEndProgress(System.String)">
<summary>
Write a progressFinish message to the TeamCity build log.
</summary>
<param name="message">Build log message.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.WriteProgressMessage(System.String)">
<summary>
Write a progress message to the TeamCity build log.
</summary>
<param name="message">Build log message.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.WriteStartBlock(System.String)">
<summary>
Write the start of a message block to the TeamCity build log.
</summary>
<param name="blockName">Block name.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.WriteStartBuildBlock(System.String)">
<summary>
Write the start of a build block to the TeamCity build log.
</summary>
<param name="compilerName">Build compiler name.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.WriteStartProgress(System.String)">
<summary>
Write a progressStart message to the TeamCity build log.
</summary>
<param name="message">Build log message.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.WriteStatus(System.String,System.String,System.String)">
<summary>
Write a status message to the TeamCity build log.
</summary>
<param name="message">Message contents.</param>
<param name="status">Build status.</param>
<param name="errorDetails">Error details if status is error.</param>
</member>
<member name="T:Cake.Common.Build.TeamCity.TeamCityDisposableExtensions">
<summary>
A set of extensions for allowing "using" with TeamCity "blocks".
</summary>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityDisposableExtensions.Block(Cake.Common.Build.TeamCity.ITeamCityProvider,System.String)">
<summary>
Writes the start of a TeamCity message block, then returns a disposable that writes the report block end on dispose.
</summary>
<param name="teamCityProvider">TeamCity provider.</param>
<param name="blockName">The name of the report block.</param>
<returns>A disposable that writes the report block end.</returns>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityDisposableExtensions.BuildBlock(Cake.Common.Build.TeamCity.ITeamCityProvider,System.String)">
<summary>
Writes the start of a TeamCity build block, then returns a disposable that writes the build block end on dispose.
</summary>
<param name="teamCityProvider">TeamCity provider.</param>
<param name="compilerName">The name of the build block.</param>
<returns>A disposable that writes the build block end.</returns>
</member>
<member name="T:Cake.Common.Build.TeamCity.TeamCityInfo">
<summary>
Base class used to provide information about the TeamCity environment.
</summary>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TeamCity.TeamCityInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="T:Cake.Common.Build.TeamCity.TeamCityProvider">
<summary>
Responsible for communicating with TeamCity.
</summary>
</member>
<member name="P:Cake.Common.Build.TeamCity.TeamCityProvider.IsRunningOnTeamCity">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.TeamCity.TeamCityProvider.Environment">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.#ctor(Cake.Core.ICakeEnvironment,Cake.Core.IO.IFileSystem,Cake.Common.Build.IBuildSystemServiceMessageWriter)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TeamCity.TeamCityProvider"/> class.
</summary>
<param name="environment">The cake environment.</param>
<param name="fileSystem">The cake file system.</param>
<param name="writer">The build system service message writer.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.WriteProgressMessage(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.WriteStartProgress(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.WriteEndProgress(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.WriteStartBlock(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.WriteEndBlock(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.WriteStartBuildBlock(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.WriteEndBuildBlock(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.WriteStatus(System.String,System.String,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.ImportData(System.String,Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.ImportDotCoverCoverage(Cake.Core.IO.FilePath,Cake.Core.IO.DirectoryPath)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.BuildProblem(System.String,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.PublishArtifacts(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.SetBuildNumber(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.SetParameter(System.String,System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.TeamCity.NamespaceDoc">
<summary>
This namespace contain types used
to interact with TeamCity.
</summary>
</member>
<member name="T:Cake.Common.Build.TFBuild.Data.TFBuildAgentInfo">
<summary>
Provides TF Build agent info for the current build and build agent.
</summary>
</member>
<member name="M:Cake.Common.Build.TFBuild.Data.TFBuildAgentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TFBuild.Data.TFBuildAgentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildAgentInfo.BuildDirectory">
<summary>
Gets the local path on the agent where all folders for a given build definition are created.
</summary>
<value>
The local path on the agent where all folders for a given build definition are created.
</value>
<example><c>c:\agent\_work\1</c>.</example>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildAgentInfo.HomeDirectory">
<summary>
Gets the directory the agent is installed into. This contains the agent software.
</summary>
<remarks>If you are using a self-hosted agent, this directory is specified by you.</remarks>
<value>
The directory the agent is installed into.
</value>
<example><c>c:\agent\</c>.</example>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildAgentInfo.WorkingDirectory">
<summary>
Gets the working directory for this agent.
</summary>
<value>
The working directory for this agent.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildAgentInfo.Id">
<summary>
Gets the ID of the agent.
</summary>
<value>
The ID of the agent.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildAgentInfo.JobName">
<summary>
Gets the display name of the running job.
</summary>
<value>
The display name of the running job.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildAgentInfo.JobStatus">
<summary>
Gets the status of the build.
</summary>
<value>
The status of the build.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildAgentInfo.Name">
<summary>
Gets the name of the agent that is registered with the pool.
</summary>
<remarks>If you are using a self-hosted agent, this is specified by you.</remarks>
<value>
The name of the agent that is registered with the pool.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildAgentInfo.MachineName">
<summary>
Gets the name of the machine on which the agent is installed.
</summary>
<value>
The name of the machine on which the agent is installed.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildAgentInfo.ToolsDirectory">
<summary>
Gets the directory used by tasks such as Node Tool Installer and Use Python Version to switch between multiple versions of a tool.
</summary>
<remarks>
These tasks will add tools from this directory to PATH so that subsequent build steps can use them.
</remarks>
<value>
The task directory.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildAgentInfo.IsHosted">
<summary>
Gets a value indicating whether the current agent is a hosted agent.
</summary>
<value>
<c>true</c> if the current agent is a hosted agent; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Build.TFBuild.Data.TFBuildArtifactType">
<summary>
Provides the type of a TF Build artifact.
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFBuildArtifactType.Container">
<summary>
The container type.
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFBuildArtifactType.FilePath">
<summary>
The file path type.
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFBuildArtifactType.VersionControl">
<summary>
The version control path type.
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFBuildArtifactType.GitRef">
<summary>
The Git reference type.
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFBuildArtifactType.TFVCLabel">
<summary>
The TFVC label type.
</summary>
</member>
<member name="T:Cake.Common.Build.TFBuild.Data.TFBuildDefinitionInfo">
<summary>
Provides TF Build Definition information for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.TFBuild.Data.TFBuildDefinitionInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TFBuild.Data.TFBuildDefinitionInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildDefinitionInfo.Id">
<summary>
Gets the build definition ID.
</summary>
<value>
The build definition ID.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildDefinitionInfo.Name">
<summary>
Gets the build definition name.
</summary>
<value>
The build definition name.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildDefinitionInfo.Version">
<summary>
Gets the build definition version.
</summary>
<value>
The build definition version.
</value>
</member>
<member name="T:Cake.Common.Build.TFBuild.Data.TFBuildEnvironmentInfo">
<summary>
Provides TF Build Environment information for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.TFBuild.Data.TFBuildEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TFBuild.Data.TFBuildEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildEnvironmentInfo.Repository">
<summary>
Gets TF Build repository information.
</summary>
<value>
The TF Build repository information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TFBuild.IsRunningOnTFBuild)
{
Information(
@"Repository:
Branch: {0}
SourceVersion: {1}
Shelveset: {2}",
BuildSystem.TFBuild.Environment.Repository.Branch,
BuildSystem.TFBuild.Environment.Repository.SourceVersion,
BuildSystem.TFBuild.Environment.Repository.Shelveset
);
}
else
{
Information("Not running on TFBuild");
}
</code>
</example>
<para>Via TFBuild.</para>
<example>
<code>
if (TFBuild.IsRunningOnTFBuild)
{
Information(
@"Repository:
Branch: {0}
SourceVersion: {1}
Shelveset: {2}",
TFBuild.Environment.Repository.Branch,
TFBuild.Environment.Repository.SourceVersion,
TFBuild.Environment.Repository.Shelveset
);
}
else
{
Information("Not running on TFBuild");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildEnvironmentInfo.BuildDefinition">
<summary>
Gets TF Build Definition information.
</summary>
<value>
The TF Build Definition.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TFBuild.IsRunningOnTFBuild)
{
Information(
@"BuildDefinition:
Id: {0}
Name: {1}
Version: {2}",
BuildSystem.TFBuild.Environment.BuildDefinition.Id,
BuildSystem.TFBuild.Environment.BuildDefinition.Name,
BuildSystem.TFBuild.Environment.BuildDefinition.Version
);
}
else
{
Information("Not running on TFBuild");
}
</code>
</example>
<para>Via TFBuild.</para>
<example>
<code>
if (TFBuild.IsRunningOnTFBuild)
{
Information(
@"BuildDefinition:
Id: {0}
Name: {1}
Version: {2}",
TFBuild.Environment.BuildDefinition.Id,
TFBuild.Environment.BuildDefinition.Name,
TFBuild.Environment.BuildDefinition.Version
);
}
else
{
Information("Not running on TFBuild");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildEnvironmentInfo.Build">
<summary>
Gets TF Build information.
</summary>
<value>
The TF Build.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TFBuild.IsRunningOnTFBuild)
{
Information(
@"Build:
Id: {0}
Number: {1}
QueuedBy: {2}",
BuildSystem.TFBuild.Environment.Build.Id,
BuildSystem.TFBuild.Environment.Build.Number,
BuildSystem.TFBuild.Environment.Build.QueuedBy
);
}
else
{
Information("Not running on TFBuild");
}
</code>
</example>
<para>Via TFBuild.</para>
<example>
<code>
if (TFBuild.IsRunningOnTFBuild)
{
Information(
@"Build:
Id: {0}
Number: {1}
QueuedBy: {2}",
TFBuild.Environment.Build.Id,
TFBuild.Environment.Build.Number,
TFBuild.Environment.Build.QueuedBy
);
}
else
{
Information("Not running on TFBuild");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildEnvironmentInfo.PullRequest">
<summary>
Gets TF Build pull request information.
</summary>
<value>
The TF Build pull request information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TFBuild.IsRunningOnTFBuild)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Id: {1}
Number: {2}",
BuildSystem.TFBuild.Environment.PullRequest.IsPullRequest,
BuildSystem.TFBuild.Environment.PullRequest.Id,
BuildSystem.TFBuild.Environment.PullRequest.Number
);
}
else
{
Information("Not running on TFBuild");
}
</code>
</example>
<para>Via TFBuild.</para>
<example>
<code>
if (TFBuild.IsRunningOnTFBuild)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Id: {1}
Number: {2}",
TFBuild.Environment.PullRequest.IsPullRequest,
TFBuild.Environment.PullRequest.Id,
TFBuild.Environment.PullRequest.Number
);
}
else
{
Information("Not running on TFBuild");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildEnvironmentInfo.TeamProject">
<summary>
Gets TF Team Project information.
</summary>
<value>
The TF Team Project.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TFBuild.IsRunningOnTFBuild)
{
Information(
@"TeamProject:
Id: {0}
Name: {1}",
BuildSystem.TFBuild.Environment.TeamProject.Id,
BuildSystem.TFBuild.Environment.TeamProject.Name
);
}
else
{
Information("Not running on TFBuild");
}
</code>
</example>
<para>Via TFBuild.</para>
<example>
<code>
if (TFBuild.IsRunningOnTFBuild)
{
Information(
@"TeamProject:
Id: {0}
Name: {1}",
TFBuild.Environment.TeamProject.Id,
TFBuild.Environment.TeamProject.Name
);
}
else
{
Information("Not running on TFBuild");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildEnvironmentInfo.Agent">
<summary>
Gets TF Build agent information.
</summary>
<value>
The TF Build agent.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TFBuild.IsRunningOnTFBuild)
{
Information(
@"Agent:
Id: {0}
Name: {1}",
BuildSystem.TFBuild.Environment.Agent.Id,
BuildSystem.TFBuild.Environment.Agent.Name
);
}
else
{
Information("Not running on TFBuild");
}
</code>
</example>
<para>Via TFBuild.</para>
<example>
<code>
if (TFBuild.IsRunningOnTFBuild)
{
Information(
@"Agent:
Id: {0}
Name: {1}",
TFBuild.Environment.Agent.Id,
TFBuild.Environment.Agent.Name
);
}
else
{
Information("Not running on TFBuild");
}
</code>
</example>
</member>
<member name="T:Cake.Common.Build.TFBuild.Data.TFBuildInfo">
<summary>
Provides TF Build info for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.TFBuild.Data.TFBuildInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TFBuild.Data.TFBuildInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildInfo.AccessToken">
<summary>
Gets the a special variable that carries the security token used by the running build.
</summary>
<value>
The security token.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildInfo.Debug">
<summary>
Gets a value indicating whether more detailed logs to debug pipeline problems is enabled.
</summary>
<value>
True if more detailed logs are enabled.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildInfo.ArtifactStagingDirectory">
<summary>
Gets the local path on the agent where any artifacts are copied to before being pushed to their destination.
</summary>
<value>
The path of the staging directory.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildInfo.BinariesDirectory">
<summary>
Gets the local path on the agent you can use as an output folder for compiled binaries.
</summary>
<value>
The path to the binaries directory.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildInfo.Id">
<summary>
Gets the ID of the record for the completed build.
</summary>
<value>
The ID of the record for the completed build.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildInfo.Number">
<summary>
Gets the name of the completed build.
</summary>
<remarks>You can specify the build number format that generates this value in the build definition.</remarks>
<value>
The name of the completed build.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildInfo.Uri">
<summary>
Gets the URI for the build.
</summary>
<example><c>vstfs:///Build/Build/1430</c>.</example>
<value>
The URI for the build.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildInfo.QueuedBy">
<summary>
Gets the user who queued the build.
</summary>
<value>
The user who queued the build.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildInfo.Reason">
<summary>
Gets the event that caused the build to run.
</summary>
<value>
The event name.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildInfo.RequestedFor">
<summary>
Gets the user the build was requested for.
</summary>
<value>
The user the build was requested for.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildInfo.RequestedForEmail">
<summary>
Gets the email of the user the build was requested for.
</summary>
<value>
The email of the user the build was requested for.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildInfo.SourcesDirectory">
<summary>
Gets the local path on the agent where your source code files are downloaded.
</summary>
<value>
The source code directory.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildInfo.StagingDirectory">
<summary>
Gets the local path on the agent where any artifacts are copied to before being pushed to their destination.
</summary>
<value>
The staging directory.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildInfo.TestResultsDirectory">
<summary>
Gets local path on the agent where the test results are created.
</summary>
<value>
The test result directory.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildInfo.TriggeredBy">
<summary>
Gets TF Build TriggeredBy information.
</summary>
<remarks>
This is only populated if the build was triggered by another build.
</remarks>
<value>
The TF Build Trigger information.
</value>
</member>
<member name="T:Cake.Common.Build.TFBuild.Data.TFBuildMessageData">
<summary>
Provides optional data associated with a TF Build logging message.
</summary>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildMessageData.SourcePath">
<summary>
Gets or sets the source file path the message should originate from.
</summary>
<value>
The path of the originating file.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildMessageData.LineNumber">
<summary>
Gets or sets the line number the message relates to.
</summary>
<value>
The line number.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildMessageData.ColumnNumber">
<summary>
Gets or sets the column number the message relates to.
</summary>
<value>
The column number.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildMessageData.ErrorCode">
<summary>
Gets or sets the error code of the warning or error message.
</summary>
<value>
The error code of the warning or error.
</value>
</member>
<member name="T:Cake.Common.Build.TFBuild.Data.TFBuildPublishCodeCoverageData">
<summary>
Providers TF Build agent for publishing code coverage results.
</summary>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildPublishCodeCoverageData.CodeCoverageTool">
<summary>
Gets or Sets the tool from which code coverage results are generated.
</summary>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildPublishCodeCoverageData.SummaryFileLocation">
<summary>
Gets or Sets the path of the summary file containing code coverage statistics, such as line, method, and class coverage.
</summary>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildPublishCodeCoverageData.ReportDirectory">
<summary>
Gets or Sets the Path of the code coverage HTML report directory. The report directory is published for later viewing as an artifact of the build.
</summary>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildPublishCodeCoverageData.AdditionalCodeCoverageFiles">
<summary>
Gets or Sets the file paths for any additional code coverage files to be published as artifacts of the build.
</summary>
</member>
<member name="T:Cake.Common.Build.TFBuild.Data.TFBuildPublishTestResultsData">
<summary>
Provides TF Build agent info for publishing test results.
</summary>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildPublishTestResultsData.TestRunner">
<summary>
Gets or Sets the type test runner the results are formatted in.
</summary>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildPublishTestResultsData.TestResultsFiles">
<summary>
Gets or sets the list of Test Result files to publish.
</summary>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildPublishTestResultsData.MergeTestResults">
<summary>
Gets or Sets whether to merge all Test Result Files into one run.
</summary>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildPublishTestResultsData.Platform">
<summary>
Gets or Sets the Platform for which the tests were run on.
</summary>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildPublishTestResultsData.Configuration">
<summary>
Gets or Sets the configuration for which the tests were run on.
</summary>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildPublishTestResultsData.TestRunTitle">
<summary>
Gets or Sets a name for the Test Run.
</summary>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildPublishTestResultsData.PublishRunAttachments">
<summary>
Gets or Sets whether to opt in/out of publishing test run level attachments.
</summary>
</member>
<member name="T:Cake.Common.Build.TFBuild.Data.TFBuildPullRequestInfo">
<summary>
Provides TF Build pull request information for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.TFBuild.Data.TFBuildPullRequestInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TFBuild.Data.TFBuildPullRequestInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildPullRequestInfo.IsFork">
<summary>
Gets a value indicating whether the pull request is from a fork of the repository.
</summary>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildPullRequestInfo.IsPullRequest">
<summary>
Gets a value indicating whether the current build was started by a pull request.
</summary>
<value>
<c>true</c> if the current build was started by a pull request; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildPullRequestInfo.Id">
<summary>
Gets the ID of the pull request that caused this build.
This value is set only if the build ran because of a Git PR affected by a branch policy.
</summary>
<value>
The ID of the pull request that caused this build.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildPullRequestInfo.Number">
<summary>
Gets the number of the pull request that caused this build.
This value is set for pull requests from GitHub which have a different pull request ID and pull request number.
</summary>
<value>
The number of the pull request that caused this build.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildPullRequestInfo.SourceBranch">
<summary>
Gets the branch that is being reviewed in a pull request.
</summary>
<remarks>
This property is populated only if the build ran because of a Git PR affected by a branch policy.
</remarks>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildPullRequestInfo.SourceRepositoryUri">
<summary>
Gets the URL to the repo that contains the pull requests.
</summary>
<remarks>
This property is populated only if the build ran because of a Git PR affected by a branch policy. It is not initialized for GitHub PRs.
</remarks>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildPullRequestInfo.TargetBranch">
<summary>
Gets the branch that is the target of a pull request.
</summary>
<remarks>
This property is populated only if the build ran because of a Git PR affected by a branch policy.
</remarks>
</member>
<member name="T:Cake.Common.Build.TFBuild.Data.TFBuildRecordData">
<summary>
Provides optional data associated with a TF Build timeline record.
</summary>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildRecordData.ParentRecord">
<summary>
Gets or sets the parent record of a new or existing timeline record.
</summary>
<value>
The ID of the parent record.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildRecordData.StartTime">
<summary>
Gets or sets the start time of this record.
</summary>
<value>
The start time of this record.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildRecordData.FinishTime">
<summary>
Gets or sets the finish time of this record.
</summary>
<value>
The finish time of this record.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildRecordData.Progress">
<summary>
Gets or sets the current progress of this record.
</summary>
<value>
The current progress of this record.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildRecordData.Status">
<summary>
Gets or sets the current status of this record.
</summary>
<value>
The current status of this record.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildRecordData.Result">
<summary>
Gets or sets the result of this record.
</summary>
<value>
The result of this record.
</value>
</member>
<member name="T:Cake.Common.Build.TFBuild.Data.TFBuildRepositoryInfo">
<summary>
Provides TF Build Repository information for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.TFBuild.Data.TFBuildRepositoryInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TFBuild.Data.TFBuildRepositoryInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildRepositoryInfo.SourceBranch">
<summary>
Gets the branch the build was queued for.
</summary>
<value>
The full SCM branch.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildRepositoryInfo.SourceBranchName">
<summary>
Gets name of the branch the build was queued for.
</summary>
<value>
The SCM branch name.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildRepositoryInfo.SourceVersion">
<summary>
Gets the latest version control change that is included in this build.
</summary>
<remarks>Note: for Git this is the commit ID. For TFVC this is the changeset.</remarks>
<value>
The SCM source version.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildRepositoryInfo.SourceVersionMessage">
<summary>
Gets the comment of the commit or changeset.
</summary>
<remarks>Note: This variable is available in TFS 2015.4.</remarks>
<value>
The comment.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildRepositoryInfo.Shelveset">
<summary>
Gets the name of the shelveset you are building, if you are running a gated build or a shelveset build.
</summary>
<remarks>Defined only if your repository is Team Foundation Version Control.</remarks>
<value>
The shelveset name.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildRepositoryInfo.RepoName">
<summary>
Gets the name of the repository.
</summary>
<value>
The name of the repository.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildRepositoryInfo.Provider">
<summary>
Gets the type of the current repository.
</summary>
<value>
The type of the current repository.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildRepositoryInfo.GitSubmoduleCheckout">
<summary>
Gets the value you've selected for Checkout submodules on the repository tab.
</summary>
<value>
The checkout submodule value.
</value>
</member>
<member name="T:Cake.Common.Build.TFBuild.Data.TFBuildTaskResult">
<summary>
Provides the result of a TF Build task record.
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFBuildTaskResult.Succeeded">
<summary>
Succeeded status.
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFBuildTaskResult.SucceededWithIssues">
<summary>
Succeeded with issues status.
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFBuildTaskResult.Failed">
<summary>
Failed status.
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFBuildTaskResult.Cancelled">
<summary>
Cancelled status.
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFBuildTaskResult.Skipped">
<summary>
Skipped status.
</summary>
</member>
<member name="T:Cake.Common.Build.TFBuild.Data.TFBuildTaskStatus">
<summary>
Provides the status of a TF Build task record.
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFBuildTaskStatus.Unknown">
<summary>
Unknown status.
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFBuildTaskStatus.Initialized">
<summary>
Initialized status.
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFBuildTaskStatus.InProgress">
<summary>
In progress status.
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFBuildTaskStatus.Completed">
<summary>
Completed status.
</summary>
</member>
<member name="T:Cake.Common.Build.TFBuild.Data.TFBuildTeamProjectInfo">
<summary>
Provides Team Foundation Team Project information for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.TFBuild.Data.TFBuildTeamProjectInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TFBuild.Data.TFBuildTeamProjectInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildTeamProjectInfo.Name">
<summary>
Gets the name of the team project that contains this build.
</summary>
<value>
The name of the team project that contains this build.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildTeamProjectInfo.Id">
<summary>
Gets the ID of the team project that contains this build.
</summary>
<value>
The ID of the team project that contains this build.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildTeamProjectInfo.CollectionUri">
<summary>
Gets the URI of the team foundation collection.
</summary>
<value>
The URI of the team foundation collection.
</value>
</member>
<member name="T:Cake.Common.Build.TFBuild.Data.TFBuildTriggeredBy">
<summary>
Provides TF Build Trigger information for the current build.
</summary>
<remarks>
Only populated if the build was triggered by another build.
</remarks>
</member>
<member name="M:Cake.Common.Build.TFBuild.Data.TFBuildTriggeredBy.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TFBuild.Data.TFBuildTriggeredBy"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildTriggeredBy.BuildId">
<summary>
Gets the BuildID of the triggering build.
</summary>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildTriggeredBy.DefinitionId">
<summary>
Gets the DefinitionID of the triggering build.
</summary>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildTriggeredBy.DefinitionName">
<summary>
Gets the name of the triggering build pipeline.
</summary>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildTriggeredBy.BuildNumber">
<summary>
Gets the number of the triggering build.
</summary>
</member>
<member name="P:Cake.Common.Build.TFBuild.Data.TFBuildTriggeredBy.ProjectId">
<summary>
Gets the ID of the project that contains the triggering build.
</summary>
</member>
<member name="T:Cake.Common.Build.TFBuild.Data.TFCodeCoverageToolType">
<summary>
Provides the known values for the Code Coverage tool formats.
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFCodeCoverageToolType.JaCoCo">
<summary>
JaCoCo code coverage format
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFCodeCoverageToolType.Cobertura">
<summary>
Cobertura code coverage format
</summary>
</member>
<member name="T:Cake.Common.Build.TFBuild.Data.TFRepositoryType">
<summary>
Provides the known values for the TF Build Repository types.
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFRepositoryType.TfsGit">
<summary>
TFS Git repository.
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFRepositoryType.TfsVersionControl">
<summary>
Team Foundation Version Control repository.
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFRepositoryType.Git">
<summary>
Git repository hosted on an external server.
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFRepositoryType.GitHub">
<summary>
GitHub repository.
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFRepositoryType.Svn">
<summary>
Subversion repository.
</summary>
</member>
<member name="T:Cake.Common.Build.TFBuild.Data.TFTestRunnerType">
<summary>
Providers known values for the TF Test Runner types.
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFTestRunnerType.JUnit">
<summary>
JUnit Test Result Format
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFTestRunnerType.NUnit">
<summary>
NUnit (v2) Test Result Format
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFTestRunnerType.VSTest">
<summary>
Visual Studio (MSTest) Test Result Format
</summary>
</member>
<member name="F:Cake.Common.Build.TFBuild.Data.TFTestRunnerType.XUnit">
<summary>
XUnit Test Result Format
</summary>
</member>
<member name="T:Cake.Common.Build.TFBuild.ITFBuildCommands">
<summary>
Represents a TF Build command provider.
</summary>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.WriteWarning(System.String)">
<summary>
Log a warning issue to timeline record of current task.
</summary>
<param name="message">The warning message.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.WriteWarning(System.String,Cake.Common.Build.TFBuild.Data.TFBuildMessageData)">
<summary>
Log a warning issue with detailed data to timeline record of current task.
</summary>
<param name="message">The warning message.</param>
<param name="data">The message data.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.WriteError(System.String)">
<summary>
Log an error to timeline record of current task.
</summary>
<param name="message">The error message.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.WriteError(System.String,Cake.Common.Build.TFBuild.Data.TFBuildMessageData)">
<summary>
Log an error with detailed data to timeline record of current task.
</summary>
<param name="message">The error message.</param>
<param name="data">The message data.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.SetProgress(System.Int32,System.String)">
<summary>
Set progress and current operation for current task.
</summary>
<param name="progress">Current progress as percentage.</param>
<param name="currentOperation">The current operation.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.CompleteCurrentTask">
<summary>
Finish timeline record for current task and set task result to succeeded.
</summary>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.CompleteCurrentTask(Cake.Common.Build.TFBuild.Data.TFBuildTaskResult)">
<summary>
Finish timeline record for current task and set task result.
</summary>
<param name="result">The task result status.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.CreateNewRecord(System.String,System.String,System.Int32)">
<summary>
Create detail timeline record.
</summary>
<param name="name">Name of the new timeline record.</param>
<param name="type">Type of the new timeline record.</param>
<param name="order">Order of the timeline record.</param>
<returns>The timeline record ID.</returns>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.CreateNewRecord(System.String,System.String,System.Int32,Cake.Common.Build.TFBuild.Data.TFBuildRecordData)">
<summary>
Create detail timeline record.
</summary>
<param name="name">Name of the new timeline record.</param>
<param name="type">Type of the new timeline record.</param>
<param name="order">Order of the timeline record.</param>
<param name="data">Additional data for the new timeline record.</param>
<returns>The timeline record ID.</returns>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.UpdateRecord(System.Guid,Cake.Common.Build.TFBuild.Data.TFBuildRecordData)">
<summary>
Update an existing detail timeline record.
</summary>
<param name="id">The ID of the existing timeline record.</param>
<param name="data">Additional data for the timeline record.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.SetVariable(System.String,System.String)">
<summary>
Sets a variable in the variable service of the task context.
</summary>
<remarks>
The variable is exposed to following tasks as an environment variable.
</remarks>
<param name="name">The variable name.</param>
<param name="value">The variable value.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.SetSecretVariable(System.String,System.String)">
<summary>
Sets a secret variable in the variable service of the task context.
</summary>
<remarks>
The variable is not exposed to following tasks as an environment variable, and must be passed as inputs.
</remarks>
<param name="name">The variable name.</param>
<param name="value">The variable value.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.UploadTaskSummary(Cake.Core.IO.FilePath)">
<summary>
Upload and attach summary markdown to current timeline record.
</summary>
<remarks>
This summary is added to the build/release summary and is not available for download with logs.
</remarks>
<param name="markdownPath">Path to the summary markdown file.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.UploadTaskLogFile(Cake.Core.IO.FilePath)">
<summary>
Upload file as additional log information to the current timeline record.
</summary>
<remarks>
<para>
The file shall be available for download along with task logs.
</para>
<para>
Requires agent version 1.101.
</para>
</remarks>
<param name="logFile">Path to the additional log file.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.LinkArtifact(System.String,Cake.Common.Build.TFBuild.Data.TFBuildArtifactType,System.String)">
<summary>
Create an artifact link, such as a file or folder path or a version control path.
</summary>
<param name="name">The artifact name.</param>
<param name="type">The artifact type.</param>
<param name="location">The link path or value.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.UploadArtifact(System.String,Cake.Core.IO.FilePath)">
<summary>
Upload local file into a file container folder.
</summary>
<param name="folderName">Folder that the file will upload to.</param>
<param name="file">Path to the local file.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.UploadArtifact(System.String,Cake.Core.IO.FilePath,System.String)">
<summary>
Upload local file into a file container folder, and create an artifact.
</summary>
<param name="folderName">Folder that the file will upload to.</param>
<param name="file">Path to the local file.</param>
<param name="artifactName">The artifact name.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.UploadArtifactDirectory(Cake.Core.IO.DirectoryPath)">
<summary>
Upload local directory as a container folder, and create an artifact.
</summary>
<param name="directory">Path to the local directory.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.UploadArtifactDirectory(Cake.Core.IO.DirectoryPath,System.String)">
<summary>
Upload local directory as a container folder, and create an artifact with the specified name.
</summary>
<param name="directory">Path to the local directory.</param>
<param name="artifactName">The artifact name.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.UploadBuildLogFile(Cake.Core.IO.FilePath)">
<summary>
Upload additional log to build container's <c>logs/tool</c> folder.
</summary>
<param name="logFile">The log file.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.UpdateBuildNumber(System.String)">
<summary>
Update build number for current build.
</summary>
<remarks>
Requires agent version 1.88.
</remarks>
<param name="buildNumber">The build number.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.AddBuildTag(System.String)">
<summary>
Add a tag for current build.
</summary>
<remarks>
Requires agent version 1.95.
</remarks>
<param name="tag">The tag.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.PublishTestResults(Cake.Common.Build.TFBuild.Data.TFBuildPublishTestResultsData)">
<summary>
Publishes and uploads tests results.
</summary>
<param name="data">The publish test results data.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.PublishCodeCoverage(Cake.Common.Build.TFBuild.Data.TFBuildPublishCodeCoverageData)">
<summary>
Publishes and uploads code coverage results.
</summary>
<param name="data">The code coverage data.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.PublishCodeCoverage(Cake.Core.IO.FilePath,Cake.Common.Build.TFBuild.Data.TFBuildPublishCodeCoverageData)">
<summary>
Publishes and uploads code coverage results.
</summary>
<param name="summaryFilePath">The code coverage summary file path.</param>
<param name="data">The code coverage data.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.ITFBuildCommands.PublishCodeCoverage(Cake.Core.IO.FilePath,System.Action{Cake.Common.Build.TFBuild.Data.TFBuildPublishCodeCoverageData})">
<summary>
Publishes and uploads code coverage results.
</summary>
<param name="summaryFilePath">The code coverage summary file path.</param>
<param name="action">The configuration action for the code coverage data.</param>
</member>
<member name="T:Cake.Common.Build.TFBuild.ITFBuildProvider">
<summary>
Represents a TF Build provider.
</summary>
</member>
<member name="P:Cake.Common.Build.TFBuild.ITFBuildProvider.IsRunningOnAzurePipelines">
<summary>
Gets a value indicating whether the current build is running on Azure Pipelines.
</summary>
<value>
<c>true</c> if the current build is running on Azure Pipelines; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.ITFBuildProvider.IsRunningOnAzurePipelinesHosted">
<summary>
Gets a value indicating whether the current build is running on hosted Azure Pipelines.
</summary>
<value>
<c>true</c> if the current build is running on hosted Azure Pipelines; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.ITFBuildProvider.Environment">
<summary>
Gets the TF Build environment.
</summary>
<value>
The TF Build environment.
</value>
</member>
<member name="P:Cake.Common.Build.TFBuild.ITFBuildProvider.Commands">
<summary>
Gets the TF Build Commands provider.
</summary>
<value>
The TF Build commands provider.
</value>
</member>
<member name="T:Cake.Common.Build.TFBuild.TFBuildCommands">
<summary>
Responsible for issuing TF Build agent commands (see <see href="https://github.com/Microsoft/vsts-tasks/blob/master/docs/authoring/commands.md"/>).
</summary>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.#ctor(Cake.Core.ICakeEnvironment,Cake.Common.Build.IBuildSystemServiceMessageWriter)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TFBuild.TFBuildCommands"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="writer">The build system service message writer.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.WriteWarning(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.WriteWarning(System.String,Cake.Common.Build.TFBuild.Data.TFBuildMessageData)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.WriteError(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.WriteError(System.String,Cake.Common.Build.TFBuild.Data.TFBuildMessageData)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.SetProgress(System.Int32,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.CompleteCurrentTask">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.CompleteCurrentTask(Cake.Common.Build.TFBuild.Data.TFBuildTaskResult)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.CreateNewRecord(System.String,System.String,System.Int32)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.CreateNewRecord(System.String,System.String,System.Int32,Cake.Common.Build.TFBuild.Data.TFBuildRecordData)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.UpdateRecord(System.Guid,Cake.Common.Build.TFBuild.Data.TFBuildRecordData)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.SetVariable(System.String,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.SetSecretVariable(System.String,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.UploadTaskSummary(Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.UploadTaskLogFile(Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.LinkArtifact(System.String,Cake.Common.Build.TFBuild.Data.TFBuildArtifactType,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.UploadArtifact(System.String,Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.UploadArtifact(System.String,Cake.Core.IO.FilePath,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.UploadArtifactDirectory(Cake.Core.IO.DirectoryPath)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.UploadArtifactDirectory(Cake.Core.IO.DirectoryPath,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.UploadBuildLogFile(Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.UpdateBuildNumber(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.AddBuildTag(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.PublishTestResults(Cake.Common.Build.TFBuild.Data.TFBuildPublishTestResultsData)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.PublishCodeCoverage(Cake.Common.Build.TFBuild.Data.TFBuildPublishCodeCoverageData)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.PublishCodeCoverage(Cake.Core.IO.FilePath,Cake.Common.Build.TFBuild.Data.TFBuildPublishCodeCoverageData)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildCommands.PublishCodeCoverage(Cake.Core.IO.FilePath,System.Action{Cake.Common.Build.TFBuild.Data.TFBuildPublishCodeCoverageData})">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.TFBuild.TFBuildProvider">
<summary>
Responsible for communicating with Team Foundation Build (VSTS or TFS).
</summary>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFBuildProvider.#ctor(Cake.Core.ICakeEnvironment,Cake.Common.Build.IBuildSystemServiceMessageWriter)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TFBuild.TFBuildProvider"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="writer">The build system service message writer.</param>
</member>
<member name="P:Cake.Common.Build.TFBuild.TFBuildProvider.IsRunningOnAzurePipelines">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.TFBuild.TFBuildProvider.IsRunningOnAzurePipelinesHosted">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.TFBuild.TFBuildProvider.Environment">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.TFBuild.TFBuildProvider.Commands">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.TFBuild.TFInfo">
<summary>
Base class used to provide information about the TF Build environment.
</summary>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TFBuild.TFInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFInfo.GetEnvironmentUri(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Uri"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.TFBuild.TFInfo.GetRepositoryType(System.String)">
<summary>
Gets the current repository type as a <see cref="T:Cake.Common.Build.TFBuild.Data.TFRepositoryType"/> from an environment variable.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The current repository type.</returns>
</member>
<member name="T:Cake.Common.Build.TravisCI.Data.TravisCIBuildInfo">
<summary>
Provides Travis CI build information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIBuildInfo.Branch">
<summary>
Gets the branch for the current build.
</summary>
<value>
The branch.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIBuildInfo.BuildDirectory">
<summary>
Gets the build directory for the current build.
</summary>
<value>
The build directory.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIBuildInfo.BuildId">
<summary>
Gets the build identifier for the current build.
</summary>
<value>
The build identifier.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIBuildInfo.BuildNumber">
<summary>
Gets the build number for the current build.
</summary>
<value>
The build number.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIBuildInfo.TestResult">
<summary>
Gets the test result indicating if the current build is successful or broken.
</summary>
<value>
The test result.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIBuildInfo.Tag">
<summary>
Gets the tag name for the current build.
</summary>
<value>
The tag.
</value>
</member>
<member name="M:Cake.Common.Build.TravisCI.Data.TravisCIBuildInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TravisCI.Data.TravisCIBuildInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.TravisCI.Data.TravisCIEnvironmentInfo">
<summary>
Provides Travis CI environment information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIEnvironmentInfo.Build">
<summary>
Gets Travis CI build information for the current build.
</summary>
<value>
The build.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TravisCI.IsRunningOnTravisCI)
{
Information(
@"Build:
Branch: {0}
BuildDirectory: {1}
BuildId: {2}",
BuildSystem.TravisCI.Environment.Build.Branch,
BuildSystem.TravisCI.Environment.Build.BuildDirectory,
BuildSystem.TravisCI.Environment.Build.BuildId
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
<para>Via TravisCI.</para>
<example>
<code>
if (TravisCI.IsRunningOnTravisCI)
{
Information(
@"Build:
Branch: {0}
BuildDirectory: {1}
BuildId: {2}",
TravisCI.Environment.Build.Branch,
TravisCI.Environment.Build.BuildDirectory,
TravisCI.Environment.Build.BuildId
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIEnvironmentInfo.PullRequest">
<summary>
Gets Travis CI pull request information.
</summary>
<value>
The Travis CI pull request information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TravisCI.IsRunningOnTravisCI)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Id: {1}",
BuildSystem.TravisCI.Environment.PullRequest.IsPullRequest,
BuildSystem.TravisCI.Environment.PullRequest.Id
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
<para>Via TravisCI.</para>
<example>
<code>
if (TravisCI.IsRunningOnTravisCI)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Id: {1}",
TravisCI.Environment.PullRequest.IsPullRequest,
TravisCI.Environment.PullRequest.Id
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIEnvironmentInfo.Job">
<summary>
Gets Travis CI job information for the current build.
</summary>
<value>
The job.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TravisCI.IsRunningOnTravisCI)
{
Information(
@"Job:
JobId: {0}
JobNumber: {1}
OSName: {2}",
BuildSystem.TravisCI.Environment.Job.JobId,
BuildSystem.TravisCI.Environment.Job.JobNumber,
BuildSystem.TravisCI.Environment.Job.OSName
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
<para>Via TravisCI.</para>
<example>
<code>
if (TravisCI.IsRunningOnTravisCI)
{
Information(
@"Job:
JobId: {0}
JobNumber: {1}
OSName: {2}",
TravisCI.Environment.Job.JobId,
TravisCI.Environment.Job.JobNumber,
TravisCI.Environment.Job.OSName
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIEnvironmentInfo.Repository">
<summary>
Gets Travis CI repository information for the current build.
</summary>
<value>
The repository.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TravisCI.IsRunningOnTravisCI)
{
Information(
@"Repository:
Commit: {0}
CommitRange: {1}
PullRequest: {2}",
BuildSystem.TravisCI.Environment.Repository.Commit,
BuildSystem.TravisCI.Environment.Repository.CommitRange,
BuildSystem.TravisCI.Environment.Repository.PullRequest
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
<para>Via TravisCI.</para>
<example>
<code>
if (TravisCI.IsRunningOnTravisCI)
{
Information(
@"Repository:
Commit: {0}
CommitRange: {1}
PullRequest: {2}",
TravisCI.Environment.Repository.Commit,
TravisCI.Environment.Repository.CommitRange,
TravisCI.Environment.Repository.PullRequest
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIEnvironmentInfo.CI">
<summary>
Gets a value indicating whether the current build is continuous integration.
</summary>
<value>
<c>true</c> if ci; otherwise, <c>false</c>.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TravisCI.IsRunningOnTravisCI)
{
Information(
@"CI: {0}",
BuildSystem.TravisCI.Environment.CI
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
<para>Via TravisCI.</para>
<example>
<code>
if (TravisCI.IsRunningOnTravisCI)
{
Information(
@"CI: {0}",
TravisCI.Environment.CI
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIEnvironmentInfo.Home">
<summary>
Gets the Travis CI home directory.
</summary>
<value>
The home.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TravisCI.IsRunningOnTravisCI)
{
Information(
@"Home: {0}",
BuildSystem.TravisCI.Environment.Home
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
<para>Via TravisCI.</para>
<example>
<code>
if (TravisCI.IsRunningOnTravisCI)
{
Information(
@"Home: {0}",
TravisCI.Environment.Home
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIEnvironmentInfo.Travis">
<summary>
Gets a value indicating whether the environment is Travis.
</summary>
<value>
<c>true</c> if Travis; otherwise, <c>false</c>.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TravisCI.IsRunningOnTravisCI)
{
Information(
@"Travis: {0}",
BuildSystem.TravisCI.Environment.Travis
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
<para>Via TravisCI.</para>
<example>
<code>
if (TravisCI.IsRunningOnTravisCI)
{
Information(
@"Travis: {0}",
TravisCI.Environment.Travis
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.TravisCI.Data.TravisCIEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TravisCI.Data.TravisCIEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.TravisCI.Data.TravisCIJobInfo">
<summary>
Provides Travis CI job information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIJobInfo.JobId">
<summary>
Gets the job identifier for the current job.
</summary>
<value>
The job identifier.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIJobInfo.JobNumber">
<summary>
Gets the job number for the current job.
</summary>
<value>
The job number.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIJobInfo.OSName">
<summary>
Gets the name of the operating system for the current job.
</summary>
<value>
The name of the os.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIJobInfo.SecureEnvironmentVariables">
<summary>
Gets a value indicating whether encrypted environment variables are being used for the current job.
</summary>
<value>
<c>true</c> if [secure environment variables are in use]; otherwise, <c>false</c>.
</value>
</member>
<member name="M:Cake.Common.Build.TravisCI.Data.TravisCIJobInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TravisCI.Data.TravisCIJobInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.TravisCI.Data.TravisCIPullRequestInfo">
<summary>
Provides TravisCI pull request information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.TravisCI.Data.TravisCIPullRequestInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TravisCI.Data.TravisCIPullRequestInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIPullRequestInfo.IsPullRequest">
<summary>
Gets a value indicating whether the current build was started by a pull request.
</summary>
<value>
<c>true</c> if the current build was started by a pull request; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIPullRequestInfo.Id">
<summary>
Gets the pull request id.
</summary>
<value>
The pull request id.
</value>
</member>
<member name="T:Cake.Common.Build.TravisCI.Data.TravisCIRepositoryInfo">
<summary>
Provides Travis CI repository information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIRepositoryInfo.Commit">
<summary>
Gets the commit that the current build is testing.
</summary>
<value>
The commit.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIRepositoryInfo.CommitRange">
<summary>
Gets the commit range for the current pull request.
</summary>
<value>
The commit range.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIRepositoryInfo.PullRequest">
<summary>
Gets the pull request.
</summary>
<value>
The pull request.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIRepositoryInfo.Slug">
<summary>
Gets the slug of the repository currently being built.
</summary>
<value>
The slug.
</value>
</member>
<member name="M:Cake.Common.Build.TravisCI.Data.TravisCIRepositoryInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TravisCI.Data.TravisCIRepositoryInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.TravisCI.ITravisCIProvider">
<summary>
Represents a Travis CI Provider.
</summary>
</member>
<member name="P:Cake.Common.Build.TravisCI.ITravisCIProvider.IsRunningOnTravisCI">
<summary>
Gets a value indicating whether this instance is running on Travis CI.
</summary>
<value>
<c>true</c> if this instance is running on Travis CI; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.ITravisCIProvider.Environment">
<summary>
Gets the environment.
</summary>
<value>
The environment.
</value>
</member>
<member name="M:Cake.Common.Build.TravisCI.ITravisCIProvider.WriteStartFold(System.String)">
<summary>
Write the start of a message fold to the Travis CI build log.
</summary>
<param name="name">Name of the group.</param>
</member>
<member name="M:Cake.Common.Build.TravisCI.ITravisCIProvider.WriteEndFold(System.String)">
<summary>
Write the start of a message fold to the Travis CI build log.
</summary>
<param name="name">Name of the group.</param>
</member>
<member name="T:Cake.Common.Build.TravisCI.TravisCIDisposableExtensions">
<summary>
A set of extensions for allowing "using" with Travis CI "blocks".
</summary>
</member>
<member name="M:Cake.Common.Build.TravisCI.TravisCIDisposableExtensions.Fold(Cake.Common.Build.TravisCI.ITravisCIProvider,System.String)">
<summary>
Folds travis log output.
</summary>
<param name="travisCIProvider">The Travis CI provider.</param>
<param name="name">The name.</param>
<returns>An <see cref="T:System.IDisposable"/>.</returns>
</member>
<member name="T:Cake.Common.Build.TravisCI.TravisCIDisposableExtensions.TravisCIActionDisposable">
<summary>
Disposable helper for writing Travis CI message blocks.
</summary>
</member>
<member name="M:Cake.Common.Build.TravisCI.TravisCIDisposableExtensions.TravisCIActionDisposable.#ctor(Cake.Common.Build.TravisCI.ITravisCIProvider,System.Action{Cake.Common.Build.TravisCI.ITravisCIProvider})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TravisCI.TravisCIDisposableExtensions.TravisCIActionDisposable"/> class.
</summary>
<param name="travisCiProvider">The Travis CI provider.</param>
<param name="disposeAction">The dispose action.</param>
</member>
<member name="M:Cake.Common.Build.TravisCI.TravisCIDisposableExtensions.TravisCIActionDisposable.Dispose">
<summary>
Writes the end block for this message block.
</summary>
</member>
<member name="T:Cake.Common.Build.TravisCI.TravisCIInfo">
<summary>
Base class used to provide information about the Travis CI environment.
</summary>
</member>
<member name="M:Cake.Common.Build.TravisCI.TravisCIInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TravisCI.TravisCIInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.TravisCI.TravisCIInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.TravisCI.TravisCIInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.TravisCI.TravisCIInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="T:Cake.Common.Build.TravisCI.TravisCIProvider">
<summary>
Responsible for communicating with Travis CI.
</summary>
</member>
<member name="M:Cake.Common.Build.TravisCI.TravisCIProvider.#ctor(Cake.Core.ICakeEnvironment,Cake.Common.Build.IBuildSystemServiceMessageWriter)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TravisCI.TravisCIProvider"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="writer">The log.</param>
</member>
<member name="P:Cake.Common.Build.TravisCI.TravisCIProvider.IsRunningOnTravisCI">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.TravisCI.TravisCIProvider.Environment">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TravisCI.TravisCIProvider.WriteStartFold(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TravisCI.TravisCIProvider.WriteEndFold(System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.NamespaceDoc">
<summary>
This namespace contain types that
support different build system related tasks.
</summary>
</member>
<member name="T:Cake.Common.Diagnostics.LoggingAliases">
<summary>
Contains functionality related to logging.
</summary>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Error(Cake.Core.ICakeContext,System.String,System.Object[])">
<summary>
Writes an error message to the log using the specified format information.
</summary>
<param name="context">The context.</param>
<param name="format">The format.</param>
<param name="args">The arguments.</param>
<example>
<code>
Error("Hello {0}! Today is an {1:dddd}", "World", DateTime.Now);
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Error(Cake.Core.ICakeContext,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes an error message to the log using the specified log message action.
Evaluation message only if verbosity same or more verbose.
</summary>
<param name="context">the context.</param>
<param name="logAction">The function called for message when logging.</param>
<example>
<code>
Error(logAction=>logAction("Hello {0}! Today is an {1:dddd}", "World", DateTime.Now));
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Error(Cake.Core.ICakeContext,System.Object)">
<summary>
Writes an error message to the log using the specified value.
</summary>
<param name="context">the context.</param>
<param name="value">The value.</param>
<example>
<code>
Error(new {FirstName = "John", LastName="Doe"});
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Error(Cake.Core.ICakeContext,System.String)">
<summary>
Writes an error message to the log using the specified string value.
</summary>
<param name="context">the context.</param>
<param name="value">The value.</param>
<example>
<code>
Error("{string}");
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Warning(Cake.Core.ICakeContext,System.String,System.Object[])">
<summary>
Writes a warning message to the log using the specified format information.
</summary>
<param name="context">The context.</param>
<param name="format">The format.</param>
<param name="args">The arguments.</param>
<example>
<code>
Warning("Hello {0}! Today is an {1:dddd}", "World", DateTime.Now);
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Warning(Cake.Core.ICakeContext,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes a warning message to the log using the specified log message action.
Evaluation message only if verbosity same or more verbose.
</summary>
<param name="context">the context.</param>
<param name="logAction">The function called for message when logging.</param>
<example>
<code>
Warning(logAction=>logAction("Hello {0}! Today is an {1:dddd}", "World", DateTime.Now));
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Warning(Cake.Core.ICakeContext,System.Object)">
<summary>
Writes an warning message to the log using the specified value.
</summary>
<param name="context">the context.</param>
<param name="value">The value.</param>
<example>
<code>
Warning(new {FirstName = "John", LastName="Doe"});
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Warning(Cake.Core.ICakeContext,System.String)">
<summary>
Writes an warning message to the log using the specified string value.
</summary>
<param name="context">the context.</param>
<param name="value">The value.</param>
<example>
<code>
Warning("{string}");
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Information(Cake.Core.ICakeContext,System.String,System.Object[])">
<summary>
Writes an informational message to the log using the specified format information.
</summary>
<param name="context">The context.</param>
<param name="format">The format.</param>
<param name="args">The arguments.</param>
<example>
<code>
Information("Hello {0}! Today is an {1:dddd}", "World", DateTime.Now);
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Information(Cake.Core.ICakeContext,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes an informational message to the log using the specified log message action.
Evaluation message only if verbosity same or more verbose.
</summary>
<param name="context">the context.</param>
<param name="logAction">The function called for message when logging.</param>
<example>
<code>
Information(logAction=>logAction("Hello {0}! Today is an {1:dddd}", "World", DateTime.Now));
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Information(Cake.Core.ICakeContext,System.Object)">
<summary>
Writes an informational message to the log using the specified value.
</summary>
<param name="context">The context.</param>
<param name="value">The value.</param>
<example>
<code>
Information(new {FirstName = "John", LastName="Doe"});
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Information(Cake.Core.ICakeContext,System.String)">
<summary>
Writes an informational message to the log using the specified string value.
</summary>
<param name="context">The context.</param>
<param name="value">The value.</param>
<example>
<code>
Information("{string}");
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Verbose(Cake.Core.ICakeContext,System.String,System.Object[])">
<summary>
Writes a verbose message to the log using the specified format information.
</summary>
<param name="context">The context.</param>
<param name="format">The format.</param>
<param name="args">The arguments.</param>
<example>
<code>
Verbose("Hello {0}! Today is an {1:dddd}", "World", DateTime.Now);
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Verbose(Cake.Core.ICakeContext,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes a verbose message to the log using the specified log message action.
Evaluation message only if verbosity same or more verbose.
</summary>
<param name="context">the context.</param>
<param name="logAction">The function called for message when logging.</param>
<example>
<code>
Verbose(logAction=>logAction("Hello {0}! Today is an {1:dddd}", "World", DateTime.Now));
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Verbose(Cake.Core.ICakeContext,System.Object)">
<summary>
Writes a verbose message to the log using the specified value.
</summary>
<param name="context">The context.</param>
<param name="value">The value.</param>
<example>
<code>
Verbose(new {FirstName = "John", LastName="Doe"});
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Verbose(Cake.Core.ICakeContext,System.String)">
<summary>
Writes a verbose message to the log using the specified string value.
</summary>
<param name="context">The context.</param>
<param name="value">The value.</param>
<example>
<code>
Verbose("{string}");
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Debug(Cake.Core.ICakeContext,System.String,System.Object[])">
<summary>
Writes a debug message to the log using the specified format information.
</summary>
<param name="context">The context.</param>
<param name="format">The format.</param>
<param name="args">The arguments.</param>
<example>
<code>
Debug("Hello {0}! Today is an {1:dddd}", "World", DateTime.Now);
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Debug(Cake.Core.ICakeContext,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes a debug message to the log using the specified log message action.
Evaluation message only if verbosity same or more verbose.
</summary>
<param name="context">the context.</param>
<param name="logAction">The function called for message when logging.</param>
<example>
<code>
Debug(logAction=>logAction("Hello {0}! Today is an {1:dddd}", "World", DateTime.Now));
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Debug(Cake.Core.ICakeContext,System.Object)">
<summary>
Writes a debug message to the log using the specified value.
</summary>
<param name="context">the context.</param>
<param name="value">The value.</param>
<example>
<code>
Debug(new {FirstName = "John", LastName="Doe"});
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Debug(Cake.Core.ICakeContext,System.String)">
<summary>
Writes a debug message to the log using the specified string value.
</summary>
<param name="context">the context.</param>
<param name="value">The value.</param>
<example>
<code>
Debug("{string}");
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.QuietVerbosity(Cake.Core.ICakeContext)">
<summary>
Sets the log verbosity to quiet and returns a disposable that restores the log verbosity on dispose.
</summary>
<param name="context">the context.</param>
<returns>A disposable that restores the log verbosity.</returns>
<example>
<code>
using (QuietVerbosity())
{
Error("Show me.");
Warning("Hide me.");
Information("Hide me.");
Verbose("Hide me.");
Debug("Hide me.");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.MinimalVerbosity(Cake.Core.ICakeContext)">
<summary>
Sets the log verbosity to minimal and returns a disposable that restores the log verbosity on dispose.
</summary>
<param name="context">the context.</param>
<returns>A disposable that restores the log verbosity.</returns>
<example>
<code>
using (MinimalVerbosity())
{
Error("Show me.");
Warning("Show me.");
Information("Hide me.");
Verbose("Hide me.");
Debug("Hide me.");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.NormalVerbosity(Cake.Core.ICakeContext)">
<summary>
Sets the log verbosity to normal and returns a disposable that restores the log verbosity on dispose.
</summary>
<param name="context">the context.</param>
<returns>A disposable that restores the log verbosity.</returns>
<example>
<code>
using (NormalVerbosity())
{
Error("Show me.");
Warning("Show me.");
Information("Show me.");
Verbose("Hide me.");
Debug("Hide me.");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.VerboseVerbosity(Cake.Core.ICakeContext)">
<summary>
Sets the log verbosity to verbose and returns a disposable that restores the log verbosity on dispose.
</summary>
<param name="context">the context.</param>
<returns>A disposable that restores the log verbosity.</returns>
<example>
<code>
using (VerboseVerbosity())
{
Error("Show me.");
Warning("Show me.");
Information("Show me.");
Verbose("Show me.");
Debug("Hide me.");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.DiagnosticVerbosity(Cake.Core.ICakeContext)">
<summary>
Sets the log verbosity to diagnostic and returns a disposable that restores the log verbosity on dispose.
</summary>
<param name="context">the context.</param>
<returns>A disposable that restores the log verbosity.</returns>
<example>
<code>
using (DiagnosticVerbosity())
{
Error("Show me.");
Warning("Show me.");
Information("Show me.");
Verbose("Show me.");
Debug("Show me.");
}
</code>
</example>
</member>
<member name="T:Cake.Common.Diagnostics.ScriptCallerAliases">
<summary>
Contains functionality related to diagnostics.
</summary>
</member>
<member name="M:Cake.Common.Diagnostics.ScriptCallerAliases.GetCallerInfo(Cake.Core.ICakeContext,System.String,System.String,System.Int32)">
<summary>
Performs script caller information.
</summary>
<param name="context">The context.</param>
<param name="memberName">The member name.</param>
<param name="sourceFilePath">The source file path.</param>
<param name="sourceLineNumber">The source line number.</param>
<returns>A <see cref="M:Cake.Common.Diagnostics.ScriptCallerAliases.GetCallerInfo(Cake.Core.ICakeContext,System.String,System.String,System.Int32)"/> instance representing the caller information.</returns>
</member>
<member name="T:Cake.Common.Diagnostics.ScriptCallerInfo">
<summary>
Represents a caller information.
</summary>
</member>
<member name="M:Cake.Common.Diagnostics.ScriptCallerInfo.#ctor(System.String,Cake.Core.IO.FilePath,System.Int32)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Diagnostics.ScriptCallerInfo"/> class.
</summary>
<param name="memberName">The member name.</param>
<param name="sourceFilePath">The source file path.</param>
<param name="sourceLineNumber">The source line number.</param>
</member>
<member name="P:Cake.Common.Diagnostics.ScriptCallerInfo.MemberName">
<summary>
Gets the method or property name of the caller to the method.
</summary>
</member>
<member name="P:Cake.Common.Diagnostics.ScriptCallerInfo.SourceFilePath">
<summary>
Gets the full path of the source file that contains the caller.
</summary>
</member>
<member name="P:Cake.Common.Diagnostics.ScriptCallerInfo.SourceLineNumber">
<summary>
Gets the line number in the source file at which the method is called.
</summary>
</member>
<member name="M:Cake.Common.Diagnostics.ScriptCallerInfo.ToString">
<summary>
Returns a <see cref="T:System.String" /> containing the full path of the source file and the line number in the source file at which the method is called.
</summary>
<returns>
A <see cref="T:System.String" /> containing the full path of the source file and the line number in the source file at which the method is called.
</returns>
</member>
<member name="T:Cake.Common.Diagnostics.NamespaceDoc">
<summary>
This namespace contain types that
enable you to interact with build logs.
</summary>
</member>
<member name="T:Cake.Common.DryRunAliases">
<summary>
Contains functionality related to arguments.
</summary>
</member>
<member name="M:Cake.Common.DryRunAliases.IsDryRun(Cake.Core.ICakeContext)">
<summary>
Determines whether or not the current script execution is a dry run.
</summary>
<param name="context">The context.</param>
<returns>Whether or not the current script execution is a dry run.</returns>
<example>
<code>
Setup(context =>
{
if (!context.IsDryRun())
{
// Do things that you don't want to
// do during a dry run.
}
});
</code>
</example>
</member>
<member name="T:Cake.Common.EnvironmentAliases">
<summary>
Contains functionality related to the environment.
</summary>
</member>
<member name="M:Cake.Common.EnvironmentAliases.EnvironmentVariable(Cake.Core.ICakeContext,System.String)">
<summary>
Retrieves the value of the environment variable or <c>null</c> if the environment variable does not exist.
</summary>
<example>
<code>
Information(EnvironmentVariable("HOME") ?? "Unknown location");
</code>
</example>
<param name="context">The context.</param>
<param name="variable">The environment variable.</param>
<returns>The environment variable or <c>null</c> if the environment variable does not exist.</returns>
</member>
<member name="M:Cake.Common.EnvironmentAliases.EnvironmentVariable``1(Cake.Core.ICakeContext,System.String,``0)">
<summary>
Retrieves the value of the environment variable or <paramref name="defaultValue"/> if the environment variable does not exist.
</summary>
<example>
<code>
Information(EnvironmentVariable<int>("BUILD_NUMBER", 42));
</code>
</example>
<typeparam name="T">The environment variable type.</typeparam>
<param name="context">The context.</param>
<param name="variable">The environment variable.</param>
<param name="defaultValue">The value to return if the environment variable does not exist.</param>
<returns>The environment variable or <paramref name="defaultValue"/> if the environment variable does not exist.</returns>
</member>
<member name="M:Cake.Common.EnvironmentAliases.EnvironmentVariables(Cake.Core.ICakeContext)">
<summary>
Retrieves all environment variables.
</summary>
<example>
<code>
var envVars = EnvironmentVariables();
string path;
if (envVars.TryGetValue("PATH", out path))
{
Information("Path: {0}", path);
}
foreach(var envVar in envVars)
{
Information(
"Key: {0}\tValue: \"{1}\"",
envVar.Key,
envVar.Value
);
}
</code>
</example>
<param name="context">The context.</param>
<returns>The environment variables.</returns>
</member>
<member name="M:Cake.Common.EnvironmentAliases.HasEnvironmentVariable(Cake.Core.ICakeContext,System.String)">
<summary>
Checks for the existence of a value for a given environment variable.
</summary>
<example>
<code>
if (HasEnvironmentVariable("SOME_ENVIRONMENT_VARIABLE"))
{
Information("The environment variable was present.");
}
</code>
</example>
<param name="context">The context.</param>
<param name="variable">The environment variable.</param>
<returns>
<c>true</c> if the environment variable exist; otherwise <c>false</c>.
</returns>
</member>
<member name="M:Cake.Common.EnvironmentAliases.IsRunningOnWindows(Cake.Core.ICakeContext)">
<summary>
Determines whether the build script is running on Windows.
</summary>
<example>
<code>
if (IsRunningOnWindows())
{
Information("Windows!");
}
</code>
</example>
<param name="context">The context.</param>
<returns>
<c>true</c> if the build script is running on Windows; otherwise <c>false</c>.
</returns>
</member>
<member name="M:Cake.Common.EnvironmentAliases.IsRunningOnUnix(Cake.Core.ICakeContext)">
<summary>
Determines whether the build script running on a Unix or Linux based system.
</summary>
<example>
<code>
if (IsRunningOnUnix())
{
Information("Not Windows!");
}
</code>
</example>
<param name="context">The context.</param>
<returns>
<c>true</c> if the build script running on a Unix or Linux based system; otherwise <c>false</c>.
</returns>
</member>
<member name="M:Cake.Common.EnvironmentAliases.IsRunningOnMacOs(Cake.Core.ICakeContext)">
<summary>
Determines whether the build script running on a macOS based system.
</summary>
<example>
<code>
if (IsRunningOnMacOs())
{
Information("macOS!");
}
</code>
</example>
<param name="context">The context.</param>
<returns>
<c>true</c> if the build script running on a macOS based system; otherwise <c>false</c>.
</returns>
</member>
<member name="M:Cake.Common.EnvironmentAliases.IsRunningOnLinux(Cake.Core.ICakeContext)">
<summary>
Determines whether the build script running on a Linux based system.
</summary>
<example>
<code>
if (IsRunningOnLinux())
{
Information("Linux!");
}
</code>
</example>
<param name="context">The context.</param>
<returns>
<c>true</c> if the build script running on a Linux based system; otherwise <c>false</c>.
</returns>
</member>
<member name="T:Cake.Common.IO.DeleteDirectorySettings">
<summary>
Contains settings used by <c>DeleteDirectory</c>.
</summary>
</member>
<member name="P:Cake.Common.IO.DeleteDirectorySettings.Recursive">
<summary>
Gets or sets a value indicating whether to perform a recursive delete if set to <c>true</c>.
<remarks>
It is set to <c>false</c> by default.
</remarks>
</summary>
</member>
<member name="P:Cake.Common.IO.DeleteDirectorySettings.Force">
<summary>
Gets or sets a value indicating whether to delete read-only files if set to <c>true</c>.
<remarks>
It is set to <c>false</c> by default.
</remarks>
</summary>
</member>
<member name="T:Cake.Common.IO.DirectoryAliases">
<summary>
Contains extension methods for working with directories.
</summary>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.Directory(Cake.Core.ICakeContext,System.String)">
<summary>
Gets a directory path from string.
</summary>
<example>
<code>
// Get the temp directory.
var root = Directory("./");
var temp = root + Directory("temp");
// Clean the directory.
CleanDirectory(temp);
</code>
</example>
<param name="context">The context.</param>
<param name="path">The path.</param>
<returns>A directory path.</returns>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.DeleteDirectories(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.DirectoryPath},Cake.Common.IO.DeleteDirectorySettings)">
<summary>
Deletes the specified directories.
</summary>
<example>
<code>
var directoriesToDelete = new DirectoryPath[]{
Directory("be"),
Directory("gone")
};
DeleteDirectories(directoriesToDelete, new DeleteDirectorySettings {
Recursive = true,
Force = true
});
</code>
</example>
<param name="context">The context.</param>
<param name="directories">The directory paths.</param>
<param name="settings">The delete settings.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.DeleteDirectories(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Common.IO.DeleteDirectorySettings)">
<summary>
Deletes the specified directories.
</summary>
<example>
<code>
var directoriesToDelete = new []{
"be",
"gone"
};
DeleteDirectories(directoriesToDelete, new DeleteDirectorySettings {
Recursive = true,
Force = true
});
</code>
</example>
<param name="context">The context.</param>
<param name="directories">The directory paths.</param>
<param name="settings">The delete settings.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.DeleteDirectory(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Common.IO.DeleteDirectorySettings)">
<summary>
Deletes the specified directory.
</summary>
<example>
<code>
DeleteDirectory("./be/gone", new DeleteDirectorySettings {
Recursive = true,
Force = true
});
</code>
</example>
<param name="context">The context.</param>
<param name="path">The directory path.</param>
<param name="settings">The delete settings.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.CleanDirectories(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Cleans the directories matching the specified pattern.
Cleaning the directory will remove all its content but not the directory itself.
</summary>
<example>
<code>
CleanDirectories("./src/**/bin/debug");
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The pattern to match.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.CleanDirectories(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,System.Func{Cake.Core.IO.IFileSystemInfo,System.Boolean})">
<summary>
Cleans the directories matching the specified pattern.
Cleaning the directory will remove all its content but not the directory itself.
</summary>
<example>
<code>
Func<IFileSystemInfo, bool> exclude_node_modules =
fileSystemInfo=>!fileSystemInfo.Path.FullPath.EndsWith(
"node_modules",
StringComparison.OrdinalIgnoreCase);
CleanDirectories("./src/**/bin/debug", exclude_node_modules);
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The pattern to match.</param>
<param name="predicate">The predicate used to filter directories based on file system information.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.CleanDirectories(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.DirectoryPath})">
<summary>
Cleans the specified directories.
Cleaning a directory will remove all its content but not the directory itself.
</summary>
<example>
<code>
var directoriesToClean = GetDirectories("./src/**/bin/");
CleanDirectories(directoriesToClean);
</code>
</example>
<param name="context">The context.</param>
<param name="directories">The directory paths.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.CleanDirectories(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Cleans the specified directories.
Cleaning a directory will remove all its content but not the directory itself.
</summary>
<example>
<code>
var directoriesToClean = new []{
"./src/Cake/obj",
"./src/Cake.Common/obj"
};
CleanDirectories(directoriesToClean);
</code>
</example>
<param name="context">The context.</param>
<param name="directories">The directory paths.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.CleanDirectory(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath)">
<summary>
Cleans the specified directory.
</summary>
<example>
<code>
CleanDirectory("./src/Cake.Common/obj");
</code>
</example>
<param name="context">The context.</param>
<param name="path">The directory path.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.CleanDirectory(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,System.Func{Cake.Core.IO.IFileSystemInfo,System.Boolean})">
<summary>
Cleans the specified directory.
</summary>
<example>
<code>
CleanDirectory("./src/Cake.Common/obj", fileSystemInfo=>!fileSystemInfo.Hidden);
</code>
</example>
<param name="context">The context.</param>
<param name="path">The directory path.</param>
<param name="predicate">Predicate used to determine which files/directories should get deleted.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.CreateDirectory(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath)">
<summary>
Creates the specified directory.
</summary>
<example>
<code>
CreateDirectory("publish");
</code>
</example>
<param name="context">The context.</param>
<param name="path">The directory path.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.EnsureDirectoryExists(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath)">
<summary>
Creates the specified directory if it does not exist.
</summary>
<example>
<code>
EnsureDirectoryExists("publish");
</code>
</example>
<param name="context">The context.</param>
<param name="path">The directory path.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.EnsureDirectoryDoesNotExist(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath)">
<summary>
Deletes the specified directory and its contents if it exists.
</summary>
<example>
<code>
EnsureDirectoryDoesNotExist("./be/gone");
</code>
</example>
<param name="context">The context.</param>
<param name="path">The directory path.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.EnsureDirectoryDoesNotExist(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Common.IO.DeleteDirectorySettings)">
<summary>
Deletes the specified directory if it exists.
</summary>
<example>
<code>
EnsureDirectoryDoesNotExist("./be/gone", new DeleteDirectorySettings {
Recursive = true,
Force = true
});
</code>
</example>
<param name="context">The context.</param>
<param name="path">The directory path.</param>
<param name="settings">The delete settings.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.EnsureDirectoryDoesNotExist(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Common.IO.EnsureDirectoryDoesNotExistSettings)">
<summary>
Deletes the specified directory if it exists.
</summary>
<example>
<code>
EnsureDirectoryDoesNotExist("./be/gone", new EnsureDirectoryDoesNotExistSettings {
Recursive = true,
Force = true
});
</code>
</example>
<param name="context">The context.</param>
<param name="path">The directory path.</param>
<param name="settings">The delete settings.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.CopyDirectory(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Core.IO.DirectoryPath)">
<summary>
Copies the contents of a directory, including subdirectories to the specified location.
</summary>
<example>
<code>
CopyDirectory("source_path", "destination_path");
</code>
</example>
<param name="context">The context.</param>
<param name="source">The source directory path.</param>
<param name="destination">The destination directory path.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.DirectoryExists(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath)">
<summary>
Determines whether the given path refers to an existing directory.
</summary>
<example>
<code>
var dir = "publish";
if (!DirectoryExists(dir))
{
CreateDirectory(dir);
}
</code>
</example>
<param name="context">The context.</param>
<param name="path">The <see cref="T:Cake.Core.IO.DirectoryPath"/> to check.</param>
<returns><c>true</c> if <paramref name="path"/> refers to an existing directory;
<c>false</c> if the directory does not exist or an error occurs when trying to
determine if the specified path exists.</returns>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.MakeAbsolute(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath)">
<summary>
Makes the path absolute (if relative) using the current working directory.
</summary>
<example>
<code>
var path = MakeAbsolute(Directory("./resources"));
</code>
</example>
<param name="context">The context.</param>
<param name="path">The path.</param>
<returns>An absolute directory path.</returns>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.MakeRelative(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Core.IO.DirectoryPath)">
<summary>
Makes the directory path relative (if absolute) to a specified root directory. If no root directory is defined
the current working directory is used as default root.
</summary>
<example>
<code>
var path = MakeRelative(Directory("C:\Cake\Tests\Integration"));
</code>
</example>
<param name="context">The context.</param>
<param name="path">The path.</param>
<param name="rootPath">The root path.</param>
<returns>A relative directory path.</returns>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.MakeRelative(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.DirectoryPath)">
<summary>
Makes the file path relative (if absolute) to a specified root directory. If no root directory is defined
the current working directory is used as default root.
</summary>
<example>
<code>
var path = MakeRelative(Directory("C:\Cake\Tests\Integration\file.cake"));
</code>
</example>
<param name="context">The context.</param>
<param name="path">The path.</param>
<param name="rootPath">The root path.</param>
<returns>A relative file path.</returns>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.MoveDirectory(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Core.IO.DirectoryPath)">
<summary>
Moves an existing directory to a new location, providing the option to specify a new directory name.
</summary>
<param name="context">The context.</param>
<param name="directoryPath">The directory path.</param>
<param name="targetDirectoryPath">The target directory path.</param>
<example>
<code>
MoveDirectory("mydir", "newparent/newdir");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.GetSubDirectories(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath)">
<summary>
Gets a list of all the directories inside a directory.
</summary>
<example>
<code>
var directories = GetSubDirectories("some/dir");
</code>
</example>
<param name="context">The context.</param>
<param name="directoryPath">The directory path.</param>
<returns>An absolute directory path.</returns>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.ExpandEnvironmentVariables(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath)">
<summary>
Expands all environment variables in the provided <see cref="T:Cake.Core.IO.DirectoryPath"/>.
</summary>
<example>
<code>
var path = new DirectoryPath("%APPDATA%/foo");
var expanded = path.ExpandEnvironmentVariables(environment);
</code>
</example>
<param name="context">The context.</param>
<param name="directoryPath">The path.</param>
<returns>A new <see cref="T:Cake.Core.IO.DirectoryPath"/> with each environment variable replaced by its value.</returns>
</member>
<member name="T:Cake.Common.IO.EnsureDirectoryDoesNotExistSettings">
<summary>
Contains settings used by <c>EnsureDirectoryDoesNotExistSettings</c>.
</summary>
</member>
<member name="T:Cake.Common.IO.FileAliases">
<summary>
Contains functionality related to file operations.
</summary>
</member>
<member name="M:Cake.Common.IO.FileAliases.File(Cake.Core.ICakeContext,System.String)">
<summary>
Gets a file path from string.
</summary>
<example>
<code>
// Get the temp file.
var root = Directory("./");
var temp = root + File("temp");
// Delete the file.
CleanDirectory(temp);
</code>
</example>
<param name="context">The context.</param>
<param name="path">The path.</param>
<returns>A file path.</returns>
</member>
<member name="M:Cake.Common.IO.FileAliases.CopyFileToDirectory(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.DirectoryPath)">
<summary>
Copies an existing file to a new location.
</summary>
<param name="context">The context.</param>
<param name="filePath">The file path.</param>
<param name="targetDirectoryPath">The target directory path.</param>
<example>
<code>
CopyFileToDirectory("test.txt", "./targetdir");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.CopyFile(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath)">
<summary>
Copies an existing file to a new file, providing the option to specify a new file name.
</summary>
<param name="context">The context.</param>
<param name="filePath">The file path.</param>
<param name="targetFilePath">The target file path.</param>
<example>
<code>
CopyFile("test.tmp", "test.txt");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.CopyFiles(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Core.IO.DirectoryPath)">
<summary>
Copies all files matching the provided pattern to a new location.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="targetDirectoryPath">The target directory path.</param>
<example>
<code>
CopyFiles("Cake.*", "./publish");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.CopyFiles(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Core.IO.DirectoryPath)">
<summary>
Copies existing files to a new location.
</summary>
<param name="context">The context.</param>
<param name="filePaths">The file paths.</param>
<param name="targetDirectoryPath">The target directory path.</param>
<example>
<code>
var files = GetFiles("./**/Cake.*");
CopyFiles(files, "destination");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.CopyFiles(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Core.IO.DirectoryPath)">
<summary>
Copies existing files to a new location.
</summary>
<param name="context">The context.</param>
<param name="filePaths">The file paths.</param>
<param name="targetDirectoryPath">The target directory path.</param>
<example>
<code>
CreateDirectory("destination");
var files = new [] {
"Cake.exe",
"Cake.pdb"
};
CopyFiles(files, "destination");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.CopyFiles(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Core.IO.DirectoryPath,System.Boolean)">
<summary>
Copies all files matching the provided pattern to a new location.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="targetDirectoryPath">The target directory path.</param>
<param name="preserveFolderStructure">Keep the folder structure.</param>
<example>
<code>
CopyFiles("Cake.*", "./publish");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.CopyFiles(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Core.IO.DirectoryPath,System.Boolean)">
<summary>
Copies existing files to a new location.
</summary>
<param name="context">The context.</param>
<param name="filePaths">The file paths.</param>
<param name="targetDirectoryPath">The target directory path.</param>
<param name="preserveFolderStructure">Keep the folder structure.</param>
<example>
<code>
var files = GetFiles("./**/Cake.*");
CopyFiles(files, "destination");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.CopyFiles(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Core.IO.DirectoryPath,System.Boolean)">
<summary>
Copies existing files to a new location.
</summary>
<param name="context">The context.</param>
<param name="filePaths">The file paths.</param>
<param name="targetDirectoryPath">The target directory path.</param>
<param name="preserveFolderStructure">Keep the folder structure.</param>
<example>
<code>
CreateDirectory("destination");
var files = new [] {
"Cake.exe",
"Cake.pdb"
};
CopyFiles(files, "destination");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.MoveFileToDirectory(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.DirectoryPath)">
<summary>
Moves an existing file to a new location.
</summary>
<param name="context">The context.</param>
<param name="filePath">The file path.</param>
<param name="targetDirectoryPath">The target directory path.</param>
<example>
<code>
MoveFileToDirectory("test.txt", "./targetdir");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.MoveFiles(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Core.IO.DirectoryPath)">
<summary>
Moves existing files matching the specified pattern to a new location.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="targetDirectoryPath">The target directory path.</param>
<example>
<code>
MoveFiles("./publish/Cake.*", "./destination");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.MoveFiles(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Core.IO.DirectoryPath)">
<summary>
Moves existing files to a new location.
</summary>
<param name="context">The context.</param>
<param name="filePaths">The file paths.</param>
<param name="targetDirectoryPath">The target directory path.</param>
<example>
<code>
var files = GetFiles("./publish/Cake.*");
MoveFiles(files, "destination");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.MoveFile(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath)">
<summary>
Moves an existing file to a new location, providing the option to specify a new file name.
</summary>
<param name="context">The context.</param>
<param name="filePath">The file path.</param>
<param name="targetFilePath">The target file path.</param>
<example>
<code>
MoveFile("test.tmp", "test.txt");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.DeleteFiles(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Deletes the specified files.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<example>
<code>
DeleteFiles("./publish/Cake.*");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.DeleteFiles(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Deletes the specified files.
</summary>
<param name="context">The context.</param>
<param name="filePaths">The file paths.</param>
<example>
<code>
var files = GetFiles("./destination/Cake.*");
DeleteFiles(files);
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.DeleteFile(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Deletes the specified file.
</summary>
<param name="context">The context.</param>
<param name="filePath">The file path.</param>
<example>
<code>
DeleteFile("deleteme.txt");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.FileExists(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Determines whether the given path refers to an existing file.
</summary>
<param name="context">The context.</param>
<param name="filePath">The <see cref="T:Cake.Core.IO.FilePath"/> to check.</param>
<returns><c>true</c> if <paramref name="filePath"/> refers to an existing file;
<c>false</c> if the file does not exist or an error occurs when trying to
determine if the specified file exists.</returns>
<example>
<code>
if (FileExists("findme.txt"))
{
Information("File exists!");
}
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.MakeAbsolute(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Makes the path absolute (if relative) using the current working directory.
</summary>
<param name="context">The context.</param>
<param name="filePath">The path.</param>
<returns>An absolute file path.</returns>
<example>
<code>
var path = MakeAbsolute(File("./resources"));
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.FileSize(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Gets the size of a file in bytes.
</summary>
<param name="context">The context.</param>
<param name="filePath">The path.</param>
<returns>Size of file in bytes or -1 if file doesn't exist.</returns>
<example>
<code>
Information("File size: {0}", FileSize("./build.cake"));
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.ExpandEnvironmentVariables(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Expands all environment variables in the provided <see cref="T:Cake.Core.IO.FilePath"/>.
</summary>
<example>
<code>
var path = new FilePath("%APPDATA%/foo.bar");
var expanded = path.ExpandEnvironmentVariables(environment);
</code>
</example>
<param name="context">The context.</param>
<param name="filePath">The path.</param>
<returns>A new <see cref="T:Cake.Core.IO.FilePath"/> with each environment variable replaced by its value.</returns>
</member>
<member name="T:Cake.Common.IO.GlobbingAliases">
<summary>
Contains functionality related to file system globbing.
</summary>
</member>
<member name="M:Cake.Common.IO.GlobbingAliases.GetFiles(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Gets all files matching the specified pattern.
</summary>
<example>
<code>
var files = GetFiles("./**/Cake.*.dll");
foreach(var file in files)
{
Information("File: {0}", file);
}
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The glob pattern to match.</param>
<returns>A <see cref="T:Cake.Core.IO.FilePathCollection" />.</returns>
</member>
<member name="M:Cake.Common.IO.GlobbingAliases.GetFiles(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Core.IO.GlobberSettings)">
<summary>
Gets all files matching the specified pattern.
</summary>
<example>
<code>
Func<IFileSystemInfo, bool> exclude_node_modules =
fileSystemInfo => !fileSystemInfo.Path.FullPath.EndsWith(
"node_modules", StringComparison.OrdinalIgnoreCase);
var files = GetFiles("./**/Cake.*.dll", new GlobberSettings { Predicate = exclude_node_modules });
foreach(var file in files)
{
Information("File: {0}", file);
}
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The glob pattern to match.</param>
<param name="settings">The globber settings.</param>
<returns>A <see cref="T:Cake.Core.IO.FilePathCollection" />.</returns>
</member>
<member name="M:Cake.Common.IO.GlobbingAliases.GetDirectories(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Gets all directories matching the specified pattern.
</summary>
<example>
<code>
var directories = GetDirectories("./src/**/obj/*");
foreach(var directory in directories)
{
Information("Directory: {0}", directory);
}
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The glob pattern to match.</param>
<returns>A <see cref="T:Cake.Core.IO.DirectoryPathCollection" />.</returns>
</member>
<member name="M:Cake.Common.IO.GlobbingAliases.GetDirectories(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Core.IO.GlobberSettings)">
<summary>
Gets all directories matching the specified pattern.
</summary>
<example>
<code>
Func<IFileSystemInfo, bool> exclude_node_modules =
fileSystemInfo => !fileSystemInfo.Path.FullPath.EndsWith(
"node_modules", StringComparison.OrdinalIgnoreCase);
var directories = GetDirectories("./src/**/obj/*", new GlobberSettings { Predicate = exclude_node_modules });
foreach(var directory in directories)
{
Information("Directory: {0}", directory);
}
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The glob pattern to match.</param>
<param name="settings">The globber settings.</param>
<returns>A <see cref="T:Cake.Core.IO.DirectoryPathCollection" />.</returns>
</member>
<member name="M:Cake.Common.IO.GlobbingAliases.GetPaths(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Gets all paths matching the specified pattern.
</summary>
<example>
<code>
var paths = GetPaths("./src/**/obj/*");
foreach(var paths in paths)
{
Information("Path: {0}", path);
}
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The glob pattern to match.</param>
<returns>A <see cref="T:Cake.Core.IO.PathCollection" />.</returns>
</member>
<member name="M:Cake.Common.IO.GlobbingAliases.GetPaths(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Core.IO.GlobberSettings)">
<summary>
Gets all paths matching the specified pattern.
</summary>
<example>
<code>
Func<IFileSystemInfo, bool> exclude_node_modules =
fileSystemInfo => !fileSystemInfo.Path.FullPath.EndsWith(
"node_modules", StringComparison.OrdinalIgnoreCase);
var paths = GetPaths("./src/**/obj/*", new GlobberSettings { Predicate = exclude_node_modules });
foreach(var paths in paths)
{
Information("Path: {0}", path);
}
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The glob pattern to match.</param>
<param name="settings">The globber settings.</param>
<returns>A <see cref="T:Cake.Core.IO.PathCollection" />.</returns>
</member>
<member name="T:Cake.Common.IO.Paths.ConvertableDirectoryPath">
<summary>
Represents a <see cref="T:Cake.Core.IO.DirectoryPath" /> that can be easily converted.
<example>
To get the underlying <see cref="T:Cake.Core.IO.DirectoryPath"/>:
<code>
ConvertableDirectoryPath convertable = Directory("./root");
DirectoryPath path = (DirectoryPath)convertable;
</code>
To combine two directories:
<code>
ConvertableDirectoryPath path = Directory("./root") + Directory("other");
</code>
To combine a directory with a file:
<code>
ConvertableFilePath path = Directory("./root") + File("other.txt");
</code>
</example>
</summary>
</member>
<member name="P:Cake.Common.IO.Paths.ConvertableDirectoryPath.Path">
<summary>
Gets the path.
</summary>
<value>The path.</value>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableDirectoryPath.#ctor(Cake.Core.IO.DirectoryPath)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.IO.Paths.ConvertableDirectoryPath"/> class.
</summary>
<param name="path">The path.</param>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableDirectoryPath.op_Addition(Cake.Common.IO.Paths.ConvertableDirectoryPath,Cake.Common.IO.Paths.ConvertableDirectoryPath)">
<summary>
Operator that combines A <see cref="T:Cake.Common.IO.Paths.ConvertableDirectoryPath"/> instance
with another <see cref="T:Cake.Common.IO.Paths.ConvertableDirectoryPath"/> instance.
</summary>
<param name="left">The left directory path operand.</param>
<param name="right">The right directory path operand.</param>
<returns>A new directory path representing a combination of the two provided paths.</returns>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableDirectoryPath.op_Addition(Cake.Core.IO.DirectoryPath,Cake.Common.IO.Paths.ConvertableDirectoryPath)">
<summary>
Operator that combines A <see cref="T:Cake.Core.IO.DirectoryPath"/> instance
with a <see cref="T:Cake.Common.IO.Paths.ConvertableDirectoryPath"/> instance.
</summary>
<param name="left">The left directory path operand.</param>
<param name="right">The right directory path operand.</param>
<returns>A new directory path representing a combination of the two provided paths.</returns>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableDirectoryPath.op_Addition(Cake.Common.IO.Paths.ConvertableDirectoryPath,Cake.Core.IO.DirectoryPath)">
<summary>
Operator that combines A <see cref="T:Cake.Common.IO.Paths.ConvertableDirectoryPath"/> instance
with a <see cref="T:Cake.Core.IO.DirectoryPath"/> instance.
</summary>
<param name="left">The left directory path operand.</param>
<param name="right">The right directory path operand.</param>
<returns>A new directory path representing a combination of the two provided paths.</returns>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableDirectoryPath.op_Addition(Cake.Common.IO.Paths.ConvertableDirectoryPath,Cake.Common.IO.Paths.ConvertableFilePath)">
<summary>
Operator that combines A <see cref="T:Cake.Common.IO.Paths.ConvertableDirectoryPath"/> instance
with a <see cref="T:Cake.Common.IO.Paths.ConvertableFilePath"/> instance.
</summary>
<param name="directory">The left directory path operand.</param>
<param name="file">The right file path operand.</param>
<returns>A new file path representing a combination of the two provided paths.</returns>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableDirectoryPath.op_Addition(Cake.Common.IO.Paths.ConvertableDirectoryPath,Cake.Core.IO.FilePath)">
<summary>
Operator that combines A <see cref="T:Cake.Common.IO.Paths.ConvertableDirectoryPath"/> instance
with a <see cref="T:Cake.Core.IO.FilePath"/> instance.
</summary>
<param name="directory">The left directory path operand.</param>
<param name="file">The right file path operand.</param>
<returns>A new file path representing a combination of the two provided paths.</returns>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableDirectoryPath.op_Implicit(Cake.Common.IO.Paths.ConvertableDirectoryPath)~Cake.Core.IO.DirectoryPath">
<summary>
Performs an implicit conversion from <see cref="T:Cake.Common.IO.Paths.ConvertableDirectoryPath"/> to <see cref="T:Cake.Core.IO.DirectoryPath"/>.
</summary>
<param name="path">The path.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableDirectoryPath.op_Implicit(Cake.Common.IO.Paths.ConvertableDirectoryPath)~System.String">
<summary>
Performs an implicit conversion from <see cref="T:Cake.Common.IO.Paths.ConvertableDirectoryPath"/> to <see cref="T:System.String"/>.
</summary>
<param name="path">The path.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableDirectoryPath.ToString">
<summary>
Returns a <see cref="T:System.String" /> that represents this instance.
</summary>
<returns>
A <see cref="T:System.String" /> that represents this instance.
</returns>
</member>
<member name="T:Cake.Common.IO.Paths.ConvertableFilePath">
<summary>
Represents a <see cref="T:Cake.Core.IO.FilePath" /> that can be easily converted.
</summary>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableFilePath.#ctor(Cake.Core.IO.FilePath)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.IO.Paths.ConvertableFilePath"/> class.
</summary>
<param name="path">The path.</param>
</member>
<member name="P:Cake.Common.IO.Paths.ConvertableFilePath.Path">
<summary>
Gets the path.
</summary>
<value>The actual path.</value>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableFilePath.op_Implicit(Cake.Common.IO.Paths.ConvertableFilePath)~Cake.Core.IO.FilePath">
<summary>
Performs an implicit conversion from <see cref="T:Cake.Common.IO.Paths.ConvertableFilePath"/> to <see cref="T:Cake.Core.IO.FilePath"/>.
</summary>
<param name="path">The path.</param>
<returns>The result of the conversion. </returns>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableFilePath.op_Implicit(Cake.Common.IO.Paths.ConvertableFilePath)~System.String">
<summary>
Performs an implicit conversion from <see cref="T:Cake.Common.IO.Paths.ConvertableFilePath"/> to <see cref="T:System.String"/>.
</summary>
<param name="path">The path.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableFilePath.ToString">
<summary>
Returns a <see cref="T:System.String" /> that represents this instance.
</summary>
<returns>
A <see cref="T:System.String" /> that represents this instance.
</returns>
</member>
<member name="T:Cake.Common.IO.Paths.NamespaceDoc">
<summary>
This namespace contain types related
to file system paths.
</summary>
</member>
<member name="T:Cake.Common.IO.ZipAliases">
<summary>
Contains functionality related to compress files to Zip.
</summary>
</member>
<member name="M:Cake.Common.IO.ZipAliases.Zip(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Core.IO.FilePath)">
<summary>
Zips the specified directory.
</summary>
<param name="context">The context.</param>
<param name="rootPath">The root path.</param>
<param name="outputPath">The output path.</param>
<example>
<code>
Zip("./publish", "publish.zip");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.ZipAliases.Zip(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Core.IO.FilePath,System.String)">
<summary>
Zips the files matching the specified pattern.
</summary>
<param name="context">The context.</param>
<param name="rootPath">The root path.</param>
<param name="outputPath">The output path.</param>
<param name="pattern">The pattern.</param>
<example>
<code>
Zip("./", "XmlFiles.zip", "./*.xml");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.ZipAliases.Zip(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Core.IO.FilePath,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Zips the specified files.
</summary>
<param name="context">The context.</param>
<param name="rootPath">The root path.</param>
<param name="outputPath">The output path.</param>
<param name="filePaths">The file paths.</param>
<example>
<code>
var files = GetFiles("./**/Cake.*.dll");
Zip("./", "CakeAssemblies.zip", files);
</code>
</example>
</member>
<member name="M:Cake.Common.IO.ZipAliases.Zip(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Core.IO.FilePath,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Zips the specified files.
</summary>
<param name="context">The context.</param>
<param name="rootPath">The root path.</param>
<param name="outputPath">The output path.</param>
<param name="filePaths">The file paths.</param>
<example>
<code>
var files = new [] {
"./src/Cake/bin/Debug/Autofac.dll",
"./src/Cake/bin/Debug/Cake.Common.dll",
"./src/Cake/bin/Debug/Cake.Core.dll",
"./src/Cake/bin/Debug/Cake.exe"
};
Zip("./", "CakeBinaries.zip", files);
</code>
</example>
</member>
<member name="M:Cake.Common.IO.ZipAliases.Unzip(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.DirectoryPath)">
<summary>
Unzips the specified file.
</summary>
<param name="context">The context.</param>
<param name="zipFile">Zip file to unzip.</param>
<param name="outputPath">Output path to unzip into.</param>
<example>
<code>
Unzip("Cake.zip", "./cake");
</code>
</example>
</member>
<member name="T:Cake.Common.IO.Zipper">
<summary>
Performs Zip compression.
</summary>
</member>
<member name="M:Cake.Common.IO.Zipper.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.IO.Zipper"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="log">The log.</param>
</member>
<member name="M:Cake.Common.IO.Zipper.Zip(Cake.Core.IO.DirectoryPath,Cake.Core.IO.FilePath,System.Collections.Generic.IEnumerable{Cake.Core.IO.Path})">
<summary>
Zips the specified directory.
</summary>
<param name="rootPath">The root path.</param>
<param name="outputPath">The output path.</param>
<param name="paths">The paths to zip.</param>
</member>
<member name="M:Cake.Common.IO.Zipper.Zip(Cake.Core.IO.DirectoryPath,Cake.Core.IO.FilePath,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Zips the specified directory.
</summary>
<param name="rootPath">The root path.</param>
<param name="outputPath">The output path.</param>
<param name="filePaths">The files to zip.</param>
</member>
<member name="M:Cake.Common.IO.Zipper.Unzip(Cake.Core.IO.FilePath,Cake.Core.IO.DirectoryPath)">
<summary>
Unzips the specified file to the specified output path.
</summary>
<param name="zipPath">Zip file path.</param>
<param name="outputPath">Output directory path.</param>
</member>
<member name="T:Cake.Common.IO.NamespaceDoc">
<summary>
This namespace contain types that support input and output,
including the ability to read and write data to streams and to
interact with the file system.
</summary>
</member>
<member name="T:Cake.Common.IO.Net.NamespaceDoc">
<summary>
This namespace contain types related
to network operations.
</summary>
</member>
<member name="T:Cake.Common.Modules.CommonModule">
<summary>
The module responsible for registering
default types in the Cake.Common assembly.
</summary>
</member>
<member name="M:Cake.Common.Modules.CommonModule.Register(Cake.Core.Composition.ICakeContainerRegistrar)">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Net.DownloadFileSettings">
<summary>
Contains settings for <see cref="T:Cake.Common.Net.HttpAliases"/>.
</summary>
</member>
<member name="P:Cake.Common.Net.DownloadFileSettings.Username">
<summary>
Gets or sets the username to use when downloading the file.
</summary>
</member>
<member name="P:Cake.Common.Net.DownloadFileSettings.Password">
<summary>
Gets or sets the password to use when downloading the file.
</summary>
</member>
<member name="P:Cake.Common.Net.DownloadFileSettings.UseDefaultCredentials">
<summary>
Gets or sets a value indicating whether default credentials are sent when downloading the file.
</summary>
<remarks>
If set to true, any username and password that has been specified will be ignored.
</remarks>
</member>
<member name="T:Cake.Common.Net.HttpAliases">
<summary>
Contains functionality related to HTTP operations.
</summary>
</member>
<member name="M:Cake.Common.Net.HttpAliases.DownloadFile(Cake.Core.ICakeContext,System.String)">
<summary>
Downloads the specified resource over HTTP to a temporary file.
</summary>
<example>
<code>
var resource = DownloadFile("http://www.example.org/index.html");
</code>
</example>
<param name="context">The context.</param>
<param name="address">The URL of the resource to download.</param>
<returns>The path to the downloaded file.</returns>
</member>
<member name="M:Cake.Common.Net.HttpAliases.DownloadFile(Cake.Core.ICakeContext,System.String,Cake.Common.Net.DownloadFileSettings)">
<summary>
Downloads the specified resource over HTTP to a temporary file with specified settings.
</summary>
<example>
<code>
var resource = DownloadFile("http://www.example.org/index.html", new DownloadFileSettings()
{
Username = "bob",
Password = "builder"
});
</code>
</example>
<param name="context">The context.</param>
<param name="address">The URL of the resource to download.</param>
<param name="settings">The settings.</param>
<returns>The path to the downloaded file.</returns>
</member>
<member name="M:Cake.Common.Net.HttpAliases.DownloadFile(Cake.Core.ICakeContext,System.Uri)">
<summary>
Downloads the specified resource over HTTP to a temporary file.
</summary>
<example>
<code>
var address = new Uri("http://www.example.org/index.html");
var resource = DownloadFile(address);
</code>
</example>
<param name="context">The context.</param>
<param name="address">The URL of file to download.</param>
<returns>The path to the downloaded file.</returns>
</member>
<member name="M:Cake.Common.Net.HttpAliases.DownloadFile(Cake.Core.ICakeContext,System.Uri,Cake.Common.Net.DownloadFileSettings)">
<summary>
Downloads the specified resource over HTTP to a temporary file with specified settings.
</summary>
<example>
<code>
var address = new Uri("http://www.example.org/index.html");
var resource = DownloadFile(address, new DownloadFileSettings()
{
Username = "bob",
Password = "builder"
});
</code>
</example>
<param name="context">The context.</param>
<param name="address">The URL of file to download.</param>
<param name="settings">The settings.</param>
<returns>The path to the downloaded file.</returns>
</member>
<member name="M:Cake.Common.Net.HttpAliases.DownloadFile(Cake.Core.ICakeContext,System.String,Cake.Core.IO.FilePath)">
<summary>
Downloads the specified resource over HTTP to the specified output path.
</summary>
<example>
<code>
var outputPath = File("./index.html");
DownloadFile("http://www.example.org/index.html", outputPath);
</code>
</example>
<param name="context">The context.</param>
<param name="address">The URL of the resource to download.</param>
<param name="outputPath">The output path.</param>
</member>
<member name="M:Cake.Common.Net.HttpAliases.DownloadFile(Cake.Core.ICakeContext,System.String,Cake.Core.IO.FilePath,Cake.Common.Net.DownloadFileSettings)">
<summary>
Downloads the specified resource over HTTP to the specified output path and settings.
</summary>
<example>
<code>
var outputPath = File("./index.html");
DownloadFile("http://www.example.org/index.html", outputPath, new DownloadFileSettings()
{
Username = "bob",
Password = "builder"
});
</code>
</example>
<param name="context">The context.</param>
<param name="address">The URL of the resource to download.</param>
<param name="outputPath">The output path.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Net.HttpAliases.DownloadFile(Cake.Core.ICakeContext,System.Uri,Cake.Core.IO.FilePath,Cake.Common.Net.DownloadFileSettings)">
<summary>
Downloads the specified resource over HTTP to the specified output path.
</summary>
<example>
<code>
var address = new Uri("http://www.example.org/index.html");
var outputPath = File("./index.html");
DownloadFile(address, outputPath, new DownloadFileSettings()
{
Username = "bob",
Password = "builder"
});
</code>
</example>
<param name="context">The context.</param>
<param name="address">The URL of the resource to download.</param>
<param name="outputPath">The output path.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Net.HttpAliases.UploadFile(Cake.Core.ICakeContext,System.Uri,Cake.Core.IO.FilePath)">
<summary>
Uploads the specified file via a HTTP POST to the specified uri using multipart/form-data.
</summary>
<example>
<code>
var address = new Uri("http://www.example.org/upload");
UploadFile(address, @"path/to/file.txt");
</code>
</example>
<param name="context">The context.</param>
<param name="address">The URL of the upload resource.</param>
<param name="filePath">The file to upload.</param>
</member>
<member name="M:Cake.Common.Net.HttpAliases.UploadFile(Cake.Core.ICakeContext,System.String,Cake.Core.IO.FilePath)">
<summary>
Uploads the specified file via a HTTP POST to the specified uri using multipart/form-data.
</summary>
<example>
<code>
var address = "http://www.example.org/upload";
UploadFile(address, @"path/to/file.txt");
</code>
</example>
<param name="context">The context.</param>
<param name="address">The URL of the upload resource.</param>
<param name="filePath">The file to upload.</param>
</member>
<member name="M:Cake.Common.Net.HttpAliases.UploadFile(Cake.Core.ICakeContext,System.Uri,System.Byte[],System.String)">
<summary>
Uploads the specified byte array via a HTTP POST to the specified uri using multipart/form-data.
</summary>
<example>
<code>
var address = new Uri("http://www.example.org/upload");
UploadFile(address, @"path/to/file.txt");
</code>
</example>
<param name="context">The context.</param>
<param name="address">The URL of the upload resource.</param>
<param name="data">The data to upload.</param>
<param name="fileName">The filename to give the uploaded data.</param>
</member>
<member name="M:Cake.Common.Net.HttpAliases.UploadFile(Cake.Core.ICakeContext,System.String,System.Byte[],System.String)">
<summary>
Uploads the specified byte array via a HTTP POST to the specified uri using multipart/form-data.
</summary>
<example>
<code>
var address = "http://www.example.org/upload";
UploadFile(address, @"path/to/file.txt");
</code>
</example>
<param name="context">The context.</param>
<param name="address">The URL of the upload resource.</param>
<param name="data">The data to upload.</param>
<param name="fileName">The filename to give the uploaded data.</param>
</member>
<member name="M:Cake.Common.Net.HttpAliases.GetHttpClient(Cake.Core.ICakeContext,System.Boolean)">
<summary>
Gets an <see cref="T:System.Net.Http.HttpClient"/> pre-populated with the correct default headers such as User-Agent.
The returned client should be disposed of by the caller.
</summary>
<param name="context">The current Cake context.</param>
<param name="useDefaultCredentials">Indicates whether or not to use default credentials.</param>
<returns>A <see cref="T:System.Net.Http.HttpClient"/> instance.</returns>
</member>
<member name="T:Cake.Common.Net.NamespaceDoc">
<summary>
This namespace contain types related
to security aspects such as hashing.
</summary>
</member>
<member name="T:Cake.Common.ProcessAliases">
<summary>
Contains functionality related to processes.
</summary>
</member>
<member name="M:Cake.Common.ProcessAliases.StartProcess(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Starts the process resource that is specified by the filename.
</summary>
<param name="context">The context.</param>
<param name="fileName">The file name.</param>
<returns>The exit code that the started process specified when it terminated.</returns>
<example>
<code>
var exitCodeWithoutArguments = StartProcess("ping");
// This should output 1 as argument is missing
Information("Exit code: {0}", exitCodeWithoutArguments);
</code>
</example>
</member>
<member name="M:Cake.Common.ProcessAliases.StartProcess(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,System.String)">
<summary>
Starts the process resource that is specified by the filename and arguments.
</summary>
<param name="context">The context.</param>
<param name="fileName">Name of the file.</param>
<param name="processArguments">The arguments used in the process settings.</param>
<returns>The exit code that the started process specified when it terminated.</returns>
<example>
<code>
var exitCodeWithArgument = StartProcess("ping", "localhost");
// This should output 0 as valid arguments supplied
Information("Exit code: {0}", exitCodeWithArgument);
</code>
</example>
</member>
<member name="M:Cake.Common.ProcessAliases.StartProcess(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.ProcessSettings)">
<summary>
Starts the process resource that is specified by the filename and settings.
</summary>
<param name="context">The context.</param>
<param name="fileName">Name of the file.</param>
<param name="settings">The settings.</param>
<returns>The exit code that the started process specified when it terminated.</returns>
<example>
<code>
var exitCodeWithArgument = StartProcess("ping", new ProcessSettings{ Arguments = "localhost" });
// This should output 0 as valid arguments supplied
Information("Exit code: {0}", exitCodeWithArgument);
</code>
</example>
</member>
<member name="M:Cake.Common.ProcessAliases.StartProcess(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.ProcessSettings,System.Collections.Generic.IEnumerable{System.String}@)">
<summary>
Starts the process resource that is specified by the filename and settings.
</summary>
<param name="context">The context.</param>
<param name="fileName">Name of the file.</param>
<param name="settings">The settings.</param>
<param name="redirectedStandardOutput">Returns process output if <see cref="P:Cake.Core.IO.ProcessSettings.RedirectStandardOutput"/> is true.
Otherwise <c>null</c> is returned.</param>
<returns>The exit code that the started process specified when it terminated.</returns>
<example>
<code>
IEnumerable<string> redirectedStandardOutput;
var exitCodeWithArgument =
StartProcess(
"ping",
new ProcessSettings {
Arguments = "localhost",
RedirectStandardOutput = true
},
out redirectedStandardOutput
);
// Output last line of process output.
Information("Last line of output: {0}", redirectedStandardOutput.LastOrDefault());
// This should output 0 as valid arguments supplied
Information("Exit code: {0}", exitCodeWithArgument);
</code>
</example>
</member>
<member name="M:Cake.Common.ProcessAliases.StartProcess(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.ProcessSettings,System.Collections.Generic.IEnumerable{System.String}@,System.Collections.Generic.IEnumerable{System.String}@)">
<summary>
Starts the process resource that is specified by the filename and settings.
</summary>
<param name="context">The context.</param>
<param name="fileName">Name of the file.</param>
<param name="settings">The settings.</param>
<param name="redirectedStandardOutput">Returns process output if <see cref="P:Cake.Core.IO.ProcessSettings.RedirectStandardOutput"/> is true.
Otherwise <c>null</c> is returned.</param>
<param name="redirectedErrorOutput">Returns process error output if <see cref="P:Cake.Core.IO.ProcessSettings.RedirectStandardError"/> is true.
Otherwise <c>null</c> is returned.</param>
<returns>The exit code that the started process specified when it terminated.</returns>
<example>
<code>
IEnumerable<string> redirectedStandardOutput;
IEnumerable<string> redirectedErrorOutput;
var exitCodeWithArgument =
StartProcess(
"ping",
new ProcessSettings {
Arguments = "localhost",
RedirectStandardOutput = true,
RedirectStandardError = true
},
out redirectedStandardOutput,
out redirectedErrorOutput
);
// Output last line of process output.
Information("Last line of output: {0}", redirectedStandardOutput.LastOrDefault());
// Throw exception if anything was written to the standard error.
if (redirectedErrorOutput.Any())
{
throw new Exception(
string.Format(
"Errors occurred: {0}",
string.Join(", ", redirectedErrorOutput)));
}
// This should output 0 as valid arguments supplied
Information("Exit code: {0}", exitCodeWithArgument);
</code>
</example>
</member>
<member name="M:Cake.Common.ProcessAliases.StartAndReturnProcess(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.ProcessSettings)">
<summary>
Starts the process resource that is specified by the filename and settings.
</summary>
<param name="context">The context.</param>
<param name="fileName">Name of the file.</param>
<param name="settings">The settings.</param>
<returns>The newly started process.</returns>
<example>
<code>
using(var process = StartAndReturnProcess("ping", new ProcessSettings{ Arguments = "localhost" }))
{
process.WaitForExit();
// This should output 0 as valid arguments supplied
Information("Exit code: {0}", process.GetExitCode());
}
</code>
</example>
<exception cref="T:System.ArgumentNullException"><paramref name="context"/>, <paramref name="fileName"/>, or <paramref name="settings"/> is null.</exception>
</member>
<member name="M:Cake.Common.ProcessAliases.StartAndReturnProcess(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Starts the process resource that is specified by the filename.
</summary>
<param name="context">The context.</param>
<param name="fileName">Name of the file.</param>
<returns>The newly started process.</returns>
<example>
<code>
using(var process = StartAndReturnProcess("ping"))
{
process.WaitForExit();
// This should output 0 as valid arguments supplied
Information("Exit code: {0}", process.GetExitCode());
}
</code>
</example>
<exception cref="T:System.ArgumentNullException"><paramref name="context"/>, <paramref name="fileName"/> is null.</exception>
</member>
<member name="T:Cake.Common.NamespaceDoc">
<summary>
This namespace contain types used for common operations
such as parsing release notes, retrieving arguments and
to read and write environment variables.
</summary>
</member>
<member name="T:Cake.Common.Solution.NamespaceDoc">
<summary>
This namespace contain types that
support interaction with MSBuild solution files.
</summary>
</member>
<member name="T:Cake.Common.Solution.Project.NamespaceDoc">
<summary>
This namespace contain types that
support interaction with MSBuild project files.
</summary>
</member>
<member name="T:Cake.Common.Solution.Project.Properties.NamespaceDoc">
<summary>
This namespace contain types that
enable you to read or create assembly information files.
</summary>
</member>
<member name="T:Cake.Common.Solution.Project.Properties.AssemblyInfoAliases">
<summary>
Contains functionality related to assembly info.
</summary>
</member>
<member name="M:Cake.Common.Solution.Project.Properties.AssemblyInfoAliases.CreateAssemblyInfo(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Solution.Project.Properties.AssemblyInfoSettings)">
<summary>
Creates an assembly information file.
</summary>
<param name="context">The context.</param>
<param name="outputPath">The output path.</param>
<param name="settings">The settings.</param>
<example>
<code>
var file = "./SolutionInfo.cs";
var version = "0.0.1";
var buildNo = "123";
var semVersion = string.Concat(version + "-" + buildNo);
CreateAssemblyInfo(file, new AssemblyInfoSettings {
Product = "SampleProject",
Version = version,
FileVersion = version,
InformationalVersion = semVersion,
Copyright = string.Format("Copyright (c) Contoso 2014 - {0}", DateTime.Now.Year)
});
</code>
</example>
</member>
<member name="M:Cake.Common.Solution.Project.Properties.AssemblyInfoAliases.ParseAssemblyInfo(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Parses an existing assembly information file.
</summary>
<param name="context">The context.</param>
<param name="assemblyInfoPath">The assembly info path.</param>
<returns>The content of the assembly info file.</returns>
<example>
<code>
var assemblyInfo = ParseAssemblyInfo("./SolutionInfo.cs");
Information("Version: {0}", assemblyInfo.AssemblyVersion);
Information("File version: {0}", assemblyInfo.AssemblyFileVersion);
Information("Informational version: {0}", assemblyInfo.AssemblyInformationalVersion);
</code>
</example>
</member>
<member name="T:Cake.Common.Solution.Project.Properties.AssemblyInfoCreator">
<summary>
The assembly info creator.
</summary>
</member>
<member name="M:Cake.Common.Solution.Project.Properties.AssemblyInfoCreator.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Solution.Project.Properties.AssemblyInfoCreator"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="log">The log.</param>
</member>
<member name="M:Cake.Common.Solution.Project.Properties.AssemblyInfoCreator.Create(Cake.Core.IO.FilePath,Cake.Common.Solution.Project.Properties.AssemblyInfoSettings,System.String,System.String,System.String,System.String,System.String,System.String)">
<summary>
Creates an assembly info file.
</summary>
<param name="outputPath">The output path.</param>
<param name="settings">The settings.</param>
<param name="attributeFormat">The attribute format.</param>
<param name="attributeWithValueFormat">The attribute with value format.</param>
<param name="attributeWithKeyValueFormat">The attribute with key value format.</param>
<param name="vbAttributeFormat">The VB attribute format.</param>
<param name="vbAttributeWithValueFormat">The VB attribute with value format.</param>
<param name="vbAttributeWithKeyValueFormat">The VB attribute with key value format.</param>
</member>
<member name="T:Cake.Common.Solution.Project.Properties.AssemblyInfoCustomAttribute">
<summary>
Custom Attribute class used by <see cref="T:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings"/>.
</summary>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoCustomAttribute.Name">
<summary>
Gets or sets the name.
</summary>
<value>The attribute name.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoCustomAttribute.NameSpace">
<summary>
Gets or sets the namespace.
</summary>
<value>The namespace for the attribute.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoCustomAttribute.Value">
<summary>
Gets or sets the value.
</summary>
<value>The value for the attribute.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoCustomAttribute.UseRawValue">
<summary>
Gets or sets a value indicating whether the value is raw or should be quoted in the created attribute.
</summary>
<value>
<c>true</c> if should be treated as raw; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Solution.Project.Properties.AssemblyInfoMetadataAttribute">
<summary>
Metadata Attribute class used by <see cref="T:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings"/>.
</summary>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoMetadataAttribute.Name">
<summary>
Gets the name.
</summary>
<value>The attribute name.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoMetadataAttribute.Key">
<summary>
Gets or sets the key for meta data.
</summary>
<value>The key for meta data.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoMetadataAttribute.NameSpace">
<summary>
Gets the namespace.
</summary>
<value>The namespace for the meta data attribute.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoMetadataAttribute.Value">
<summary>
Gets or sets the value.
</summary>
<value>The value for the meta data.</value>
</member>
<member name="T:Cake.Common.Solution.Project.Properties.AssemblyInfoParser">
<summary>
The assembly info parser.
</summary>
</member>
<member name="M:Cake.Common.Solution.Project.Properties.AssemblyInfoParser.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Solution.Project.Properties.AssemblyInfoParser"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Solution.Project.Properties.AssemblyInfoParser.Parse(Cake.Core.IO.FilePath)">
<summary>
Parses information from an assembly info file.
</summary>
<param name="assemblyInfoPath">The file path.</param>
<returns>Information about the assembly info content.</returns>
</member>
<member name="T:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult">
<summary>
Represents the content in an assembly info file.
</summary>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.ClsCompliant">
<summary>
Gets a value indicating whether the assembly is CLS compliant.
</summary>
<value>
<c>true</c> if the assembly is CLS compliant; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.Company">
<summary>
Gets the assembly company attribute.
</summary>
<value>The assembly company attribute.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.ComVisible">
<summary>
Gets a value indicating whether the assembly is accessible from COM.
</summary>
<value>
<c>true</c> if the assembly is accessible from COM; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.Configuration">
<summary>
Gets the assembly configuration attribute.
</summary>
<value>The assembly Configuration attribute.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.Copyright">
<summary>
Gets the assembly copyright attribute.
</summary>
<value>The assembly copyright attribute.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.Description">
<summary>
Gets the assembly's description attribute.
</summary>
<value>The assembly's Description attribute.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.AssemblyFileVersion">
<summary>
Gets the assembly file version.
</summary>
<value>The assembly file version.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.Guid">
<summary>
Gets the assembly GUID attribute.
</summary>
<value>The assembly GUID attribute.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.AssemblyInformationalVersion">
<summary>
Gets the assembly informational version.
</summary>
<value>The assembly informational version.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.Product">
<summary>
Gets the assembly product Attribute.
</summary>
<value>The assembly product attribute.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.Title">
<summary>
Gets the assembly title Attribute.
</summary>
<value>The assembly Title attribute.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.Trademark">
<summary>
Gets the assembly trademark Attribute.
</summary>
<value>The assembly Trademark attribute.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.AssemblyVersion">
<summary>
Gets the assembly version.
</summary>
<value>The assembly version.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.InternalsVisibleTo">
<summary>
Gets the assemblies that internals are visible to.
</summary>
<value>The assemblies that internals are visible to.</value>
</member>
<member name="M:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.#ctor(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult"/> class.
</summary>
<param name="clsCompliant">Whether the assembly is CLS compliant.</param>
<param name="company">The assembly company attribute.</param>
<param name="comVisible">Whether the assembly is accessible from COM.</param>
<param name="configuration">The assembly configuration attribute.</param>
<param name="copyright">The assembly copyright attribute.</param>
<param name="description">The assembly description attribute.</param>
<param name="assemblyFileVersion">The assembly file version.</param>
<param name="guid">The assembly GUID attribute.</param>
<param name="assemblyInformationalVersion">The assembly informational version.</param>
<param name="product">The assembly product attribute.</param>
<param name="title">The assembly title attribute.</param>
<param name="trademark">The assembly trademark attribute.</param>
<param name="assemblyVersion">The assembly version.</param>
<param name="internalsVisibleTo">The assemblies that internals are visible to.</param>
</member>
<member name="T:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Solution.Project.Properties.AssemblyInfoCreator"/>.
</summary>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.Title">
<summary>
Gets or sets the title.
</summary>
<value>The assembly title.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.Description">
<summary>
Gets or sets the description.
</summary>
<value>The assembly description.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.Guid">
<summary>
Gets or sets the unique identifier.
</summary>
<value>The unique identifier.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.Product">
<summary>
Gets or sets the product.
</summary>
<value>The assembly product.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.Copyright">
<summary>
Gets or sets the copyright.
</summary>
<value>The copyright.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.Trademark">
<summary>
Gets or sets the trademark.
</summary>
<value>The trademark.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.Version">
<summary>
Gets or sets the version.
</summary>
<value>The version.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.FileVersion">
<summary>
Gets or sets the file version.
</summary>
<value>The file version.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.InformationalVersion">
<summary>
Gets or sets the informational version.
</summary>
<value>The informational version.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.ComVisible">
<summary>
Gets or sets whether or not the assembly is COM visible.
</summary>
<value>Whether or not the assembly is COM visible.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.CLSCompliant">
<summary>
Gets or sets whether or not the assembly is CLS compliant.
</summary>
<value>Whether or not the assembly is CLS compliant.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.Company">
<summary>
Gets or sets the company.
</summary>
<value>The company.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.InternalsVisibleTo">
<summary>
Gets or sets the name(s) of the assembly(s) that internals should be visible to.
</summary>
<value>The name(s) of the assembly(s).</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.Configuration">
<summary>
Gets or sets the configuration of the assembly.
</summary>
<value>The configuration.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.CustomAttributes">
<summary>
Gets or sets the custom attribute(s) that should be added to the assembly info file.
</summary>
<value>The namespace(s).</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.MetaDataAttributes">
<summary>
Gets or sets the meta data attribute(s) that should be added to the assembly info file.
</summary>
<value>The meta data.</value>
</member>
<member name="T:Cake.Common.Solution.Project.Properties.AssemblyInfoSettingsExtensions">
<summary>
Contains functionality related to AssemblyInfo settings.
</summary>
</member>
<member name="M:Cake.Common.Solution.Project.Properties.AssemblyInfoSettingsExtensions.AddCustomAttribute(Cake.Common.Solution.Project.Properties.AssemblyInfoSettings,System.String,System.String,System.String)">
<summary>
Adds a custom attribute to the AssemblyInfo settings.
</summary>
<param name="settings">The settings.</param>
<param name="name">The name of the custom attribute.</param>
<param name="namespace">The namespace for the custom attribute.</param>
<param name="value">The value for the attribute.</param>
<returns>The same <see cref="T:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Solution.Project.Properties.AssemblyInfoSettingsExtensions.AddMetadataAttribute(Cake.Common.Solution.Project.Properties.AssemblyInfoSettings,System.String,System.String)">
<summary>
Adds a meta data attribute to the AssemblyInfo settings.
</summary>
<param name="settings">The settings.</param>
<param name="key">The key of the meta data attribute.</param>
<param name="value">The value for the attribute.</param>
<returns>The same <see cref="T:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Common.Solution.Project.XmlDoc.NamespaceDoc">
<summary>
This namespace contain types that
enable you to read XML documentation comments.
</summary>
</member>
<member name="T:Cake.Common.Solution.Project.XmlDoc.XmlDocAliases">
<summary>
Contains functionality related to MSBuild XML document files.
</summary>
</member>
<member name="M:Cake.Common.Solution.Project.XmlDoc.XmlDocAliases.ParseXmlDocExampleCode(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Parses Xml documentation example code from given path.
</summary>
<param name="context">The context.</param>
<param name="xmlFilePath">The Path to the file to parse.</param>
<returns>Parsed example code.</returns>
<example>
<code>
var exampleCodes = ParseXmlDocExampleCode("./Cake.Common.xml");
foreach(var exampleCode in exampleCodes)
{
Information(
"{0}\r\n{1}",
exampleCode.Name,
exampleCode.Code
);
}
</code>
</example>
</member>
<member name="M:Cake.Common.Solution.Project.XmlDoc.XmlDocAliases.ParseXmlDocFilesExampleCode(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Parses Xml documentation example code from file(s) using given pattern.
</summary>
<param name="context">The context.</param>
<param name="pattern">The globber file pattern.</param>
<returns>Parsed example code.</returns>
<example>
<code>
var filesExampleCodes = ParseXmlDocFilesExampleCode("./Cake.*.xml");
foreach(var exampleCode in filesExampleCodes)
{
Information(
"{0}\r\n{1}",
exampleCode.Name,
exampleCode.Code
);
}
</code>
</example>
</member>
<member name="T:Cake.Common.Solution.Project.XmlDoc.XmlDocExampleCode">
<summary>
Parsed Xml documentation example code.
</summary>
</member>
<member name="P:Cake.Common.Solution.Project.XmlDoc.XmlDocExampleCode.Name">
<summary>
Gets Example code parent name.
</summary>
</member>
<member name="P:Cake.Common.Solution.Project.XmlDoc.XmlDocExampleCode.Code">
<summary>
Gets Example code.
</summary>
</member>
<member name="M:Cake.Common.Solution.Project.XmlDoc.XmlDocExampleCode.#ctor(System.String,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Solution.Project.XmlDoc.XmlDocExampleCode"/> class.
</summary>
<param name="name">The name of code parent.</param>
<param name="code">The example code.</param>
</member>
<member name="T:Cake.Common.Solution.Project.XmlDoc.XmlDocExampleCodeParser">
<summary>
The MSBuild Xml documentation example code parser.
</summary>
</member>
<member name="M:Cake.Common.Solution.Project.XmlDoc.XmlDocExampleCodeParser.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.IO.IGlobber,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Solution.Project.XmlDoc.XmlDocExampleCodeParser"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="globber">The globber.</param>
<param name="log">The log.</param>
</member>
<member name="M:Cake.Common.Solution.Project.XmlDoc.XmlDocExampleCodeParser.Parse(Cake.Core.IO.FilePath)">
<summary>
Parses Xml documentation example code from given path.
</summary>
<param name="xmlFilePath">Path to the file to parse.</param>
<returns>Parsed Example Code.</returns>
</member>
<member name="M:Cake.Common.Solution.Project.XmlDoc.XmlDocExampleCodeParser.ParseFiles(Cake.Core.IO.GlobPattern)">
<summary>
Parses Xml documentation example code from file(s) using given pattern.
</summary>
<param name="pattern">The globber file pattern.</param>
<returns>Parsed Example Code.</returns>
</member>
<member name="T:Cake.Common.Solution.Project.ProjectAliases">
<summary>
Contains functionality related to MSBuild project files.
</summary>
</member>
<member name="M:Cake.Common.Solution.Project.ProjectAliases.ParseProject(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Parses project information from project file.
</summary>
<param name="context">The context.</param>
<param name="projectPath">The project file path.</param>
<returns>A parsed project.</returns>
<example>
<code>
var parsedProject = ParseProject("./src/Cake/Cake.csproj");
Information(
@" Parsed project file:
Configuration : {0}
Platform : {1}
OutputType : {2}
OutputPath : {3}
RootNameSpace : {4}
AssemblyName : {5}
TargetFrameworkVersion: {6}
Files : {7}",
parsedProject.Configuration,
parsedProject.Platform,
parsedProject.OutputType,
parsedProject.OutputPath,
parsedProject.RootNameSpace,
parsedProject.AssemblyName,
parsedProject.TargetFrameworkVersion,
string.Concat(
parsedProject
.Files
.Select(
file=> string.Format(
"\r\n {0}",
file.FilePath
)
)
)
);
</code>
</example>
</member>
<member name="T:Cake.Common.Solution.Project.ProjectAssemblyReference">
<summary>
Represents a project assembly reference.
</summary>
<remarks>
Schema from https://msdn.microsoft.com/en-us/library/ms164283.aspx
and https://msdn.microsoft.com/en-us/library/bb629388.aspx.
</remarks>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectAssemblyReference.Include">
<summary>
Gets or sets the reference to include.
</summary>
<value>
The reference to include.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectAssemblyReference.HintPath">
<summary>
Gets or sets the relative or absolute path of the assembly.
</summary>
<value>
The relative or absolute path of the assembly.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectAssemblyReference.Name">
<summary>
Gets or sets the display name of the assembly.
</summary>
<value>
The display name of the assembly.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectAssemblyReference.FusionName">
<summary>
Gets or sets the simple or strong fusion name for the item.
</summary>
<value>
The simple or strong fusion name for the item.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectAssemblyReference.SpecificVersion">
<summary>
Gets or sets whether only the version in the fusion name should be referenced.
</summary>
<value>
Whether only the version in the fusion name should be referenced.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectAssemblyReference.Aliases">
<summary>
Gets or sets any aliases for the reference.
</summary>
<value>
Any aliases for the reference.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectAssemblyReference.Private">
<summary>
Gets or sets whether the reference should be copied to the output folder.
</summary>
<value>
Whether the reference should be copied to the output folder.
</value>
</member>
<member name="T:Cake.Common.Solution.Project.ProjectFile">
<summary>
Represents a MSBuild project file.
</summary>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectFile.FilePath">
<summary>
Gets or sets the project file path.
</summary>
<value>The project file path.</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectFile.RelativePath">
<summary>
Gets or sets the relative path to the project file.
</summary>
<value>
The relative path to the project file.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectFile.Compile">
<summary>
Gets or sets a value indicating whether this <see cref="T:Cake.Common.Solution.Project.ProjectFile"/> is compiled.
</summary>
<value>
<c>true</c> if compiled; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Solution.Project.ProjectParser">
<summary>
The MSBuild project file parser.
</summary>
</member>
<member name="M:Cake.Common.Solution.Project.ProjectParser.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Solution.Project.ProjectParser"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Solution.Project.ProjectParser.Parse(Cake.Core.IO.FilePath)">
<summary>
Parses a project file.
</summary>
<param name="projectPath">The project path.</param>
<returns>The parsed project.</returns>
</member>
<member name="T:Cake.Common.Solution.Project.ProjectParserResult">
<summary>
Represents the content in an MSBuild project file.
</summary>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.Configuration">
<summary>
Gets the build configuration.
</summary>
<value>The build configuration.</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.Platform">
<summary>
Gets the target platform.
</summary>
<value>The platform.</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.ProjectGuid">
<summary>
Gets the unique project identifier.
</summary>
<value>The unique project identifier.</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.OutputType">
<summary>
Gets the compiler output type, i.e. <c>Exe/Library</c>.
</summary>
<value>The output type.</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.OutputPath">
<summary>
Gets the compiler output path.
</summary>
<value>The output path.</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.RootNameSpace">
<summary>
Gets the default root namespace.
</summary>
<value>The root namespace.</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.AssemblyName">
<summary>
Gets the build target assembly name.
</summary>
<value>The assembly name.</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.TargetFrameworkVersion">
<summary>
Gets the compiler target framework version.
</summary>
<value>The target framework version.</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.TargetFrameworkProfile">
<summary>
Gets the compiler target framework profile.
</summary>
<value>The target framework profile.</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.Files">
<summary>
Gets the project content files.
</summary>
<value>The files.</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.References">
<summary>
Gets the references.
</summary>
<value>
The references.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.ProjectReferences">
<summary>
Gets the references to other projects.
</summary>
<value>
The references.
</value>
</member>
<member name="M:Cake.Common.Solution.Project.ProjectParserResult.#ctor(System.String,System.String,System.String,System.String,Cake.Core.IO.DirectoryPath,System.String,System.String,System.String,System.String,System.Collections.Generic.IEnumerable{Cake.Common.Solution.Project.ProjectFile},System.Collections.Generic.IEnumerable{Cake.Common.Solution.Project.ProjectAssemblyReference},System.Collections.Generic.IEnumerable{Cake.Common.Solution.Project.ProjectReference})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Solution.Project.ProjectParserResult" /> class.
</summary>
<param name="configuration">The build configuration.</param>
<param name="platform">The target platform.</param>
<param name="projectGuid">The unique project identifier.</param>
<param name="outputType">The compiler output type.</param>
<param name="outputPath">The compiler output path.</param>
<param name="rootNameSpace">The default root namespace.</param>
<param name="assemblyName">Gets the build target assembly name.</param>
<param name="targetFrameworkVersion">The compiler framework version.</param>
<param name="targetFrameworkProfile">The compiler framework profile.</param>
<param name="files">The project content files.</param>
<param name="references">The references.</param>
<param name="projectReferences">The references to other projects.</param>
</member>
<member name="T:Cake.Common.Solution.Project.ProjectReference">
<summary>
Represents a project reference to another project.
</summary>
<remarks>
Schema from https://msdn.microsoft.com/en-us/library/ms164283.aspx
and https://msdn.microsoft.com/en-us/library/bb629388.aspx.
</remarks>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectReference.FilePath">
<summary>
Gets or sets the path to the referenced project file.
</summary>
<value>
The path to the referenced project file.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectReference.RelativePath">
<summary>
Gets or sets the relative path to the referenced project file.
</summary>
<value>
The relative path to the referenced project file.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectReference.Name">
<summary>
Gets or sets the display name of the reference.
</summary>
<value>
The display name of the reference.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectReference.Project">
<summary>
Gets or sets a GUID for the reference.
</summary>
<value>
A GUID for the reference.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectReference.Package">
<summary>
Gets or sets the path of the project file that is being referenced.
</summary>
<value>
The path of the project file that is being referenced.
</value>
</member>
<member name="T:Cake.Common.Solution.Project.ProjectXElement">
<summary>
MSBuild Project Xml Element XNames.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.Project">
<summary>
Project root element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.ItemGroup">
<summary>
Item group element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.Reference">
<summary>
Assembly reference element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.Import">
<summary>
Namespace import element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.Compile">
<summary>
Namespace compile element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.PropertyGroup">
<summary>
Namespace property group element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.RootNamespace">
<summary>
Namespace root namespace element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.OutputType">
<summary>
Namespace output type element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.OutputPath">
<summary>
Namespace output path element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.AssemblyName">
<summary>
Namespace assembly name element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.TargetFrameworkVersion">
<summary>
Gets the namespace for the target framework version element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.TargetFrameworkProfile">
<summary>
Gets the namespace for the target framework version element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.Configuration">
<summary>
Gets the namespace for the configuration element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.Platform">
<summary>
Gets the namespace for the platform element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.ProjectGuid">
<summary>
Gets the namespace for the project GUID.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.BootstrapperPackage">
<summary>
Gets the namespace for the bootstrapper package element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.ProjectReference">
<summary>
Gets the namespace for the project reference element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.Service">
<summary>
Gets the namespace for the service element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.HintPath">
<summary>
Gets the namespace for the hint path element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.Name">
<summary>
Gets the namespace for the name element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.FusionName">
<summary>
Gets the namespace for the fusion name element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.SpecificVersion">
<summary>
Gets the namespace for the specific version element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.Aliases">
<summary>
Gets the namespace for the aliases element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.Private">
<summary>
Gets the namespace for the private element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.Package">
<summary>
Gets the namespace for the package element.
</summary>
</member>
<member name="T:Cake.Common.Solution.SolutionAliases">
<summary>
Contains functionality related to MSBuild solution files.
</summary>
</member>
<member name="M:Cake.Common.Solution.SolutionAliases.ParseSolution(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Parses project information from a solution file.
</summary>
<param name="context">The context.</param>
<param name="solutionPath">The solution path.</param>
<returns>A parsed solution.</returns>
<example>
<code>
var solutionPath = "./src/Cake.sln";
Information("Parsing {0}", solutionPath);
var parsedSolution = ParseSolution(solutionPath);
foreach(var project in parsedSolution.Projects)
{
Information(
@"Solution project file:
Name: {0}
Path: {1}
Id : {2}
Type: {3}",
project.Name,
project.Path,
project.Id,
project.Type
);
}
</code>
</example>
</member>
<member name="T:Cake.Common.Solution.SolutionFolder">
<summary>
Represents a folder in a MSBuild solution.
</summary>
</member>
<member name="F:Cake.Common.Solution.SolutionFolder.TypeIdentifier">
<summary>
Visual Studio project type guid for solution folder.
</summary>
<remarks>
More information can be found http://www.codeproject.com/Reference/720512/List-of-Visual-Studio-Project-Type-GUIDs.
</remarks>
</member>
<member name="P:Cake.Common.Solution.SolutionFolder.Items">
<summary>
Gets Child items of this folder.
</summary>
</member>
<member name="M:Cake.Common.Solution.SolutionFolder.#ctor(System.String,System.String,Cake.Core.IO.FilePath)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Solution.SolutionFolder"/> class.
</summary>
<param name="id">The folder project identity.</param>
<param name="name">The folder name.</param>
<param name="path">The folder path.</param>
</member>
<member name="T:Cake.Common.Solution.SolutionParser">
<summary>
The MSBuild solution file parser.
</summary>
</member>
<member name="M:Cake.Common.Solution.SolutionParser.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Solution.SolutionParser"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Solution.SolutionParser.Parse(Cake.Core.IO.FilePath)">
<summary>
Parses a MSBuild solution.
</summary>
<param name="solutionPath">The solution path.</param>
<returns>A parsed solution.</returns>
</member>
<member name="T:Cake.Common.Solution.SolutionParserResult">
<summary>
Represents the content in an MSBuild solution file.
</summary>
</member>
<member name="P:Cake.Common.Solution.SolutionParserResult.Version">
<summary>
Gets the file format version.
</summary>
</member>
<member name="P:Cake.Common.Solution.SolutionParserResult.VisualStudioVersion">
<summary>
Gets the version of Visual Studio that created the file.
</summary>
</member>
<member name="P:Cake.Common.Solution.SolutionParserResult.MinimumVisualStudioVersion">
<summary>
Gets the minimum supported version of Visual Studio.
</summary>
</member>
<member name="P:Cake.Common.Solution.SolutionParserResult.Projects">
<summary>
Gets all solution projects.
</summary>
</member>
<member name="M:Cake.Common.Solution.SolutionParserResult.#ctor(System.String,System.String,System.String,System.Collections.Generic.IReadOnlyCollection{Cake.Common.Solution.SolutionProject})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Solution.SolutionParserResult"/> class.
</summary>
<param name="version">The file format version.</param>
<param name="visualStudioVersion">The version of Visual Studio that created the file.</param>
<param name="minimumVisualStudioVersion">The minimum supported version of Visual Studio.</param>
<param name="projects">The solution projects.</param>
</member>
<member name="T:Cake.Common.Solution.SolutionProject">
<summary>
Represents a project in a MSBuild solution.
</summary>
</member>
<member name="P:Cake.Common.Solution.SolutionProject.Id">
<summary>
Gets the project identity.
</summary>
</member>
<member name="P:Cake.Common.Solution.SolutionProject.Name">
<summary>
Gets the project name.
</summary>
</member>
<member name="P:Cake.Common.Solution.SolutionProject.Path">
<summary>
Gets the project path.
</summary>
</member>
<member name="P:Cake.Common.Solution.SolutionProject.Type">
<summary>
Gets the project type identity.
</summary>
</member>
<member name="P:Cake.Common.Solution.SolutionProject.Parent">
<summary>
Gets the parent project if any, otherwise null.
</summary>
</member>
<member name="M:Cake.Common.Solution.SolutionProject.#ctor(System.String,System.String,Cake.Core.IO.FilePath,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Solution.SolutionProject"/> class.
</summary>
<param name="id">The project identity.</param>
<param name="name">The project name.</param>
<param name="path">The project path.</param>
<param name="type">The project type identity.</param>
</member>
<member name="T:Cake.Common.Text.NamespaceDoc">
<summary>
This namespace contain types for
text templating and transformations.
</summary>
</member>
<member name="T:Cake.Common.Text.TextTransformation`1">
<summary>
Provides functionality to perform simple text transformations
from a Cake build script and save them to disc.
</summary>
<typeparam name="TTemplate">The text transformation template.</typeparam>
</member>
<member name="P:Cake.Common.Text.TextTransformation`1.Template">
<summary>
Gets the text transformation template.
</summary>
<value>The text transformation template.</value>
</member>
<member name="M:Cake.Common.Text.TextTransformation`1.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,`0)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Text.TextTransformation`1"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="template">The text template.</param>
</member>
<member name="M:Cake.Common.Text.TextTransformation`1.Save(Cake.Core.IO.FilePath)">
<summary>
Saves the text transformation to a file.
</summary>
<param name="path">The <see cref="T:Cake.Core.IO.FilePath"/> to save the text transformation to.</param>
</member>
<member name="M:Cake.Common.Text.TextTransformation`1.Save(Cake.Core.IO.FilePath,System.Text.Encoding)">
<summary>
Saves the text transformation to a file.
</summary>
<param name="path">The <see cref="T:Cake.Core.IO.FilePath"/> to save the text transformation to.</param>
<param name="encoding">The text encoding.</param>
</member>
<member name="M:Cake.Common.Text.TextTransformation`1.ToString">
<summary>
Returns a string containing the rendered template.
</summary>
<returns>A string containing the rendered template.</returns>
</member>
<member name="T:Cake.Common.Text.TextTransformationAliases">
<summary>
Contains functionality related to text transformation.
</summary>
</member>
<member name="M:Cake.Common.Text.TextTransformationAliases.TransformText(Cake.Core.ICakeContext,System.String)">
<summary>
Creates a text transformation from the provided template.
</summary>
<param name="context">The context.</param>
<param name="template">The template.</param>
<returns>A <see cref="T:Cake.Common.Text.TextTransformation`1"/> representing the provided template.</returns>
<example>
This sample shows how to create a <see cref="T:Cake.Common.Text.TextTransformation`1"/> using
the specified template.
<code>
string text = TransformText("Hello <%subject%>!")
.WithToken("subject", "world")
.ToString();
</code>
</example>
</member>
<member name="M:Cake.Common.Text.TextTransformationAliases.TransformText(Cake.Core.ICakeContext,System.String,System.String,System.String)">
<summary>
Creates a text transformation from the provided template, using the specified placeholder.
</summary>
<param name="context">The context.</param>
<param name="template">The template.</param>
<param name="leftPlaceholder">The left placeholder.</param>
<param name="rightPlaceholder">The right placeholder.</param>
<returns>A <see cref="T:Cake.Common.Text.TextTransformation`1"/> representing the provided template.</returns>
<example>
This sample shows how to create a <see cref="T:Cake.Common.Text.TextTransformation`1"/> using
the specified template and placeholder.
<code>
string text = TransformText("Hello {subject}!", "{", "}")
.WithToken("subject", "world")
.ToString();
</code>
</example>
</member>
<member name="M:Cake.Common.Text.TextTransformationAliases.TransformTextFile(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Creates a text transformation from the provided template on disc.
</summary>
<param name="context">The context.</param>
<param name="path">The template file path.</param>
<returns>A <see cref="T:Cake.Common.Text.TextTransformation`1"/> representing the provided template.</returns>
<example>
This sample shows how to create a <see cref="T:Cake.Common.Text.TextTransformation`1"/> using
the specified template file with the placeholder format <c><%key%></c>.
<code>
string text = TransformTextFile("./template.txt")
.WithToken("subject", "world")
.ToString();
</code>
</example>
</member>
<member name="M:Cake.Common.Text.TextTransformationAliases.TransformTextFile(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,System.String,System.String)">
<summary>
Creates a text transformation from the provided template on disc, using the specified placeholder.
</summary>
<param name="context">The context.</param>
<param name="path">The template file path.</param>
<param name="leftPlaceholder">The left placeholder.</param>
<param name="rightPlaceholder">The right placeholder.</param>
<returns>A <see cref="T:Cake.Common.Text.TextTransformation`1"/> representing the provided template.</returns>
<example>
This sample shows how to create a <see cref="T:Cake.Common.Text.TextTransformation`1"/> using
the specified template file and placeholder.
<code>
string text = TransformTextFile("./template.txt", "{", "}")
.WithToken("subject", "world")
.ToString();
</code>
</example>
</member>
<member name="T:Cake.Common.Text.TextTransformationExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Common.Text.TextTransformation`1"/>.
</summary>
</member>
<member name="M:Cake.Common.Text.TextTransformationExtensions.WithToken``1(Cake.Common.Text.TextTransformation{``0},System.String,System.Object)">
<summary>
Registers a key and a value to be used with the text transformation.
</summary>
<typeparam name="TTemplate">The text transformation template.</typeparam>
<param name="transformation">The text transformation.</param>
<param name="key">The key.</param>
<param name="value">The value.</param>
<returns>
The same <see cref="T:Cake.Common.Text.TextTransformation`1" /> instance so that multiple calls can be chained.
</returns>
</member>
<member name="M:Cake.Common.Text.TextTransformationExtensions.WithTokens``1(Cake.Common.Text.TextTransformation{``0},System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Object}})">
<summary>
Registers all keys and values in the enumerable for text transformation.
</summary>
<typeparam name="TTemplate">The text transformation template.</typeparam>
<param name="transformation">The text transformation.</param>
<param name="tokens">The tokens.</param>
<returns>
The same <see cref="T:Cake.Common.Text.TextTransformation`1" /> instance so that multiple calls can be chained.
</returns>
</member>
<member name="T:Cake.Common.Tools.NamespaceDoc">
<summary>
This namespace contain types used to interact
with different third party tools.
</summary>
</member>
<member name="T:Cake.Common.Tools.Cake.NamespaceDoc">
<summary>
This namespace contain types used to interact with Cake.
</summary>
</member>
<member name="T:Cake.Common.Tools.Cake.CakeAliases">
<summary>
Contains functionality related to running Cake scripts out of process.
</summary>
</member>
<member name="M:Cake.Common.Tools.Cake.CakeAliases.CakeExecuteScript(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Executes cake script out of process.
</summary>
<param name="context">The context.</param>
<param name="cakeScriptPath">The script file.</param>
<example>
<code>
CakeExecuteScript("./helloworld.cake");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Cake.CakeAliases.CakeExecuteScript(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.Cake.CakeSettings)">
<summary>
Executes cake script out of process.
</summary>
<param name="context">The context.</param>
<param name="cakeScriptPath">The script file.</param>
<param name="settings">The settings <see cref="T:Cake.Common.Tools.Cake.CakeSettings"/>.</param>
<example>
<code>
CakeExecuteScript("./helloworld.cake", new CakeSettings{ ToolPath="./Cake.exe" });
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Cake.CakeAliases.CakeExecuteExpression(Cake.Core.ICakeContext,System.String)">
<summary>
Executes Cake expression out of process.
</summary>
<param name="context">The context.</param>
<param name="cakeExpression">The cake expression.</param>
<example>
<code>
CakeExecuteExpression("Information(\"Hello {0}\", \"World\");");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Cake.CakeAliases.CakeExecuteExpression(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Cake.CakeSettings)">
<summary>
Executes Cake expression out of process.
</summary>
<param name="context">The context.</param>
<param name="cakeExpression">The cake expression.</param>
<param name="settings">The settings <see cref="T:Cake.Common.Tools.Cake.CakeSettings"/>.</param>
<example>
<code>
CakeExecuteExpression(
"Information(\"Hello {0}!\", Argument<string>(\"name\"));",
new CakeSettings {
ToolPath="./Cake.exe" ,
Arguments = new Dictionary<string, string>{{"name", "World"}}
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.Cake.CakeRunner">
<summary>
Cake out process runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.Cake.CakeRunner.#cctor">
<summary>
Initializes static members of the <see cref="T:Cake.Common.Tools.Cake.CakeRunner"/> class.
</summary>
</member>
<member name="M:Cake.Common.Tools.Cake.CakeRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IGlobber,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Cake.CakeRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="globber">The globber.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.Cake.CakeRunner.ExecuteScript(Cake.Core.IO.FilePath,Cake.Common.Tools.Cake.CakeSettings)">
<summary>
Executes supplied cake script in own process and supplied settings.
</summary>
<param name="scriptPath">Path to script to execute.</param>
<param name="settings">optional cake settings.</param>
</member>
<member name="M:Cake.Common.Tools.Cake.CakeRunner.ExecuteExpression(System.String,Cake.Common.Tools.Cake.CakeSettings)">
<summary>
Executes supplied cake code expression in own process and supplied settings.
</summary>
<param name="cakeExpression">Code expression to execute.</param>
<param name="settings">optional cake settings.</param>
</member>
<member name="M:Cake.Common.Tools.Cake.CakeRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.Cake.CakeRunner.GetToolExecutableNames">
<summary>
Gets the name of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.Cake.CakeRunner.GetAlternativeToolPaths(Cake.Common.Tools.Cake.CakeSettings)">
<summary>
Gets alternative file paths which the tool may exist in.
</summary>
<param name="settings">The settings.</param>
<returns>The default tool path.</returns>
</member>
<member name="T:Cake.Common.Tools.Cake.CakeSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Cake.CakeRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Cake.CakeSettings.Verbosity">
<summary>
Gets or sets the output verbosity.
</summary>
<value>The output verbosity.</value>
</member>
<member name="P:Cake.Common.Tools.Cake.CakeSettings.Arguments">
<summary>
Gets or sets cake additional arguments.
</summary>
<value>The properties.</value>
</member>
<member name="T:Cake.Common.Tools.ILMerge.NamespaceDoc">
<summary>
This namespace contain types used to interact with ILMerge.
</summary>
</member>
<member name="T:Cake.Common.Tools.ILMerge.ILMergeAliases">
<summary>
<para>Contains functionality related to <see href="http://research.microsoft.com/en-us/people/mbarnett/ILMerge.aspx">ILMerge</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.ILMerge.ILMergeSettings" /> class:
<code>
#tool "nuget:?package=ilmerge"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.ILMerge.ILMergeAliases.ILMerge(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Merges the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="outputFile">The output file.</param>
<param name="primaryAssembly">The primary assembly.</param>
<param name="assemblyPaths">The assembly paths.</param>
<example>
<code>
var assemblyPaths = GetFiles("./**/Cake.*.dll");
ILMerge("./MergedCake.exe", "./Cake.exe", assemblyPaths);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.ILMerge.ILMergeAliases.ILMerge(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.ILMerge.ILMergeSettings)">
<summary>
Merges the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="outputFile">The output file.</param>
<param name="primaryAssembly">The primary assembly.</param>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
<example>
<code>
var assemblyPaths = GetFiles("./**/Cake.*.dll");
ILMerge(
"./MergedCake.exe",
"./Cake.exe",
assemblyPaths,
new ILMergeSettings { Internalize = true });
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.ILMerge.ILMergeRunner">
<summary>
The ILMerge runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.ILMerge.ILMergeRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.ILMerge.ILMergeRunner" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.ILMerge.ILMergeRunner.Merge(Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.ILMerge.ILMergeSettings)">
<summary>
Merges the specified assemblies.
</summary>
<param name="outputAssemblyPath">The output assembly path.</param>
<param name="primaryAssemblyPath">The primary assembly path.</param>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.ILMerge.ILMergeRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.ILMerge.ILMergeRunner.GetToolExecutableNames">
<summary>
Gets the name of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.ILMerge.ILMergeSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.ILMerge.ILMergeRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.Internalize">
<summary>
Gets or sets a value indicating whether whether types in assemblies other
than the primary assembly should have their visibility modified to internal.
</summary>
<value>
<c>true</c> if types in assemblies other than the primary assembly should
have their visibility modified to internal; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.TargetKind">
<summary>
Gets or sets the target kind.
</summary>
<value>The target kind.</value>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.TargetPlatform">
<summary>
Gets or sets the target platform.
</summary>
<value>The target platform.</value>
</member>
<member name="M:Cake.Common.Tools.ILMerge.ILMergeSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.ILMerge.ILMergeSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.ILMerge.TargetKind">
<summary>
Represents an ILMerge target.
</summary>
</member>
<member name="F:Cake.Common.Tools.ILMerge.TargetKind.Default">
<summary>
TargetKind: <c>Default</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.ILMerge.TargetKind.Dll">
<summary>
TargetKind: <c>Dynamic Link Library</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.ILMerge.TargetKind.Exe">
<summary>
TargetKind: <c>Executable</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.ILMerge.TargetKind.WinExe">
<summary>
TargetKind: <c>Windows executable</c>
</summary>
</member>
<member name="T:Cake.Common.Tools.ILMerge.TargetPlatform">
<summary>
Represents a target platform.
</summary>
</member>
<member name="M:Cake.Common.Tools.ILMerge.TargetPlatform.#ctor(Cake.Common.Tools.ILMerge.TargetPlatformVersion)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.ILMerge.TargetPlatform"/> class.
</summary>
<param name="platform">The .NET framework target version.</param>
</member>
<member name="M:Cake.Common.Tools.ILMerge.TargetPlatform.#ctor(Cake.Common.Tools.ILMerge.TargetPlatformVersion,Cake.Core.IO.DirectoryPath)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.ILMerge.TargetPlatform"/> class.
</summary>
<param name="platform">The .NET framework target version.</param>
<param name="path">The directory where <c>mscorlib.dll</c> can be found.</param>
</member>
<member name="P:Cake.Common.Tools.ILMerge.TargetPlatform.Platform">
<summary>
Gets the .NET framework target version.
</summary>
</member>
<member name="P:Cake.Common.Tools.ILMerge.TargetPlatform.Path">
<summary>
Gets the directory where <c>mscorlib.dll</c> can be found.
</summary>
</member>
<member name="T:Cake.Common.Tools.ILMerge.TargetPlatformVersion">
<summary>
Represents the .NET Framework for the target assembly.
</summary>
</member>
<member name="F:Cake.Common.Tools.ILMerge.TargetPlatformVersion.v1">
<summary>
NET Framework v1
</summary>
</member>
<member name="F:Cake.Common.Tools.ILMerge.TargetPlatformVersion.v11">
<summary>
NET Framework v1.1
</summary>
</member>
<member name="F:Cake.Common.Tools.ILMerge.TargetPlatformVersion.v2">
<summary>
NET Framework v2
</summary>
</member>
<member name="F:Cake.Common.Tools.ILMerge.TargetPlatformVersion.v4">
<summary>
NET Framework v4
</summary>
</member>
<member name="T:Cake.Common.Tools.MSBuild.NamespaceDoc">
<summary>
This namespace contain types used to interact with MSBuild.
</summary>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildAliases">
<summary>
<para>Contains functionality related to <see href="https://msdn.microsoft.com/en-us/library/dd393574.aspx">MSBuild</see>.</para>
<para>
In order to use the commands for this alias, MSBuild will already have to be installed on the machine the Cake Script
is being executed.
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildAliases.MSBuild(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Builds the specified solution or MsBuild project file using MSBuild.
</summary>
<param name="context">The context.</param>
<param name="solution">The solution or MsBuild project file to build.</param>
<example>
<code>
MSBuild("./src/Cake.sln");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildAliases.MSBuild(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,System.Action{Cake.Common.Tools.MSBuild.MSBuildSettings})">
<summary>
Builds the specified solution or MsBuild project file using MSBuild.
</summary>
<param name="context">The context.</param>
<param name="solution">The solution or MsBuild project file to build.</param>
<param name="configurator">The settings configurator.</param>
<example>
<code>
MSBuild("./src/Cake.sln", configurator =>
configurator.SetConfiguration("Debug")
.SetVerbosity(Verbosity.Minimal)
.UseToolVersion(MSBuildToolVersion.VS2015)
.SetMSBuildPlatform(MSBuildPlatform.x86)
.SetPlatformTarget(PlatformTarget.MSIL));
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildAliases.MSBuild(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.MSBuild.MSBuildSettings)">
<summary>
Builds the specified solution or MsBuild project file using MSBuild.
</summary>
<param name="context">The context.</param>
<param name="solution">The solution or MsBuild project file to build.</param>
<param name="settings">The settings.</param>
<example>
<code>
MSBuild("./src/Cake.sln", new MSBuildSettings {
Verbosity = Verbosity.Minimal,
ToolVersion = MSBuildToolVersion.VS2015,
Configuration = "Release",
PlatformTarget = PlatformTarget.MSIL
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildBinaryLogImports">
<summary>
What files to include in the binary log.
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildBinaryLogImports.Unspecified">
<summary>Don't specify imports</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildBinaryLogImports.None">
<summary>Do not collect project and imports files</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildBinaryLogImports.Embed">
<summary>Embed in the binlog file</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildBinaryLogImports.ZipFile">
<summary>Produce a separate .ProjectImports.zip</summary>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildBinaryLogSettings">
<summary>
MSBuild binary logging settings used by <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildBinaryLogSettings.Enabled">
<summary>
Gets or sets a value indicating whether binary logging should be enabled.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildBinaryLogSettings.FileName">
<summary>
Gets or sets the output filename.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildBinaryLogSettings.Imports">
<summary>
Gets or sets what source files should be included in the log.
</summary>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildFileLogger">
<summary>
Contains settings for specifying a MSBuild file logger.
</summary>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildFileLogger.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.MSBuild.MSBuildFileLogger"/> class.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildFileLogger.PerformanceSummaryEnabled">
<summary>
Gets or sets a value indicating whether PerformanceSummary will Show the time that’s spent in tasks, targets, and projects.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildFileLogger.SummaryDisabled">
<summary>
Gets or sets a value indicating whether Summary will Show the error and warning summary at the end.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildFileLogger.MSBuildFileLoggerOutput">
<summary>
Gets or sets show ErrorsOnly, WarningsOnly, or All.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildFileLogger.HideVerboseItemAndPropertyList">
<summary>
Gets or sets a value indicating whether NoItemAndPropertyList will be set to Don't show the list of items and properties that would appear at the start of each project build if the verbosity level is set to diagnostic.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildFileLogger.ShowCommandLine">
<summary>
Gets or sets a value indicating whether ShowCommandLine. Show TaskCommandLineEvent messages.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildFileLogger.ShowTimestamp">
<summary>
Gets or sets a value indicating whether ShowTimestamp. Show the timestamp as a prefix to any message.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildFileLogger.ShowEventId">
<summary>
Gets or sets a value indicating whether ShowEventId. Show the event ID for each started event, finished event, and message.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildFileLogger.Verbosity">
<summary>
Gets or sets Verbosity. Override the /verbosity setting for this logger.
Specify the following verbosity levels: q[uiet], m[inimal], n[ormal], v[erbose] (detailed), and diag[nostic].
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildFileLogger.LogFile">
<summary>
Gets or sets LogFile. The path to the log file into which the build log is written.
An empty string will use msbuild.log.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildFileLogger.AppendToLogFile">
<summary>
Gets or sets a value indicating whether the build log is appended to the log file or overwrites it. When true, the build log is appended to the log file.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildFileLogger.Encoding">
<summary>
Gets or sets Specifies the encoding for the file (for example, UTF-8, Unicode, or ASCII).
</summary>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildFileLogger.GetParameters(Cake.Core.ICakeEnvironment)">
<summary>
Process the file logger config and return parameters as a string.
</summary>
<param name="environment">The environment.</param>
<returns>The parameters separated by semi-colons.</returns>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildFileLoggerOutput">
<summary>
The type of file logger output to generate.
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildFileLoggerOutput.All">
<summary>
Show errors and warnings.
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildFileLoggerOutput.ErrorsOnly">
<summary>
Show errors only.
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildFileLoggerOutput.WarningsOnly">
<summary>
Show warnings only.
</summary>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildLogger">
<summary>
Contains settings for specifying a MSBuild logger.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildLogger.Assembly">
<summary>
Gets or sets the assembly containing the logger. Should match the format {AssemblyName[,StrongName] | AssemblyFile}.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildLogger.Class">
<summary>
Gets or sets the class implementing the logger. Should match the format [PartialOrFullNamespace.]LoggerClassName
If the assembly contains only one logger, class does not need to be specified.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildLogger.Parameters">
<summary>
Gets or sets the parameters to be passed to the logger.
</summary>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildPlatform">
<summary>
Represents an MSBuild exe platform.
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildPlatform.Automatic">
<summary>
Will build using MSBuild version based on PlatformTarget/Host OS.
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildPlatform.x86">
<summary>
MSBuildPlatform: <c>x86</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildPlatform.x64">
<summary>
MSBuildPlatform: <c>x64</c>
</summary>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildRunner">
<summary>
The MSBuild runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.MSBuild.MSBuildRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="runner">The runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildRunner.Run(Cake.Core.IO.FilePath,Cake.Common.Tools.MSBuild.MSBuildSettings)">
<summary>
Runs MSBuild with the specified settings.
</summary>
<param name="solution">The solution or MsBuild project file to build.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildRunner.GetAlternativeToolPaths(Cake.Common.Tools.MSBuild.MSBuildSettings)">
<summary>
Gets alternative file paths which the tool may exist in.
</summary>
<param name="settings">The settings.</param>
<returns>The default tool path.</returns>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.MSBuild.MSBuildRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.Targets">
<summary>
Gets the targets.
</summary>
<value>The targets.</value>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.Properties">
<summary>
Gets the properties.
</summary>
<value>The properties.</value>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.PlatformTarget">
<summary>
Gets or sets the platform target.
</summary>
<value>The platform target.</value>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.MSBuildPlatform">
<summary>
Gets or sets the MSBuild platform.
</summary>
<value>The MSBuild platform.</value>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.ToolVersion">
<summary>
Gets or sets the tool version.
</summary>
<value>The tool version.</value>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.Configuration">
<summary>
Gets or sets the configuration.
</summary>
<value>The configuration.</value>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.MaxCpuCount">
<summary>
Gets or sets the maximum CPU count.
If this value is zero, MSBuild will use as many processes as
there are available CPUs to build the project. If not set
MSBuild compile projects in this solution one at a time.
</summary>
<value>The maximum CPU count.</value>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.NodeReuse">
<summary>
Gets or sets whether or not node reuse is used.
When you’re doing multiple builds in a row, this helps reduce your total build time,
by avoiding the start up costs of each MSBuild child node.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.DetailedSummary">
<summary>
Gets or sets whether or not detailed summary is created.
Shows detailed information at the end of the build
about the configurations built and how they were
scheduled to nodes.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.NoConsoleLogger">
<summary>
Gets or sets whether or not information is logged to the console.
Disable the default console logger and do not log events
to the console.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.NoLogo">
<summary>
Gets or sets a value indicating whether to show copyright information at the start of the program.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.Version">
<summary>
Gets or sets the default value of all the version numbers embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.VersionPrefix">
<summary>
Gets or sets the base version number embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.VersionSuffix">
<summary>
Gets or sets the pre-release label of the version number embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.FileVersion">
<summary>
Gets or sets the file version number embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.AssemblyVersion">
<summary>
Gets or sets the assembly version number embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.InformationalVersion">
<summary>
Gets or sets the assembly informational version number embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.PackageVersion">
<summary>
Gets or sets the version number of the NuGet package generated.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.PackageReleaseNotes">
<summary>
Gets or sets the release notes of the NuGet package generated.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.ContinuousIntegrationBuild">
<summary>
Gets or sets a value indicating whether to normalize stored file paths used when producing deterministic builds.
</summary>
<remarks>
For more information see https://devblogs.microsoft.com/dotnet/producing-packages-with-source-link/#deterministic-builds.
</remarks>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.NoImplicitTarget">
<summary>
Gets or sets a value indicating whether implicit target should be passed to MSBuild.
If set to true, no targets will be specified.
If set to false, and no targets specified, Build target will be passed by default.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.Verbosity">
<summary>
Gets or sets the amount of information to display in the build log.
Each logger displays events based on the verbosity level that you set for that logger.
</summary>
<value>The build log verbosity.</value>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.IncludeSymbols">
<summary>
Gets or sets a value indicating whether a symbol package should be created.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.SymbolPackageFormat">
<summary>
Gets or sets the symbol package format.
</summary>
<value>The symbol package format.</value>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.Loggers">
<summary>
Gets the loggers.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.FileLoggers">
<summary>
Gets the file loggers.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.BinaryLogger">
<summary>
Gets or sets the binary logging options.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.WarningsAsError">
<summary>
Gets or sets a value indicating whether warnings should be treated as errors.
Treats all warnings as errors unless <see cref="P:Cake.Common.Tools.MSBuild.MSBuildSettings.WarningsAsErrorCodes"/> has specific codes specified.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.WarningsAsErrorCodes">
<summary>
Gets the warning codes to treat as errors.
If any specified <seealso cref="P:Cake.Common.Tools.MSBuild.MSBuildSettings.WarningsAsError"/> will implicitly be treated as true.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.WarningsAsMessageCodes">
<summary>
Gets the warning codes to NOT treat as errors.
</summary>
<remarks>Only available MSBuild version 15 (VS2017) and newer.</remarks>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.Restore">
<summary>
Gets or sets a value indicating whether the Restore target should be run before any other targets.
This setting will pass the /restore option down to MSBuild.
Use this setting when working with the new csproj format.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.RestoreLockedMode">
<summary>
Gets or sets a value indicating whether or not to lock the package dependency graph while
restoring, using the packages.lock.json file.
This setting is available with at least Visual Studio 2017 version 15.9 and above or NET SDK version 2.1.500 and above.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.ConsoleLoggerParameters">
<summary>
Gets the console logger parameters.
</summary>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions">
<summary>
Contains functionality related to MSBuild settings.
</summary>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.WithTarget(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Adds a MSBuild target to the configuration.
</summary>
<param name="settings">The settings.</param>
<param name="target">The MSBuild target.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.UseToolVersion(Cake.Common.Tools.MSBuild.MSBuildSettings,Cake.Common.Tools.MSBuild.MSBuildToolVersion)">
<summary>
Sets the tool version.
</summary>
<param name="settings">The settings.</param>
<param name="version">The version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.UseToolVersion(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the tool version.
</summary>
<param name="settings">The settings.</param>
<param name="version">The string version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.GetMSBuildToolVersionFromString(System.String)">
<summary>
Helper that gets the MSBuildToolVersion from the version string.
</summary>
<param name="version">The string version.</param>
<returns>The matched MSBuildToolVersion enum <see cref="T:Cake.Common.Tools.MSBuild.MSBuildToolVersion"/>.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetPlatformTarget(Cake.Common.Tools.MSBuild.MSBuildSettings,Cake.Common.Tools.MSBuild.PlatformTarget)">
<summary>
Sets the platform target.
</summary>
<param name="settings">The settings.</param>
<param name="target">The target.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetPlatformTarget(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the platform target.
</summary>
<param name="settings">The settings.</param>
<param name="target">The target.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetMSBuildPlatform(Cake.Common.Tools.MSBuild.MSBuildSettings,Cake.Common.Tools.MSBuild.MSBuildPlatform)">
<summary>
Sets the MSBuild platform.
</summary>
<param name="settings">The settings.</param>
<param name="platform">The platform.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.WithProperty(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String,System.String[])">
<summary>
Adds a property to the configuration.
</summary>
<param name="settings">The settings.</param>
<param name="name">The property name.</param>
<param name="values">The property values.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetConfiguration(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the configuration.
</summary>
<param name="settings">The settings.</param>
<param name="configuration">The configuration.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetMaxCpuCount(Cake.Common.Tools.MSBuild.MSBuildSettings,System.Nullable{System.Int32})">
<summary>
Sets the maximum CPU count. Without this set MSBuild will compile projects in this solution one at a time.
</summary>
<param name="settings">The settings.</param>
<param name="maxCpuCount">The maximum CPU count. Set this value to zero to use as many MSBuild processes as available CPUs.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetNodeReuse(Cake.Common.Tools.MSBuild.MSBuildSettings,System.Boolean)">
<summary>
Sets whether or not node reuse should be enabled.
</summary>
<param name="settings">The settings.</param>
<param name="reuse"><c>true</c> if node reuse should be enabled; otherwise <c>false</c>.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetDetailedSummary(Cake.Common.Tools.MSBuild.MSBuildSettings,System.Boolean)">
<summary>
Sets whether or not detailed summary should be enabled.
</summary>
<param name="settings">The settings.</param>
<param name="detailedSummary"><c>true</c> if detailed summary should be enabled; otherwise <c>false</c>.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetNoConsoleLogger(Cake.Common.Tools.MSBuild.MSBuildSettings,System.Boolean)">
<summary>
Sets whether or not no console logging should be enabled.
</summary>
<param name="settings">The settings.</param>
<param name="noConsoleLog"><c>true</c> if no console log should be enabled; otherwise <c>false</c>.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetNoLogo(Cake.Common.Tools.MSBuild.MSBuildSettings,System.Boolean)">
<summary>
Sets whether or not copyright information at the start of the program should be shown.
</summary>
<param name="settings">The settings.</param>
<param name="noLogo"><c>true</c> if no copyright information at the start of the program should be shown; otherwise <c>false</c>.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetVersion(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the version.
</summary>
<param name="settings">The settings.</param>
<param name="version">The version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
<remarks>
Version will override VersionPrefix and VersionSuffix if set.
This may also override version settings during packaging.
</remarks>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetVersionPrefix(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the version prefix.
</summary>
<param name="settings">The settings.</param>
<param name="versionPrefix">The version prefix.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetVersionSuffix(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the version suffix.
</summary>
<param name="settings">The settings.</param>
<param name="versionSuffix">The version suffix.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetFileVersion(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the file version.
</summary>
<param name="settings">The settings.</param>
<param name="fileVersion">The file version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetAssemblyVersion(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the assembly version.
</summary>
<param name="settings">The settings.</param>
<param name="assemblyVersion">The assembly version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetInformationalVersion(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the informational version.
</summary>
<param name="settings">The settings.</param>
<param name="informationalVersion">The informational version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetPackageVersion(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the package version.
</summary>
<param name="settings">The settings.</param>
<param name="packageVersion">The package version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetPackageReleaseNotes(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the package release notes.
</summary>
<param name="settings">The settings.</param>
<param name="packageReleaseNotes">The package release notes.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetContinuousIntegrationBuild(Cake.Common.Tools.MSBuild.MSBuildSettings,System.Nullable{System.Boolean})">
<summary>
Sets a value indicating whether to normalize stored file paths used when producing deterministic builds.
</summary>
<remarks>
For more information see https://devblogs.microsoft.com/dotnet/producing-packages-with-source-link/#deterministic-builds.
</remarks>
<param name="settings">The settings.</param>
<param name="continuousIntegrationBuild">A value indicating whether to normalize stored file paths used when producing deterministic builds.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetNoImplicitTarget(Cake.Common.Tools.MSBuild.MSBuildSettings,System.Boolean)">
<summary>
Sets whether or not any targets should be passed to MSBuild.
</summary>
<param name="settings">The settings.</param>
<param name="noImplicitTarget"><c>true</c> if no implicit target should be passed to MSBuild; otherwise <c>false</c>.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetIncludeSymbols(Cake.Common.Tools.MSBuild.MSBuildSettings,System.Boolean)">
<summary>
Sets whether or not a symbol package should be created.
</summary>
<param name="settings">The settings.</param>
<param name="includeSymbols"><c>true</c> if a symbol package should be created; otherwise <c>false</c>.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetSymbolPackageFormat(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the symbol package format.
</summary>
<param name="settings">The settings.</param>
<param name="symbolPackageFormat">The symbol package format.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetVerbosity(Cake.Common.Tools.MSBuild.MSBuildSettings,Cake.Core.Diagnostics.Verbosity)">
<summary>
Sets the build log verbosity.
</summary>
<param name="settings">The settings.</param>
<param name="verbosity">The build log verbosity.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.WithLogger(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String,System.String,System.String)">
<summary>
Adds a custom logger.
</summary>
<param name="settings">The settings.</param>
<param name="loggerAssembly">The assembly containing the logger. Should match the format {AssemblyName[,StrongName] | AssemblyFile}.</param>
<param name="loggerClass">The class implementing the logger. Should match the format [PartialOrFullNamespace.]LoggerClassName. If the assembly contains only one logger, class does not need to be specified.</param>
<param name="loggerParameters">Parameters to be passed to the logger.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.AddFileLogger(Cake.Common.Tools.MSBuild.MSBuildSettings)">
<summary>
Adds a file logger with all the default settings.
Each file logger will be declared in the order added.
The first file logger will match up to the /fl parameter.
The next nine (max) file loggers will match up to the /fl1 through /fl9 respectively.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.AddFileLogger(Cake.Common.Tools.MSBuild.MSBuildSettings,Cake.Common.Tools.MSBuild.MSBuildFileLogger)">
<summary>
Adds a file logger.
Each file logger will be declared in the order added.
The first file logger will match up to the /fl parameter.
The next nine (max) file loggers will match up to the /fl1 through /fl9 respectively.
</summary>
<param name="settings">The settings.</param>
<param name="fileLoggerParameters">Parameters to be passed to the logger.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.EnableBinaryLogger(Cake.Common.Tools.MSBuild.MSBuildSettings)">
<summary>
Enables the binary logger with all the default settings.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.EnableBinaryLogger(Cake.Common.Tools.MSBuild.MSBuildSettings,Cake.Common.Tools.MSBuild.MSBuildBinaryLogImports)">
<summary>
Enables the binary logger with the specified imports and default file name.
</summary>
<param name="settings">The settings.</param>
<param name="imports">The imports.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.EnableBinaryLogger(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Enables the binary logger with the specified log file name and no imports.
</summary>
<param name="settings">The settings.</param>
<param name="fileName">The log file name.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.EnableBinaryLogger(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String,Cake.Common.Tools.MSBuild.MSBuildBinaryLogImports)">
<summary>
Enables the binary logger with the specified log file name and imports.
</summary>
<param name="settings">The settings.</param>
<param name="fileName">The log file name.</param>
<param name="imports">The imports.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.WithWarningsAsError(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String[])">
<summary>
Treat warnings as errors, if no codes specified all errors will be treated as errors.
</summary>
<param name="settings">The settings.</param>
<param name="codes">Only treat specified warning codes as errors.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.WithWarningsAsMessage(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String[])">
<summary>
Warnings to not treat as errors.
</summary>
<param name="settings">The settings.</param>
<param name="codes">Warning codes to not treat as errors.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.WithRestore(Cake.Common.Tools.MSBuild.MSBuildSettings)">
<summary>
Invoke the Restore target before any other target.
</summary>
<param name="settings">The setting.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetRestoreLockedMode(Cake.Common.Tools.MSBuild.MSBuildSettings,System.Boolean)">
<summary>
Sets whether or not to lock the package dependency graph while restoring, using the packages.lock.json file.
This setting is available with atleast Visual Studio 2017 version 15.9 and above or NET SDK version 2.1.500 and above.
</summary>
<param name="settings">The settings.</param>
<param name="restoreLockedMode"><c>true</c> if locked mode restore should be enabled; otherwise <c>false</c>.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.WithConsoleLoggerParameter(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Adds a console logger parameter.
</summary>
<param name="settings">The settings.</param>
<param name="parameter">The console logger parameter.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildToolVersion">
<summary>
Represents a MSBuild tool version.
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.Default">
<summary>
The highest available MSBuild tool version.
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.NET20">
<summary>
MSBuild tool version: <c>.NET 2.0</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.NET30">
<summary>
MSBuild tool version: <c>.NET 3.0</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.VS2005">
<summary>
MSBuild tool version: <c>Visual Studio 2005</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.NET35">
<summary>
MSBuild tool version: <c>.NET 3.5</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.VS2008">
<summary>
MSBuild tool version: <c>Visual Studio 2008</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.NET40">
<summary>
MSBuild tool version: <c>.NET 4.0</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.NET45">
<summary>
MSBuild tool version: <c>.NET 4.5</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.VS2010">
<summary>
MSBuild tool version: <c>Visual Studio 2010</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.VS2011">
<summary>
MSBuild tool version: <c>Visual Studio 2011</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.VS2012">
<summary>
MSBuild tool version: <c>Visual Studio 2012</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.NET451">
<summary>
MSBuild tool version: <c>.NET 4.5.1</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.NET452">
<summary>
MSBuild tool version: <c>.NET 4.5.2</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.VS2013">
<summary>
MSBuild tool version: <c>Visual Studio 2013</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.VS2015">
<summary>
MSBuild tool version: <c>Visual Studio 2015</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.NET46">
<summary>
MSBuild tool version: <c>.NET 4.6</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.VS2017">
<summary>
MSBuild tool version: <c>Visual Studio 2017</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.VS2019">
<summary>
MSBuild tool version: <c>Visual Studio 2019</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.VSCustom">
<summary>
Custom Visual Studio build
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.NETCustom">
<summary>
Custom Visual Studio build
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.VS2022">
<summary>
MSBuild tool version: <c>Visual Studio 2022</c>
</summary>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildVerbosityExtensions">
<summary>
Contains functionality related to MSBuild verbosity.
</summary>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildVerbosityExtensions.GetMSBuildVerbosityName(Cake.Core.Diagnostics.Verbosity)">
<summary>
Gets the MSBuild verbosity from <see cref="T:Cake.Core.Diagnostics.Verbosity"/>.
</summary>
<param name="verbosity">The verbosity.</param>
<returns>MSBuild verbosity string.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildVerbosityExtensions.GetMSBuildVerbosity(System.String)">
<summary>
Gets the MSBuild <see cref="T:Cake.Core.Diagnostics.Verbosity"/> from string value.
</summary>
<param name="verbosity">The verbosity string value.</param>
<returns>MSBuild <see cref="T:Cake.Core.Diagnostics.Verbosity"/> enumeration.</returns>
<remarks>Valid values are 'quiet', 'minimal', 'normal', 'detailed' and 'diagnostic'.</remarks>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildVersion">
<summary>
Represents a MSBuild version.
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildVersion.MSBuild20">
<summary>Version 2.0</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildVersion.MSBuild35">
<summary>Version 3.5</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildVersion.MSBuild4">
<summary>Version 4.0</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildVersion.MSBuild12">
<summary>Version 12.0</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildVersion.MSBuild14">
<summary>Version 14.0</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildVersion.MSBuild15">
<summary>Version 15.0</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildVersion.MSBuild16">
<summary>Version 16.0</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildVersion.MSBuildCustomVS">
<summary>
Custom VS Version
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildVersion.MSBuildNETCustom">
<summary>
Custom .NET Version
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildVersion.MSBuild17">
<summary>Version 17.0</summary>
</member>
<member name="T:Cake.Common.Tools.MSBuild.PlatformTarget">
<summary>
Represents a MSBuild platform target.
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.PlatformTarget.MSIL">
<summary>
Platform target: <c>MSIL</c> (Any CPU)
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.PlatformTarget.x86">
<summary>
Platform target: <c>x86</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.PlatformTarget.x64">
<summary>
Platform target: <c>x64</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.PlatformTarget.ARM">
<summary>
Platform target: <c>ARM</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.PlatformTarget.Win32">
<summary>
Platform target: <c>Win32</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.PlatformTarget.ARM64">
<summary>
Platform target: <c>ARM64</c>
</summary>
</member>
<member name="T:Cake.Common.Tools.MSTest.NamespaceDoc">
<summary>
This namespace contain types used to interact with MSTest.
</summary>
</member>
<member name="T:Cake.Common.Tools.MSTest.MSTestAliases">
<summary>
<para>Contains functionality related to running <see href="https://msdn.microsoft.com/en-us/library/ms182486.aspx">MSTest</see> unit tests.</para>
<para>
In order to use the commands for this alias, MSTest will need to be installed on the machine where
the Cake script is being executed. This is typically achieved by having either Visual Studio installed, or by
using the Microsoft Build Tools, for example, for <see href="https://www.microsoft.com/en-us/download/details.aspx?id=48159">2015</see>.
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.MSTest.MSTestAliases.MSTest(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Runs all MSTest unit tests in the assemblies matching the specified pattern.
</summary>
<example>
<code>
MSTest("./Tests/*.UnitTests.dll");
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
</member>
<member name="M:Cake.Common.Tools.MSTest.MSTestAliases.MSTest(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.MSTest.MSTestSettings)">
<summary>
Runs all MSTest unit tests in the assemblies matching the specified pattern.
</summary>
<example>
<code>
MSTest("./Tests/*.UnitTests.dll", new MSTestSettings() { NoIsolation = false });
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.MSTest.MSTestAliases.MSTest(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Runs all MSTest unit tests in the specified assemblies.
</summary>
<example>
<code>
var paths = new List<FilePath>() { "./assemblydir1", "./assemblydir2" };
MSTest(paths);
</code>
</example>
<param name="context">The context.</param>
<param name="assemblyPaths">The assembly paths.</param>
</member>
<member name="M:Cake.Common.Tools.MSTest.MSTestAliases.MSTest(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.MSTest.MSTestSettings)">
<summary>
Runs all MSTest unit tests in the specified assemblies.
</summary>
<example>
<code>
var paths = new List<FilePath>() { "./assemblydir1", "./assemblydir2" };
MSTest(paths, new MSTestSettings() { NoIsolation = false });
</code>
</example>
<param name="context">The context.</param>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.MSTest.MSTestRunner">
<summary>
The MSTest unit test runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.MSTest.MSTestRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.MSTest.MSTestRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.MSTest.MSTestRunner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.MSTest.MSTestSettings)">
<summary>
Runs the tests in the specified assembly.
</summary>
<param name="assemblyPaths">The assembly path.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.MSTest.MSTestRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The tool name.</returns>
</member>
<member name="M:Cake.Common.Tools.MSTest.MSTestRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.MSTest.MSTestRunner.GetAlternativeToolPaths(Cake.Common.Tools.MSTest.MSTestSettings)">
<summary>
Gets alternative file paths which the tool may exist in.
</summary>
<param name="settings">The settings.</param>
<returns>The default tool path.</returns>
</member>
<member name="T:Cake.Common.Tools.MSTest.MSTestSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.MSTest.MSTestRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSTest.MSTestSettings.NoIsolation">
<summary>
Gets or sets a value indicating whether to run tests within the MSTest process.
This choice improves test run speed but increases risk to the MSTest.exe process.
Defaults to <c>true</c>.
</summary>
<value>
<c>true</c> if running without isolation; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.MSTest.MSTestSettings.Category">
<summary>
Gets or sets a value indicating the test category filter string to pass to
MSTest.exe flag <see href="https://msdn.microsoft.com/en-us/library/ms182489.aspx#category">/testcategory</see>.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSTest.MSTestSettings.ResultsFile">
<summary>
Gets or sets the filepath for a named resulting test file.
MSTest.exe flag <see href="https://msdn.microsoft.com/en-us/library/ms182489.aspx#resultsfile">/resultsfile</see>.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSTest.MSTestSettings.TestSettings">
<summary>
Gets or sets the test settings file to pass to MSTest.exe flag <see href="https://msdn.microsoft.com/en-us/library/ms182489.aspx#testsettings">/testsettings</see>.
</summary>
</member>
<member name="M:Cake.Common.Tools.MSTest.MSTestSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.MSTest.MSTestSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.NamespaceDoc">
<summary>
This namespace contain types used to interact with NuGet.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Install.NamespaceDoc">
<summary>
This namespace contain types used to interact
with the NuGet package installer.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Install.NuGetInstaller">
<summary>
The NuGet package installer used to install NuGet packages.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.Install.NuGetInstaller.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.Install.NuGetInstaller"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Install.NuGetInstaller.InstallFromConfig(Cake.Core.IO.FilePath,Cake.Common.Tools.NuGet.Install.NuGetInstallSettings)">
<summary>
Installs NuGet packages using the specified package configuration file and settings.
</summary>
<param name="packageConfigPath">Path to package configuration to use for install.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Install.NuGetInstaller.Install(System.String,Cake.Common.Tools.NuGet.Install.NuGetInstallSettings)">
<summary>
Installs NuGet packages using the specified package id and settings.
</summary>
<param name="packageId">The source package id.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.Install.NuGetInstaller"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.OutputDirectory">
<summary>
Gets or sets the directory in which packages will be installed.
If none is specified, the current directory will be used.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.Version">
<summary>
Gets or sets the version of the package to install.
If none specified, the latest will be used.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.ExcludeVersion">
<summary>
Gets or sets a value indicating whether to exclude the version number from the package folder.
</summary>
<value>
<c>true</c> if to exclude the version number from the package folder; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.Prerelease">
<summary>
Gets or sets a value indicating whether to allow installation of prerelease packages.
This flag is not required when restoring packages by installing from packages.config.
</summary>
<value>
<c>true</c> to allow installation of prerelease packages; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.RequireConsent">
<summary>
Gets or sets a value indicating whether to check if package
install consent is granted before installing a package.
</summary>
<value>
<c>true</c> if to check if package install consent is granted before installing a package; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.SolutionDirectory">
<summary>
Gets or sets the solution directory path for package restore.
</summary>
<value>
The solution directory path.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.Source">
<summary>
Gets or sets a list of packages sources to use for this command.
</summary>
<value>The list of packages sources to use for this command.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.NoCache">
<summary>
Gets or sets a value indicating whether or not to use the machine cache as the first package source.
</summary>
<value>
<c>true</c> to not use the machine cache as the first package source; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.DisableParallelProcessing">
<summary>
Gets or sets a value indicating whether to disable parallel processing of packages for this command.
Disable parallel processing of packages for this command.
</summary>
<value>
<c>true</c> to disable parallel processing of packages for this command; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.Verbosity">
<summary>
Gets or sets the output verbosity.
</summary>
<value>The output verbosity.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file.
If not specified, the file <c>%AppData%\NuGet\NuGet.config</c> is used as the configuration file.
</summary>
<value>The NuGet configuration file.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.FallbackSource">
<summary>
Gets or sets a list of packages sources to use as fallbacks for this command.
This setting requires NuGet V3 or later.
</summary>
<value>The list of packages sources to use as fallbacks for this command.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.NonInteractive">
<summary>
Gets or sets a value indicating whether or not NuGet suppresses prompts for user input or confirmations.
</summary>
<remarks>
This setting is passed by NuGet.exe to any extensions such as authorization providers.
</remarks>
<value>
<c>false</c> to allow NuGet to show prompts for user input or confirmations; otherwise, <c>true</c>.
</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.Pack.NamespaceDoc">
<summary>
This namespace contain types used to
pack NuGet packages.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Pack.NuGetPacker">
<summary>
The NuGet packer.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.Pack.NuGetPacker.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Diagnostics.ICakeLog,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.Pack.NuGetPacker"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="log">The log.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Pack.NuGetPacker.Pack(Cake.Common.Tools.NuGet.Pack.NuGetPackSettings)">
<summary>
Creates a NuGet package from the specified settings.
</summary>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Pack.NuGetPacker.Pack(Cake.Core.IO.FilePath,Cake.Common.Tools.NuGet.Pack.NuGetPackSettings)">
<summary>
Creates a NuGet package from the specified nuspec or project file.
</summary>
<param name="filePath">The nuspec or project file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.Pack.NuGetPacker"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.BasePath">
<summary>
Gets or sets the base path.
</summary>
<value>The base path.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.OutputDirectory">
<summary>
Gets or sets the output directory.
</summary>
<value>The output directory.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.NoPackageAnalysis">
<summary>
Gets or sets a value indicating whether package analysis should be performed.
Defaults to <c>true</c>.
</summary>
<value>
<c>true</c> if package analysis should be performed; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.IncludeReferencedProjects">
<summary>
Gets or sets a value indicating whether referenced projects should be included.
Defaults to <c>false</c>.
</summary>
<value>
<c>true</c> if referenced projects should be included; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Symbols">
<summary>
Gets or sets a value indicating whether a symbol package should be created.
Defaults to <c>false</c>.
</summary>
<value>
<c>true</c> if a symbol package should be created; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.SymbolPackageFormat">
<summary>
Gets or sets the symbol package format.
</summary>
<value>The symbol package format.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Id">
<summary>
Gets or sets the package ID.
</summary>
<value>The package ID.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Version">
<summary>
Gets or sets the nuspec version.
</summary>
<value>The nuspec version.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Suffix">
<summary>
Gets or sets the nuspec version suffix.
</summary>
<value>The nuspec version suffix.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Title">
<summary>
Gets or sets the package title.
</summary>
<value>The package title.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Authors">
<summary>
Gets or sets the package authors.
</summary>
<value>The package authors.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Owners">
<summary>
Gets or sets the package owners.
</summary>
<value>The package owners.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Description">
<summary>
Gets or sets the package description.
</summary>
<value>The package description.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Summary">
<summary>
Gets or sets the package summary.
</summary>
<value>The package summary.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.ProjectUrl">
<summary>
Gets or sets the package project URL.
</summary>
<value>The package project URL.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Icon">
<summary>
Gets or sets the Icon path.
</summary>
<value>The path to the icon file contained within the NuGet package.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.IconUrl">
<summary>
Gets or sets the package icon URL.
</summary>
<value>The package icon URL.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.LicenseUrl">
<summary>
Gets or sets the package license URL.
</summary>
<value>The package license URL.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Copyright">
<summary>
Gets or sets the package copyright.
</summary>
<value>The package copyright.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.ReleaseNotes">
<summary>
Gets or sets the package release notes.
</summary>
<value>The package release notes.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Tags">
<summary>
Gets or sets the package tags.
</summary>
<value>The package tags.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Serviceable">
<summary>
Gets or sets a value indicating whether this package should be marked as a serviceable.
</summary>
<value>
<c>true</c> if serviceable; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Repository">
<summary>
Gets or sets the package repository data.
</summary>
<value>The package repository data.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.License">
<summary>
Gets or sets the package license.
</summary>
<value>The package license.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.PackageTypes">
<summary>
Gets or sets the package types.
</summary>
<value>The package types.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.FrameworkAssemblies">
<summary>
Gets or sets the package framework assemblies.
</summary>
<value>The package framework assemblies.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.DevelopmentDependency">
<summary>
Gets or sets a value indicating whether this package should be marked as a development dependency.
</summary>
<value>
<c>true</c> if a development dependency; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.RequireLicenseAcceptance">
<summary>
Gets or sets a value indicating whether users has to accept the package license.
</summary>
<value>
<c>true</c> if users has to accept the package license; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.References">
<summary>
Gets or sets the package references.
</summary>
<value>The package references.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.ContentFiles">
<summary>
Gets or sets the package content files.
</summary>
<value>The package content files.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.MinClientVersion">
<summary>
Gets or sets the package minimum client version.
</summary>
<value>The package minimum client version.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Files">
<summary>
Gets or sets the package files.
</summary>
<value>The package files.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Dependencies">
<summary>
Gets or sets the package dependencies.
</summary>
<value>The package files.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Verbosity">
<summary>
Gets or sets the verbosity.
</summary>
<value>The verbosity.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Properties">
<summary>
Gets or sets the properties.
</summary>
<value>
The properties.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.MSBuildVersion">
<summary>
Gets or sets the version of MSBuild to be used with this command.
By default the MSBuild in your path is picked, otherwise it defaults to the highest installed version of MSBuild.
This setting requires NuGet V3 or later.
</summary>
<value>The version of MSBuild to be used with this command.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.KeepTemporaryNuSpecFile">
<summary>
Gets or sets a value indicating whether the temporarily autogenerated NuSpec file should be kept or not.
Defaults to <c>false</c>.
</summary>
<value>
<c>true</c> if the temporarily autogenerated NuSpec file should be kept; otherwise <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Language">
<summary>
Gets or sets the package language.
</summary>
<value>The package language.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.OutputToToolFolder">
<summary>
Gets or sets a value indicating whether the files should be packed into the tool folder.
Defaults to <c>false</c>.
</summary>
<value>
<c>true</c> if the output should be placed in the tool folder inside the NuGet package; otherwise <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.Pack.NuGetRepository">
<summary>
Specifies the package's source code location, allowing IDEs to download and debug the code.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetRepository.Type">
<summary>
Gets or sets the type of repository e.g. Git.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetRepository.Url">
<summary>
Gets or sets the repository's URL.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetRepository.Branch">
<summary>
Gets or sets the name of the branch within the repository.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetRepository.Commit">
<summary>
Gets or sets the corresponding commit ID for the specified version of the package.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Pack.NuSpecContent">
<summary>
Represents a NuGet nuspec file.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecContent.Source">
<summary>
Gets or sets the location of the file or files to include.
The path is relative to the NuSpec file unless an absolute path is specified.
The wildcard character - <c>*</c> - is allowed.
Using a double wildcard - <c>**</c> implies a recursive directory search.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecContent.Target">
<summary>
Gets or sets the relative path to the directory within the package where the source files will be placed.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecContent.Exclude">
<summary>
Gets or sets the file or files to exclude.
This is usually combined with a wildcard value in the <c>src</c> attribute.
The <c>exclude</c> attribute can contain a semi-colon delimited list of files or a file pattern.
Using a double wildcard - <c>**</c> - implies a recursive exclude pattern.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Pack.NuSpecContentFile">
<summary>
Specifies the package's content to identify the exact files that are included in the package.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecContentFile.Include">
<summary>
Gets or sets the location of the file or files to include.
The wildcard character - <c>*</c> - is allowed.
Using a double wildcard - <c>**</c> implies a recursive directory search.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecContentFile.Exclude">
<summary>
Gets or sets files or file patterns to exclude from <c>src</c> location.
The wildcard character - <c>*</c> - is allowed.
Using a double wildcard - <c>**</c> implies a recursive directory search.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecContentFile.BuildAction">
<summary>
Gets or sets the build action to assign to the content item for MSBuild, e.g. Compile.
Defaults to <c>Compile</c>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecContentFile.CopyToOutput">
<summary>
Gets or sets a value indicating whether to copy content items to the build (or publish) output folder.
Defaults to <c>false</c>.
</summary>
<value>
<c>true</c> if content items should be copied to the output folder; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecContentFile.Flatten">
<summary>
Gets or sets a value indicating whether to copy content items to a single folder in the build output
or to preserve the folder structure in the package. This flag only works when <c>copyToOutput</c>
flag is set to true. Defaults to <c>false</c>.
</summary>
<value>
<c>true</c> if content items should be copied to a single folder; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.Pack.NuSpecDependency">
<summary>
Represents a NuGet nuspec dependency.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecDependency.Id">
<summary>
Gets or sets the dependency's package ID.
</summary>
<value>The dependency's package ID.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecDependency.Version">
<summary>
Gets or sets the dependency's version.
</summary>
<value>The dependency's version.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecDependency.Include">
<summary>
Gets or sets a list of include/exclude tags indicating of the dependency to
include in the final package. The default value is <c>all</c>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecDependency.Exclude">
<summary>
Gets or sets a list of include/exclude tags indicating of the dependency to
exclude in the final package. The default value is <c>build,analyzers</c> which can
be over-written.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecDependency.TargetFramework">
<summary>
Gets or sets the target framework for the dependency.
</summary>
<value>The target framework for the dependency.</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.Pack.NuSpecFrameworkAssembly">
<summary>
Specifies framework assemblies to ensure that required references are added to a project.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecFrameworkAssembly.AssemblyName">
<summary>
Gets or sets the fully qualified assembly name.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecFrameworkAssembly.TargetFramework">
<summary>
Gets or sets the target framework to which this reference applies. If omitted,
indicates that the reference applies to all frameworks.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Pack.NuSpecLicense">
<summary>
Specifies the package's SPDX license expression or path to a license file.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecLicense.Type">
<summary>
Gets or sets the license type.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecLicense.Version">
<summary>
Gets or sets the license version.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecLicense.Value">
<summary>
Gets or sets SPDX license identifier.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Pack.NuSpecPackageType">
<summary>
Specifies the package's package type that indicates its intended use.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecPackageType.Name">
<summary>
Gets or sets the package type, e.g <c>DotnetCliTool</c>
Defaults to <c>Dependency</c>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecPackageType.Version">
<summary>
Gets or sets the version of the package type.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Pack.NuSpecReference">
<summary>
Specifies the package's assemblies that the target project should reference when being used.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecReference.File">
<summary>
Gets or sets file for the reference.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecReference.TargetFramework">
<summary>
Gets or sets the target framework for the reference.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Push.NamespaceDoc">
<summary>
This namespace contain types used to
push NuGet packages.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Push.NuGetPusher">
<summary>
The NuGet package pusher.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.Push.NuGetPusher.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.Push.NuGetPusher"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
<param name="log">The logger.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Push.NuGetPusher.Push(Cake.Core.IO.FilePath,Cake.Common.Tools.NuGet.Push.NuGetPushSettings)">
<summary>
Pushes a NuGet package to a NuGet server and publishes it.
</summary>
<param name="packageFilePath">The package file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.NuGet.Push.NuGetPushSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.Push.NuGetPusher"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Push.NuGetPushSettings.Source">
<summary>
Gets or sets the server URL.
When using NuGet pre 3.4.2, this value is optional
and nuget.org is used if omitted (unless DefaultPushSource
config value is set in the NuGet config file.
When using NuGet 3.4.2 (or more recent), this value is mandatory.
Starting with NuGet 2.5, if NuGet.exe identifies a UNC/folder source,
it will perform the file copy to the source.
</summary>
<value>The server URL.</value>
<remarks>
For your convenience, here is the URL for some of the most popular
public NuGet servers:
- NuGet Gallery: https://nuget.org/api/v2/package
- MyGet: https://www.myget.org/F/<your_username>/api/v2/package.
</remarks>
</member>
<member name="P:Cake.Common.Tools.NuGet.Push.NuGetPushSettings.ApiKey">
<summary>
Gets or sets the API key for the server.
</summary>
<value>The API key for the server.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Push.NuGetPushSettings.Timeout">
<summary>
Gets or sets the timeout for pushing to a server.
Defaults to 300 seconds (5 minutes).
</summary>
<value>The timeout for pushing to a server.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Push.NuGetPushSettings.Verbosity">
<summary>
Gets or sets the verbosity.
</summary>
<value>The verbosity.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Push.NuGetPushSettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file.
</summary>
<value>The NuGet configuration file.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Push.NuGetPushSettings.SkipDuplicate">
<summary>
Gets or sets a value indicating whether to skip a package and continue with
the next package in the push, if any when a package with the same version
already exists.
</summary>
<value>
<c>true</c> if skipping duplicates; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.Restore.NamespaceDoc">
<summary>
This namespace contain types used to
restore NuGet packages.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Restore.NuGetRestorer">
<summary>
The NuGet package restorer used to restore solution packages.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.Restore.NuGetRestorer.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.Restore.NuGetRestorer"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Restore.NuGetRestorer.Restore(Cake.Core.IO.FilePath,Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings)">
<summary>
Restores NuGet packages using the specified settings.
</summary>
<param name="targetFilePath">The target file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.Restore.NuGetRestorer"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings.RequireConsent">
<summary>
Gets or sets a value indicating whether package restore consent is granted before installing a package.
</summary>
<value>
<c>true</c> if package restore consent is granted; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings.PackagesDirectory">
<summary>
Gets or sets the packages folder.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings.Source">
<summary>
Gets or sets a list of packages sources to use for this command.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings.NoCache">
<summary>
Gets or sets a value indicating whether or not to use the machine cache as the first package source.
</summary>
<value>
<c>true</c> to not use the machine cache as the first package source; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings.DisableParallelProcessing">
<summary>
Gets or sets a value indicating whether or not to disable parallel processing of packages for this command.
</summary>
<value>
<c>true</c> to disable parallel processing; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings.Verbosity">
<summary>
Gets or sets the amount of output details.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file.
If not specified, the file <c>%AppData%\NuGet\NuGet.config</c> is used as the configuration file.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings.FallbackSource">
<summary>
Gets or sets a list of packages sources to use as fallbacks for this command.
This setting requires NuGet V3 or later.
</summary>
<value>The list of packages sources to use as fallbacks for this command.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings.MSBuildVersion">
<summary>
Gets or sets the version of MSBuild to be used with this command.
By default the MSBuild in your path is picked, otherwise it defaults to the highest installed version of MSBuild.
This setting requires NuGet V3 or later.
</summary>
<value>The version of MSBuild to be used with this command.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings.MSBuildPath">
<summary>
Gets or sets the path of MSBuild to use.
This setting takes precedence over <c>-MSBuildVersion</c> and requires NuGet V4 or later.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings.NonInteractive">
<summary>
Gets or sets a value indicating whether or not NuGet suppresses prompts for user input or confirmations.
</summary>
<remarks>
This setting is passed by NuGet.exe to any extensions such as authorization providers.
</remarks>
<value>
<c>false</c> to allow NuGet to show prompts for user input or confirmations; otherwise, <c>true</c>.
</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.SetApiKey.NamespaceDoc">
<summary>
This namespace contain types used to
set NuGet API keys.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.SetApiKey.NuGetSetApiKey">
<summary>
The NuGet set API key used to set API key used for API/feed authentication.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.SetApiKey.NuGetSetApiKey.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.SetApiKey.NuGetSetApiKey"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.SetApiKey.NuGetSetApiKey.SetApiKey(System.String,System.String,Cake.Common.Tools.NuGet.SetApiKey.NuGetSetApiKeySettings)">
<summary>
Installs NuGet packages using the specified package id and settings.
</summary>
<param name="apiKey">The API key.</param>
<param name="source">The Server URL where the API key is valid.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.NuGet.SetApiKey.NuGetSetApiKeySettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.SetApiKey.NuGetSetApiKey"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.SetApiKey.NuGetSetApiKeySettings.Verbosity">
<summary>
Gets or sets the output verbosity.
</summary>
<value>The output verbosity.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.SetApiKey.NuGetSetApiKeySettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file.
If not specified, the file <c>%AppData%\NuGet\NuGet.config</c> is used as the configuration file.
</summary>
<value>The NuGet configuration file.</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.SetProxy.NamespaceDoc">
<summary>
This namespace contain types used to
set proxy settings.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.SetProxy.NuGetSetProxy">
<summary>
The NuGet set command used to set the proxy settings to be used while connecting to your NuGet feed.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.SetProxy.NuGetSetProxy.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.SetProxy.NuGetSetProxy"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.SetProxy.NuGetSetProxy.SetProxy(System.String,System.String,System.String,Cake.Common.Tools.NuGet.SetProxy.NuGetSetProxySettings)">
<summary>
Set the proxy settings to be used while connecting to your NuGet feed.
</summary>
<param name="url">The url of the proxy.</param>
<param name="username">The username used to access the proxy.</param>
<param name="password">The password used to access the proxy.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.NuGet.SetProxy.NuGetSetProxySettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.SetProxy.NuGetSetProxy"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.SetProxy.NuGetSetProxySettings.Verbosity">
<summary>
Gets or sets the output verbosity.
</summary>
<value>The output verbosity.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.SetProxy.NuGetSetProxySettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file.
If not specified, the file <c>%AppData%\NuGet\NuGet.config</c> is used as the configuration file.
</summary>
<value>The NuGet configuration file.</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.Sources.NamespaceDoc">
<summary>
This namespace contain types used to
interact with NuGet sources.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Sources.NuGetSources">
<summary>
The NuGet sources is used to work with user config feeds & credentials.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.Sources.NuGetSources.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.Sources.NuGetSources"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Sources.NuGetSources.AddSource(System.String,System.String,Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings)">
<summary>
Adds NuGet package source using the specified settings to global user config.
</summary>
<param name="name">Name of the source.</param>
<param name="source">Path to the package(s) source.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Sources.NuGetSources.RemoveSource(System.String,System.String,Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings)">
<summary>
Remove specified NuGet package source.
</summary>
<param name="name">Name of the source.</param>
<param name="source">Path to the package(s) source.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Sources.NuGetSources.HasSource(System.String,Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings)">
<summary>
Determines whether the specified NuGet package source exist.
</summary>
<param name="source">Path to the package(s) source.</param>
<param name="settings">The settings.</param>
<returns>Whether the specified NuGet package source exist.</returns>
</member>
<member name="T:Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.Sources.NuGetSources"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings.UserName">
<summary>
Gets or sets the (optional) user name.
</summary>
<value>Optional user name to be used when connecting to an authenticated source.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings.Password">
<summary>
Gets or sets the (optional) password.
</summary>
<value>Optional password to be used when connecting to an authenticated source.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings.Verbosity">
<summary>
Gets or sets the output verbosity.
</summary>
<value>The output verbosity.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings.IsSensitiveSource">
<summary>
Gets or sets a value indicating whether this source contains sensitive data, i.e. authentication token in url.
</summary>
<value>
<c>true</c> if this source contains sensitive data; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings.StorePasswordInClearText">
<summary>
Gets or sets a value indicating whether to not encrypt the password and store it in clear text. (Default: <c>false</c>).
</summary>
<value>
<c>true</c> if password is stored as unencrypted; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings.ConfigFile">
<summary>
Gets or sets the location of the NuGet configuration file. If not specified, file %AppData%\NuGet\NuGet.config is used as configuration file.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Update.NamespaceDoc">
<summary>
This namespace contain types used to
update NuGet packages.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Update.NuGetUpdater">
<summary>
The NuGet package updater.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.Update.NuGetUpdater.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.Update.NuGetUpdater"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Update.NuGetUpdater.Update(Cake.Core.IO.FilePath,Cake.Common.Tools.NuGet.Update.NuGetUpdateSettings)">
<summary>
Updates NuGet packages using the specified settings.
</summary>
<param name="targetFile">The target file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.NuGet.Update.NuGetUpdateSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.Update.NuGetUpdater"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Update.NuGetUpdateSettings.Id">
<summary>
Gets or sets the package ids to update.
</summary>
<value>The package ids to update.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Update.NuGetUpdateSettings.Source">
<summary>
Gets or sets a list of package sources to use for this command.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Update.NuGetUpdateSettings.Safe">
<summary>
Gets or sets a value indicating whether to look for updates with the highest
version available within the same major and minor version as the installed package.
</summary>
<value>
<c>true</c> if safe; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Update.NuGetUpdateSettings.Prerelease">
<summary>
Gets or sets a value indicating whether to allow updating to prerelease versions.
This flag is not required when updating prerelease packages that are already installed.
</summary>
<value>
<c>true</c> to allow updating to prerelease versions; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Update.NuGetUpdateSettings.Verbosity">
<summary>
Gets or sets the amount of output details.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Update.NuGetUpdateSettings.MSBuildVersion">
<summary>
Gets or sets the version of MSBuild to be used with this command.
By default the MSBuild in your path is picked, otherwise it defaults to the highest installed version of MSBuild.
This setting requires NuGet V3 or later.
</summary>
<value>The version of MSBuild to be used with this command.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Update.NuGetUpdateSettings.Version">
<summary>
Gets or sets package version to be used with this command.
</summary>
<value>The package version to be used with this command.</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.Add.NuGetAdder">
<summary>
The NuGet package add tool used to add NuGet packages to folder or UNC shares.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.Add.NuGetAdder.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.Add.NuGetAdder"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Add.NuGetAdder.Add(System.String,Cake.Common.Tools.NuGet.Add.NuGetAddSettings)">
<summary>
Adds NuGet packages to the package source, which is a folder or a UNC share. Http sources are not supported.
</summary>
<param name="packageId">The source package id.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.NuGet.Add.NuGetAddSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.Add.NuGetAddSettings"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Add.NuGetAddSettings.Source">
<summary>
Gets or sets a a package sources to use for this command.
</summary>
<value>The package sources to use for this command.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Add.NuGetAddSettings.Expand">
<summary>
Gets or sets a value indicating whether a package added to an offline feed is also expanded.
</summary>
<value><c>true</c> if package should also be expanded; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Add.NuGetAddSettings.Verbosity">
<summary>
Gets or sets the output verbosity.
</summary>
<value>The output verbosity.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Add.NuGetAddSettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file.
If not specified, the file <c>%AppData%\NuGet\NuGet.config</c> is used as the configuration file.
</summary>
<value>The NuGet configuration file.</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.Delete.NuGetDeleter">
<summary>
The NuGet package pusher.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.Delete.NuGetDeleter.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.Delete.NuGetDeleter"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
<param name="log">The logger.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Delete.NuGetDeleter.Delete(System.String,System.String,Cake.Common.Tools.NuGet.Delete.NuGetDeleteSettings)">
<summary>
Deletes or unlists a package from a package source.
</summary>
<param name="packageID">The package ID (name).</param>
<param name="packageVersion">The package version.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.NuGet.Delete.NuGetDeleteSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.Delete.NuGetDeleter"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Delete.NuGetDeleteSettings.Source">
<summary>
Gets or sets the server URL.
When using NuGet pre 3.4.2, this value is optional
and nuget.org is used if omitted (unless DefaultPushSource
config value is set in the NuGet config file.
When using NuGet 3.4.2 (or more recent), this value is mandatory.
Starting with NuGet 2.5, if NuGet.exe identifies a UNC/folder source,
it will perform the file copy to the source.
</summary>
<value>The server URL.</value>
<remarks>
For your convenience, here is the URL for some of the most popular
public NuGet servers:
- NuGet Gallery: https://nuget.org/api/v2/package
- MyGet: https://www.myget.org/F/<your_username>/api/v2/package.
</remarks>
</member>
<member name="P:Cake.Common.Tools.NuGet.Delete.NuGetDeleteSettings.ApiKey">
<summary>
Gets or sets the API key for the server.
</summary>
<value>The API key for the server.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Delete.NuGetDeleteSettings.Verbosity">
<summary>
Gets or sets the verbosity.
</summary>
<value>The verbosity.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Delete.NuGetDeleteSettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file.
</summary>
<value>The NuGet configuration file.</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.Init.NuGetIniter">
<summary>
The NuGet package init tool copies all the packages from the source to the hierarchical destination.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.Init.NuGetIniter.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.Init.NuGetIniter"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Init.NuGetIniter.Init(System.String,System.String,Cake.Common.Tools.NuGet.Init.NuGetInitSettings)">
<summary>
Init adds all the packages from the source to the hierarchical destination.
</summary>
<param name="sourcePackageSourcePath">Package source to be copied from.</param>
<param name="destinationPackageSourcePath">Package destination to be copied to.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.NuGet.Init.NuGetInitSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.Init.NuGetInitSettings"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Init.NuGetInitSettings.Expand">
<summary>
Gets or sets a value indicating whether a package added to an offline feed is also expanded.
</summary>
<value><c>true</c> if package should also be expanded; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Init.NuGetInitSettings.Verbosity">
<summary>
Gets or sets the output verbosity.
</summary>
<value>The output verbosity.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Init.NuGetInitSettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file.
If not specified, the file <c>%AppData%\NuGet\NuGet.config</c> is used as the configuration file.
</summary>
<value>The NuGet configuration file.</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.List.NuGetList">
<summary>
The NuGet package lister used to list NuGet packages from a source.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.List.NuGetList.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.List.NuGetList"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.List.NuGetList.List(Cake.Common.Tools.NuGet.List.NuGetListSettings)">
<summary>
Lists available packages with their versions.
</summary>
<param name="settings">The settings.</param>
<returns>A list of available packages.</returns>
</member>
<member name="M:Cake.Common.Tools.NuGet.List.NuGetList.List(System.String,Cake.Common.Tools.NuGet.List.NuGetListSettings)">
<summary>
Lists available packages with their versions.
</summary>
<param name="packageId">The source package id. If it equals an empty string, it will match all packageIds.</param>
<param name="settings">The settings.</param>
<returns>A list of available packages.</returns>
</member>
<member name="T:Cake.Common.Tools.NuGet.List.NuGetListItem">
<summary>
An item as returned by <see cref="T:Cake.Common.Tools.NuGet.List.NuGetList"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.List.NuGetListItem.Name">
<summary>
Gets or sets the name of the NuGetListItem.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.List.NuGetListItem.Version">
<summary>
Gets or sets the version of the NuGetListItem as string.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.List.NuGetListSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.List.NuGetList"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.List.NuGetListSettings.AllVersions">
<summary>
Gets or sets a value indicating whether list all versions of a package.By default, only the latest package version is displayed.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.List.NuGetListSettings.Prerelease">
<summary>
Gets or sets a value indicating whether to allow prerelease packages to be shown.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.List.NuGetListSettings.IncludeDelisted">
<summary>
Gets or sets a value indicating whether to allow unlisted packages to be shown.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.List.NuGetListSettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file. If not specified, file %AppData%\NuGet\NuGet.config is used as configuration file.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.List.NuGetListSettings.Source">
<summary>
Gets or sets a list of packages sources to search.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.NuGetAliases">
<summary>
Contains functionality for working with <see href="https://www.nuget.org/">NuGet</see>.
</summary>
<para>
Since Cake requires NuGet to be available very early in the build pipeline, we recommend that NuGet is made
available via the <see href="https://github.com/cake-build/resources">Cake Bootstrapper</see>.
</para>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetPack(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.NuGet.Pack.NuGetPackSettings)">
<summary>
Creates a NuGet package using the specified nuspec or project file.
</summary>
<param name="context">The context.</param>
<param name="filePath">The nuspec or project file path.</param>
<param name="settings">The settings.</param>
<example>
<code>
var nuGetPackSettings = new NuGetPackSettings {
Id = "TestNuGet",
Version = "0.0.0.1",
Title = "The tile of the package",
Authors = new[] {"John Doe"},
Owners = new[] {"Contoso"},
Description = "The description of the package",
Summary = "Excellent summary of what the package does",
ProjectUrl = new Uri("https://github.com/SomeUser/TestNuGet/"),
IconUrl = new Uri("http://cdn.rawgit.com/SomeUser/TestNuGet/master/icons/testNuGet.png"),
LicenseUrl = new Uri("https://github.com/SomeUser/TestNuGet/blob/master/LICENSE.md"),
Copyright = "Some company 2015",
ReleaseNotes = new [] {"Bug fixes", "Issue fixes", "Typos"},
Tags = new [] {"Cake", "Script", "Build"},
RequireLicenseAcceptance= false,
Symbols = false,
NoPackageAnalysis = true,
Files = new [] {
new NuSpecContent {Source = "bin/TestNuGet.dll", Target = "bin"},
},
BasePath = "./src/TestNuGet/bin/release",
OutputDirectory = "./NuGet"
};
NuGetPack("./nuspec/TestNuGet.nuspec", nuGetPackSettings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetPack(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.NuGet.Pack.NuGetPackSettings)">
<summary>
Creates NuGet packages using the specified nuspec or project files.
</summary>
<param name="context">The context.</param>
<param name="filePaths">The nuspec or project file paths.</param>
<param name="settings">The settings.</param>
<example>
<code>
var nuGetPackSettings = new NuGetPackSettings {
Id = "TestNuGet",
Version = "0.0.0.1",
Title = "The tile of the package",
Authors = new[] {"John Doe"},
Owners = new[] {"Contoso"},
Description = "The description of the package",
Summary = "Excellent summary of what the package does",
ProjectUrl = new Uri("https://github.com/SomeUser/TestNuGet/"),
IconUrl = new Uri("http://cdn.rawgit.com/SomeUser/TestNuGet/master/icons/testNuGet.png"),
LicenseUrl = new Uri("https://github.com/SomeUser/TestNuGet/blob/master/LICENSE.md"),
Copyright = "Some company 2015",
ReleaseNotes = new [] {"Bug fixes", "Issue fixes", "Typos"},
Tags = new [] {"Cake", "Script", "Build"},
RequireLicenseAcceptance= false,
Symbols = false,
NoPackageAnalysis = true,
Files = new [] {
new NuSpecContent {Source = "bin/TestNuGet.dll", Target = "bin"},
},
BasePath = "./src/TestNuGet/bin/release",
OutputDirectory = "./NuGet"
};
var nuspecFiles = GetFiles("./**/*.nuspec");
NuGetPack(nuspecFiles, nuGetPackSettings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetPack(Cake.Core.ICakeContext,Cake.Common.Tools.NuGet.Pack.NuGetPackSettings)">
<summary>
Creates a NuGet package using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<example>
<code>
var nuGetPackSettings = new NuGetPackSettings {
Id = "TestNuGet",
Version = "0.0.0.1",
Title = "The tile of the package",
Authors = new[] {"John Doe"},
Owners = new[] {"Contoso"},
Description = "The description of the package",
Summary = "Excellent summary of what the package does",
ProjectUrl = new Uri("https://github.com/SomeUser/TestNuGet/"),
IconUrl = new Uri("http://cdn.rawgit.com/SomeUser/TestNuGet/master/icons/testNuGet.png"),
LicenseUrl = new Uri("https://github.com/SomeUser/TestNuGet/blob/master/LICENSE.md"),
Copyright = "Some company 2015",
ReleaseNotes = new [] {"Bug fixes", "Issue fixes", "Typos"},
Tags = new [] {"Cake", "Script", "Build"},
RequireLicenseAcceptance= false,
Symbols = false,
NoPackageAnalysis = true,
Files = new [] {
new NuSpecContent {Source = "bin/TestNuGet.dll", Target = "bin"},
},
BasePath = "./src/TestNuGet/bin/release",
OutputDirectory = "./NuGet"
};
NuGetPack(nuGetPackSettings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetRestore(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Restores NuGet packages for the specified target.
</summary>
<param name="context">The context.</param>
<param name="targetFilePath">The target to restore.</param>
<example>
<code>
var solutions = GetFiles("./**/*.sln");
// Restore all NuGet packages.
foreach(var solution in solutions)
{
Information("Restoring {0}", solution);
NuGetRestore(solution);
}
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetRestore(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Restores NuGet packages for the specified targets.
</summary>
<param name="context">The context.</param>
<param name="targetFilePaths">The targets to restore.</param>
<example>
<code>
var solutions = GetFiles("./**/*.sln");
NuGetRestore(solutions);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetRestore(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings)">
<summary>
Restores NuGet packages using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="targetFilePath">The target to restore.</param>
<param name="settings">The settings.</param>
<example>
<code>
var solutions = GetFiles("./**/*.sln");
// Restore all NuGet packages.
foreach(var solution in solutions)
{
Information("Restoring {0}", solution);
NuGetRestore(solution, new NuGetRestoreSettings { NoCache = true });
}
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetRestore(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings)">
<summary>
Restores NuGet packages using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="targetFilePaths">The targets to restore.</param>
<param name="settings">The settings.</param>
<example>
<code>
var solutions = GetFiles("./**/*.sln");
NuGetRestore(solutions, new NuGetRestoreSettings { NoCache = true });
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetPush(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.NuGet.Push.NuGetPushSettings)">
<summary>
Pushes a NuGet package to a NuGet server and publishes it.
</summary>
<param name="context">The context.</param>
<param name="packageFilePath">The <c>.nupkg</c> file path.</param>
<param name="settings">The settings.</param>
<example>
<para>NOTE: Starting with NuGet 3.4.2, the Source parameter is a mandatory parameter.</para>
<para>It is strongly recommended that you ALWAYS set the Source property within the <see cref="T:Cake.Common.Tools.NuGet.Push.NuGetPushSettings" /> instance.</para>
<code>
// Get the path to the package.
var package = "./nuget/SlackPRTGCommander.0.0.1.nupkg";
// Push the package.
NuGetPush(package, new NuGetPushSettings {
Source = "http://example.com/nugetfeed",
ApiKey = "4003d786-cc37-4004-bfdf-c4f3e8ef9b3a"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetPush(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.NuGet.Push.NuGetPushSettings)">
<summary>
Pushes NuGet packages to a NuGet server and publishes them.
</summary>
<param name="context">The context.</param>
<param name="packageFilePaths">The <c>.nupkg</c> file paths.</param>
<param name="settings">The settings.</param>
<example>
<para>NOTE: Starting with NuGet 3.4.2, the Source parameter is a mandatory parameter.</para>
<para>It is strongly recommended that you ALWAYS set the Source property within the <see cref="T:Cake.Common.Tools.NuGet.Push.NuGetPushSettings" /> instance.</para>
<code>
// Get the paths to the packages.
var packages = GetFiles("./**/*.nupkg");
// Push the package.
NuGetPush(packages, new NuGetPushSettings {
Source = "http://example.com/nugetfeed",
ApiKey = "4003d786-cc37-4004-bfdf-c4f3e8ef9b3a"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetAddSource(Cake.Core.ICakeContext,System.String,System.String)">
<summary>
Adds NuGet package source using the specified name &source to global user config.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<param name="source">Path to the package(s) source.</param>
<example>
<code>
var feed = new
{
Name = EnvironmentVariable("PUBLIC_FEED_NAME"),
Source = EnvironmentVariable("PUBLIC_FEED_SOURCE")
};
NuGetAddSource(
name:feed.Name,
source:feed.Source
);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetAddSource(Cake.Core.ICakeContext,System.String,System.String,Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings)">
<summary>
Adds NuGet package source using the specified name, source & settings to global user config.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<param name="source">Path to the package(s) source.</param>
<param name="settings">The settings.</param>
<example>
<code>
var nugetSourceSettings = new NuGetSourcesSettings
{
UserName = EnvironmentVariable("PRIVATE_FEED_USERNAME"),
Password = EnvironmentVariable("PRIVATE_FEED_PASSWORD"),
IsSensitiveSource = true,
Verbosity = NuGetVerbosity.Detailed
};
var feed = new
{
Name = EnvironmentVariable("PRIVATE_FEED_NAME"),
Source = EnvironmentVariable("PRIVATE_FEED_SOURCE")
};
NuGetAddSource(
name:feed.Name,
source:feed.Source,
settings:nugetSourceSettings
);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetRemoveSource(Cake.Core.ICakeContext,System.String,System.String)">
<summary>
Removes NuGet package source using the specified name & source from global user config.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<param name="source">Path to the package(s) source.</param>
<example>
<code>
var feed = new
{
Name = EnvironmentVariable("PRIVATE_FEED_NAME"),
Source = EnvironmentVariable("PRIVATE_FEED_SOURCE")
};
NuGetRemoveSource(
name:feed.Name,
source:feed.Source
);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetRemoveSource(Cake.Core.ICakeContext,System.String,System.String,Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings)">
<summary>
Removes NuGet package source using the specified name, source & settings from global user config.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<param name="source">Path to the package(s) source.</param>
<param name="settings">The settings.</param>
<example>
<code>
var nugetSourceSettings = new NuGetSourcesSettings
{
UserName = EnvironmentVariable("PRIVATE_FEED_USERNAME"),
Password = EnvironmentVariable("PRIVATE_FEED_PASSWORD"),
IsSensitiveSource = true,
Verbosity = NuGetVerbosity.Detailed
};
var feed = new
{
Name = EnvironmentVariable("PRIVATE_FEED_NAME"),
Source = EnvironmentVariable("PRIVATE_FEED_SOURCE")
};
NuGetRemoveSource(
name:feed.Name,
source:feed.Source,
settings:nugetSourceSettings
);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetHasSource(Cake.Core.ICakeContext,System.String)">
<summary>
Checks whether or not a NuGet package source exists in the global user configuration, using the specified source.
</summary>
<param name="context">The context.</param>
<param name="source">Path to the package(s) source.</param>
<returns>Whether or not the NuGet package source exists in the global user configuration.</returns>
<example>
<code>
var feed = new
{
Name = EnvironmentVariable("PRIVATE_FEED_NAME"),
Source = EnvironmentVariable("PRIVATE_FEED_SOURCE")
};
if (!NuGetHasSource(source:feed.Source))
{
Information("Source missing");
}
else
{
Information("Source already exists");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetHasSource(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings)">
<summary>
Checks whether or not a NuGet package source exists in the global user configuration, using the specified source and settings.
</summary>
<param name="context">The context.</param>
<param name="source">Path to the package(s) source.</param>
<param name="settings">The settings.</param>
<returns>Whether the specified NuGet package source exist.</returns>
<example>
<code>
var nugetSourceSettings = new NuGetSourcesSettings
{
UserName = EnvironmentVariable("PRIVATE_FEED_USERNAME"),
Password = EnvironmentVariable("PRIVATE_FEED_PASSWORD"),
IsSensitiveSource = true,
Verbosity = NuGetVerbosity.Detailed
};
var feed = new
{
Name = EnvironmentVariable("PRIVATE_FEED_NAME"),
Source = EnvironmentVariable("PRIVATE_FEED_SOURCE")
};
if (!NuGetHasSource(
source:feed.Source,
settings:nugetSourceSettings))
{
Information("Source missing");
}
else
{
Information("Source already exists");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetInstall(Cake.Core.ICakeContext,System.String)">
<summary>
Installs a NuGet package.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to install.</param>
<example>
<code>
NuGetInstall("MyNuGetPackage");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetInstall(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Installs NuGet packages.
</summary>
<param name="context">The context.</param>
<param name="packageIds">The id's of the package to install.</param>
<example>
<code>
NuGetInstall(new[] { "MyNuGetPackage", "OtherNuGetPackage" });
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetInstall(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.NuGet.Install.NuGetInstallSettings)">
<summary>
Installs a NuGet package using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to install.</param>
<param name="settings">The settings.</param>
<example>
<code>
NuGetInstall("MyNuGetPackage", new NuGetInstallSettings {
ExcludeVersion = true,
OutputDirectory = "./tools"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetInstall(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Tools.NuGet.Install.NuGetInstallSettings)">
<summary>
Installs NuGet packages using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="packageIds">The id's of the package to install.</param>
<param name="settings">The settings.</param>
<example>
<code>
NuGetInstall(new[] { "MyNuGetPackage", "OtherNuGetPackage" }, new NuGetInstallSettings {
ExcludeVersion = true,
OutputDirectory = "./tools"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetInstallFromConfig(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Installs NuGet packages using the specified package configuration.
</summary>
<param name="context">The context.</param>
<param name="packageConfigPath">The package configuration to install.</param>
<example>
<code>
NuGetInstallFromConfig("./tools/packages.config");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetInstallFromConfig(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Installs NuGet packages using the specified package configurations.
</summary>
<param name="context">The context.</param>
<param name="packageConfigPaths">The package configurations to install.</param>
<example>
<code>
var packageConfigs = GetFiles("./**/packages.config");
NuGetInstallFromConfig(packageConfigs);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetInstallFromConfig(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.NuGet.Install.NuGetInstallSettings)">
<summary>
Installs NuGet packages using the specified package configuration and settings.
</summary>
<param name="context">The context.</param>
<param name="packageConfigPath">The package configuration to install.</param>
<param name="settings">The settings.</param>
<example>
<code>
NuGetInstallFromConfig("./tools/packages.config", new NuGetInstallSettings {
ExcludeVersion = true,
OutputDirectory = "./tools"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetInstallFromConfig(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.NuGet.Install.NuGetInstallSettings)">
<summary>
Installs NuGet packages using the specified package configurations and settings.
</summary>
<param name="context">The context.</param>
<param name="packageConfigPaths">The package configurations to install.</param>
<param name="settings">The settings.</param>
<example>
<code>
var packageConfigs = GetFiles("./**/packages.config");
NuGetInstallFromConfig(packageConfigs, new NuGetInstallSettings {
ExcludeVersion = true,
OutputDirectory = "./tools"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetSetApiKey(Cake.Core.ICakeContext,System.String,System.String,Cake.Common.Tools.NuGet.SetApiKey.NuGetSetApiKeySettings)">
<summary>
Installs NuGet packages using the specified API key, source and settings.
</summary>
<example>
<code>
var setting = new NuGetSetApiKeySettings {
Verbosity = NuGetVerbosity.Detailed
};
NuGetSetApiKey("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "https://nuget.org/api/v2/", setting);
</code>
</example>
<param name="context">The context.</param>
<param name="apiKey">The API key.</param>
<param name="source">Server URL where the API key is valid.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetSetApiKey(Cake.Core.ICakeContext,System.String,System.String)">
<summary>
Installs NuGet packages using the specified API key and source.
</summary>
<example>
<code>
NuGetSetApiKey("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "https://nuget.org/api/v2/");
</code>
</example>
<param name="context">The context.</param>
<param name="apiKey">The API key.</param>
<param name="source">Server URL where the API key is valid.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetSetProxy(Cake.Core.ICakeContext,System.String,System.String,System.String,Cake.Common.Tools.NuGet.SetProxy.NuGetSetProxySettings)">
<summary>
Set the proxy settings to be used while connecting to your NuGet feed, including settings.
</summary>
<example>
<code>
var setting = new NuGetSetProxySettings {
Verbosity = NuGetVerbosity.Detailed
};
NuGetSetProxy("127.0.0.1:8080", "proxyuser","Pa$$w0rd1", setting);
</code>
</example>
<param name="context">The context.</param>
<param name="proxy">The url of the proxy.</param>
<param name="username">The username used to access the proxy.</param>
<param name="password">The password used to access the proxy.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetSetProxy(Cake.Core.ICakeContext,System.String,System.String,System.String)">
<summary>
Set the proxy settings to be used while connecting to your NuGet feed.
</summary>
<example>
<code>
NuGetSetProxy("127.0.0.1:8080", "proxyuser","Pa$$w0rd1");
</code>
</example>
<param name="context">The context.</param>
<param name="proxy">The url of the proxy.</param>
<param name="username">The username used to access the proxy.</param>
<param name="password">The password used to access the proxy.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetUpdate(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Updates NuGet packages.
</summary>
<param name="context">The context.</param>
<param name="targetFile">The target to update.</param>
<example>
<code>
NuGetUpdate("./tools/packages.config");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetUpdate(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Updates NuGet packages.
</summary>
<param name="context">The context.</param>
<param name="targetFiles">The targets to update.</param>
<example>
<code>
var targets = GetFiles("./**/packages.config");
NuGetUpdate(targets);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetUpdate(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.NuGet.Update.NuGetUpdateSettings)">
<summary>
Updates NuGet packages using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="targetFile">The target to update.</param>
<param name="settings">The settings.</param>
<example>
<code>
NuGetUpdate("./tools/packages.config", new NuGetUpdateSettings {
Prerelease = true,
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetUpdate(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.NuGet.Update.NuGetUpdateSettings)">
<summary>
Updates NuGet packages using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="targetFiles">The targets to update.</param>
<param name="settings">The settings.</param>
<example>
<code>
var targets = GetFiles("./**/packages.config");
NuGetUpdate(targets, new NuGetUpdateSettings {
Prerelease = true,
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetAdd(Cake.Core.ICakeContext,System.String,System.String)">
<summary>
Adds a NuGet package using package id and source.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to add.</param>
<param name="source">Path to the local feed source.</param>
<example>
<code>
NuGetAdd("MyNuGetPackage", "//bar/packages/");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetAdd(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.NuGet.Add.NuGetAddSettings)">
<summary>
Adds a NuGet package using package id and source.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to add.</param>
<param name="settings">The settings.</param>
<example>
<code>
NuGetAdd("MyNuGetPackage", new NuGetAddSettings {
Source = "//bar/packages/"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetInit(Cake.Core.ICakeContext,System.String,System.String)">
<summary>
Adds all packages from source to destination.
</summary>
<param name="context">The context.</param>
<param name="source">The local feed package source.</param>
<param name="destination">The local feed destination source.</param>
<example>
<code>
NuGetInit("//foo/packages", "//bar/packages/");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetInit(Cake.Core.ICakeContext,System.String,System.String,Cake.Common.Tools.NuGet.Init.NuGetInitSettings)">
<summary>
Adds all packages from source to destination using specified settings.
</summary>
<param name="context">The context.</param>
<param name="source">The local feed package source.</param>
<param name="destination">The local feed destination source.</param>
<param name="settings">The settings.</param>
<example>
<code>
NuGetInit("//foo/packages", "//bar/packages/", new NuGetInitSettings {
Expand = true
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetList(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.NuGet.List.NuGetListSettings)">
<summary>
List packages on available from source using specified settings.
</summary>
<param name="context">The context.</param>
<param name="packageId">The package Id.</param>
<param name="settings">The settings.</param>
<returns>List of packages with their version.</returns>
<example>
<code>
var packageList = NuGetList("Cake", new NuGetListSettings {
AllVersions = false,
Prerelease = false
});
foreach(var package in packageList)
{
Information("Found package {0}, version {1}", package.Name, package.Version);
}
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetList(Cake.Core.ICakeContext,System.String)">
<summary>
List packages on available from source using specified settings.
</summary>
<param name="context">The context.</param>
<param name="packageId">The package Id.</param>
<returns>List of packages with their version.</returns>
<example>
<code>
var packageList = NuGetList("Cake");
foreach(var package in packageList)
{
Information("Found package {0}, version {1}", package.Name, package.Version);
}
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetList(Cake.Core.ICakeContext,Cake.Common.Tools.NuGet.List.NuGetListSettings)">
<summary>
List packages on available from source using specified settings.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<returns>List of packages with their version.</returns>
<example>
<code>
var packageList = NuGetList(new NuGetListSettings {
AllVersions = false,
Prerelease = false
});
foreach(var package in packageList)
{
Information("Found package {0}, version {1}", package.Name, package.Version);
}
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetDelete(Cake.Core.ICakeContext,System.String,System.String,Cake.Common.Tools.NuGet.Delete.NuGetDeleteSettings)">
<summary>
Deletes or unlists a package from a package source.
</summary>
<param name="context">The context.</param>
<param name="packageID">The package ID (name).</param>
<param name="packageVersion">The package version.</param>
<param name="settings">The settings.</param>
<example>
<para>NOTE: Starting with NuGet 3.4.2, the Source parameter is a mandatory parameter.</para>
<para>It is strongly recommended that you ALWAYS set the Source property within the <see cref="T:Cake.Common.Tools.NuGet.Delete.NuGetDeleteSettings" /> instance.</para>
<code>
// Delete the package.
NuGetDelete("PackageName", "PackageVersion", new NuGetPushSettings {
Source = "http://example.com/nugetfeed",
ApiKey = "4003d786-cc37-4004-bfdf-c4f3e8ef9b3a"
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.NuGet.NuGetMSBuildVersion">
<summary>
NuGet MSBuild version.
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild4">
<summary>
MSBuildVersion : <c>4</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild12">
<summary>
MSBuildVersion : <c>12</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild14">
<summary>
MSBuildVersion : <c>14</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild15_1">
<summary>
MSBuildVersion : <c>15.1</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild15_3">
<summary>
MSBuildVersion : <c>15.3</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild15_4">
<summary>
MSBuildVersion : <c>15.4</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild15_5">
<summary>
MSBuildVersion : <c>15.5</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild15_6">
<summary>
MSBuildVersion : <c>15.6</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild15_7">
<summary>
MSBuildVersion : <c>15.7</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild15_8">
<summary>
MSBuildVersion : <c>15.8</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild15_9">
<summary>
MSBuildVersion : <c>15.9</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild16_0">
<summary>
MSBuildVersion : <c>16.0</c>
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.NuGetMSBuildVersionExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Common.Tools.NuGet.NuGetMSBuildVersion"/>.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetMSBuildVersionExtensions.GetNuGetMSBuildVersionString(Cake.Common.Tools.NuGet.NuGetMSBuildVersion)">
<summary>
Gets the string with MSBuild version.
</summary>
<param name="nuGetMSBuildVersion">The NuGet MSBuild version.</param>
<returns>The string with MSBuild version.</returns>
</member>
<member name="T:Cake.Common.Tools.NuGet.NuGetTool`1">
<summary>
Base class for all NuGet related tools.
</summary>
<typeparam name="TSettings">The settings type.</typeparam>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetTool`1.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.NuGetTool`1"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetTool`1.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetTool`1.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetTool`1.GetAlternativeToolPaths(`0)">
<summary>
Gets alternative file paths which the tool may exist in.
</summary>
<param name="settings">The settings.</param>
<returns>The default tool path.</returns>
</member>
<member name="T:Cake.Common.Tools.NuGet.NuGetVerbosity">
<summary>
Represents NuGet verbosity.
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetVerbosity.Normal">
<summary>
Verbosity: <c>Normal</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetVerbosity.Quiet">
<summary>
Verbosity: <c>Quiet</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetVerbosity.Detailed">
<summary>
Verbosity: <c>Detailed</c>
</summary>
</member>
<member name="T:Cake.Common.Tools.NUnit.NamespaceDoc">
<summary>
This namespace contain types used to interact with NUnit.
</summary>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnit3Aliases">
<summary>
<para>Contains functionality related to running <see href="https://github.com/nunit/nunit">NUnit</see> v2 and v3 unit tests.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.NUnit.NUnit3Settings" /> class:
<code>
#tool "nuget:?package=NUnit.ConsoleRunner"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnit3Aliases.NUnit3(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Runs all NUnit unit tests in the assemblies matching the specified pattern.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<example>
<code>
NUnit3("./src/**/bin/Release/*.Tests.dll");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnit3Aliases.NUnit3(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.NUnit.NUnit3Settings)">
<summary>
Runs all NUnit unit tests in the assemblies matching the specified pattern,
using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="settings">The settings.</param>
<example>
<code>
NUnit3("./src/**/bin/Release/*.Tests.dll", new NUnit3Settings {
NoResults = true
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnit3Aliases.NUnit3(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Runs all NUnit unit tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<example>
<code>
NUnit3(new [] { "./src/Example.Tests/bin/Release/Example.Tests.dll" });
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnit3Aliases.NUnit3(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Runs all NUnit unit tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<example>
<code>
var testAssemblies = GetFiles("./src/**/bin/Release/*.Tests.dll");
NUnit3(testAssemblies);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnit3Aliases.NUnit3(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Tools.NUnit.NUnit3Settings)">
<summary>
Runs all NUnit unit tests in the specified assemblies,
using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
<example>
<code>
NUnit3(new [] { "./src/Example.Tests/bin/Release/Example.Tests.dll" }, new NUnit3Settings {
NoResults = true
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnit3Aliases.NUnit3(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.NUnit.NUnit3Settings)">
<summary>
Runs all NUnit unit tests in the specified assemblies,
using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
<example>
<code>
var testAssemblies = GetFiles("./src/**/bin/Release/*.Tests.dll");
NUnit3(testAssemblies, new NUnit3Settings {
NoResults = true
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnit3AppDomainUsage">
<summary>
The /domain option controls of the creation of AppDomains for running tests.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3AppDomainUsage.Default">
<summary>
Create a separate AppDomain for each assembly if more than one is listed on the command
line, otherwise creates a single AppDomain.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3AppDomainUsage.None">
<summary>
No AppDomain is created - the tests are run in the primary domain.
This normally requires copying the NUnit assemblies into the same directory as your tests.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3AppDomainUsage.Single">
<summary>
A single test AppDomain is created for all test assemblies
This is how NUnit worked prior to version 2.4.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3AppDomainUsage.Multiple">
<summary>
An AppDomain is created for each assembly specified on the command line.
</summary>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnit3Labels">
<summary>
Represents the possible values for the Labels option.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3Labels.Off">
<summary>
Does not output labels. This is the default.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3Labels.On">
<summary>
Outputs labels for tests that are run.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3Labels.All">
<summary>
Outputs labels for all tests.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3Labels.Before">
<summary>
Outputs labels at the start of every test.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3Labels.After">
<summary>
Outputs labels at the end of every test.
</summary>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnit3ProcessOption">
<summary>
Represents the various ways NUnit loads tests in processes.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3ProcessOption.Multiple">
<summary>
A separate process is created for each test assembly. This is the default.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3ProcessOption.Separate">
<summary>
One separate process is created to run all of the test assemblies.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3ProcessOption.InProcess">
<summary>
All the tests are run in the nunit-console process.
</summary>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnit3Result">
<summary>
Contains information for the results that should be exported.
</summary>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Result.FileName">
<summary>
Gets or sets the name of the XML result file.
</summary>
<value>
The name of the XML result file. Defaults to <c>TestResult.xml</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Result.Format">
<summary>
Gets or sets the format that the results should be in. <see cref="P:Cake.Common.Tools.NUnit.NUnit3Result.FileName"/> must be set to
have any effect. Specify nunit2 to output the results in NUnit 2 xml format.
nunit3 may be specified for NUnit 3 format, however this is the default. Additional
formats may be supported in the future, check the NUnit documentation.
</summary>
<value>
The format of the result file. Defaults to <c>nunit3</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Result.Transform">
<summary>
Gets or sets the file name of an XSL transform that will be applied to the results.
</summary>
<value>
The name of an XSLT file that will be applied to the results.
</value>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnit3Runner">
<summary>
The NUnit3 unit test runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnit3Runner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NUnit.NUnit3Runner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnit3Runner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.NUnit.NUnit3Settings)">
<summary>
Runs the tests in the specified assemblies, using the specified settings.
</summary>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnit3Runner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnit3Runner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnit3Runner.ProcessExitCode(System.Int32)">
<summary>
Customized NUnit 3 exit code handling.
Throws <see cref="T:Cake.Core.CakeException"/> on non-zero exit code.
</summary>
<param name="exitCode">The process exit code.</param>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnit3Settings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NUnit.NUnit3Runner" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Test">
<summary>
Gets or sets the list of tests to run or explore.
</summary>
<value>
A comma-separated list of test names.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.TestList">
<summary>
Gets or sets a file containing the tests to run.
</summary>
<value>
File path containing a list of tests to run, one per line.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Where">
<summary>
Gets or sets the test selection expression indicating what tests will be run.
</summary>
<value>
The --where option is intended to extend or replace the earlier
--test, --include and --exclude options by use of a selection expression
describing exactly which tests to use. Examples of usage are:
--where:cat==Data
--where "method =~ /DataTest*/ && cat = Slow"
See <a href="https://github.com/nunit/docs/wiki/Test-Selection-Language">https://github.com/nunit/docs/wiki/Test-Selection-Language</a>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Timeout">
<summary>
Gets or sets the default timeout to be used for test cases in this run.
If any test exceeds the timeout value, it is cancelled and reported as an error.
</summary>
<value>
The timeout in milliseconds.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Seed">
<summary>
Gets or sets the random seed used to generate test cases.
</summary>
<value>
The random seed.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Workers">
<summary>
Gets or sets the number of worker threads to be used
in running tests.If not specified, defaults to
2 or the number of processors, whichever is greater.
</summary>
<value>
The number of worker threads.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.StopOnError">
<summary>
Gets or sets a value indicating whether execution of the test run should terminate
immediately on the first test failure or error.
</summary>
<value>
<c>true</c> if execution of the test run should terminate immediately on the first test failure or error;
otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.SkipNonTestAssemblies">
<summary>
Gets or sets a value indicating whether execution of the test run should
skip any non-test assemblies specified, without error.
</summary>
<value>
<c>true</c> if execution of the test run should skip any non-test assemblies specified, without error;
otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Work">
<summary>
Gets or sets the directory to use for output files. If
not specified, defaults to the current directory.
</summary>
<value>
PATH of the directory.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.OutputFile">
<summary>
Gets or sets the location that NUnit should write test output.
</summary>
<value>The location that NUnit should write test output.</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Results">
<summary>
Gets or sets the results that should be saved.
</summary>
<value>The package owners.</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.NoResults">
<summary>
Gets or sets a value indicating whether to generate the XML result file.
</summary>
<value>
<c>true</c> if the XML result file should be generated; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Labels">
<summary>
Gets or sets a value specifying whether to write test case names to the output.
</summary>
<value>
<c>On</c> to write labels for tests that are run,<c>All</c> to write labels
for all tests,<c>Before</c> to write labels at the start of every test
,or <c>After</c> to write labels at the end of every test.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.TeamCity">
<summary>
Gets or sets a value indicating whether to turn on TeamCity service messages.
</summary>
<value>
<c>true</c> to turn on TeamCity service messages; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.NoHeader">
<summary>
Gets or sets a value indicating whether to show copyright information at the start of the program.
</summary>
<value>
<c>true</c> if to show copyright information at the start of the program; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.NoColor">
<summary>
Gets or sets a value indicating whether to show the output in color.
</summary>
<value>
<c>true</c> disable color output; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Configuration">
<summary>
Gets or sets the name of a project configuration to load (e.g.:Debug).
This selects the configuration within the NUnit project file.
</summary>
<value>
The name of the configuration to load.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.X86">
<summary>
Gets or sets a value indicating whether to run tests in an x86 process on 64 bit systems.
</summary>
<value>
<c>true</c> to run tests in an x86 process on 64 bit systems; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.DisposeRunners">
<summary>
Gets or sets a value indicating whether to Dispose each test runner after it has finished
running its tests.
</summary>
<value>
<c>true</c> to Dispose each test runner after it has finished
running its tests; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.ShadowCopy">
<summary>
Gets or sets a value indicating whether to shadow copy tests.
Default value is <c>false</c>.
</summary>
<value>
<c>true</c> if tests should be run as a shadow copy; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Framework">
<summary>
Gets or sets the version of the runtime to be used when executing tests.
</summary>
<value>
The version of the runtime to be used when executing tests.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Process">
<summary>
Gets or sets a value indicating how NUnit should load tests in processes.
The Default value is <see cref="F:Cake.Common.Tools.NUnit.NUnit3ProcessOption.Multiple"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.AppDomainUsage">
<summary>
Gets or sets a value to control creation of AppDomains for running tests.
Corresponds to the /domain command line switch.
The default is to use multiple domains if multiple assemblies are listed on the command line,
otherwise a single domain is used.
</summary>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Agents">
<summary>
Gets or sets the maximum number of test assembly agents to run at one
time. If not specified, there is no limit.
</summary>
<value>
The maximum number of test assembly agents to run at one time.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.ConfigFile">
<summary>
Gets or sets a value indicating the path to an alternative app.config file to load.
</summary>
<value>The location that NUnit should load an alternative app.config file from.</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Params">
<summary>
Gets or sets the parameters that should be passed to the runner.
</summary>
<value>
List of parameters (key/value) which are passed to the runner.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.TestParams">
<summary>
Gets or sets the test parameters that should be passed to the runner.
</summary>
<value>
List of test parameters (key/value) which are passed to the runner.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.TraceLevel">
<summary>
Gets or sets the level of detail at which the runner should write to its internal trace log.
Corresponds to the -trace=LEVEL command line argument.
If <c>null</c>, no argument will be specified.
</summary>
<value>
The trace level.
</value>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnitAliases">
<summary>
<para>Contains functionality related to running <see href="https://github.com/nunit/nunit">NUnit</see> tests.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.NUnit.NUnitSettings" /> class:
<code>
#tool "nuget:?package=NUnit.Runners&version=2.6.4"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitAliases.NUnit(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Runs all NUnit unit tests in the assemblies matching the specified pattern.
</summary>
<example>
<code>
NUnit("./src/UnitTests/*.dll");
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitAliases.NUnit(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.NUnit.NUnitSettings)">
<summary>
Runs all NUnit unit tests in the assemblies matching the specified pattern,
using the specified settings.
</summary>
<example>
<code>
NUnit("./src/UnitTests/*.dll", new NUnitSettings {
Timeout = 4000,
StopOnError = true
});
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitAliases.NUnit(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Runs all NUnit unit tests in the specified assemblies.
</summary>
<example>
<code>
var assemblies = new [] {
"UnitTests1.dll",
"UnitTests2.dll"
};
NUnit(assemblies);
</code>
</example>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitAliases.NUnit(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Runs all NUnit unit tests in the specified assemblies.
</summary>
<example>
<code>
var assemblies = GetFiles("./src/UnitTests/*.dll");
NUnit(assemblies);
</code>
</example>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitAliases.NUnit(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Tools.NUnit.NUnitSettings)">
<summary>
Runs all NUnit unit tests in the specified assemblies,
using the specified settings.
</summary>
<example>
<code>
var assemblies = new [] {
"UnitTests1.dll",
"UnitTests2.dll"
};
NUnit(assemblies, new NUnitSettings {
Timeout = 4000,
StopOnError = true
});
</code>
</example>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitAliases.NUnit(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.NUnit.NUnitSettings)">
<summary>
Runs all NUnit unit tests in the specified assemblies,
using the specified settings.
</summary>
<example>
<code>
var assemblies = GetFiles(""./src/UnitTests/*.dll"");
NUnit(assemblies, new NUnitSettings {
Timeout = 4000,
StopOnError = true
});
</code>
</example>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnitAppDomainUsage">
<summary>
The /domain option controls of the creation of AppDomains for running tests.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitAppDomainUsage.Default">
<summary>
Create a separate AppDomain for each assembly listed on the command line.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitAppDomainUsage.None">
<summary>
No domain is created - the tests are run in the primary domain.
This normally requires copying the NUnit assemblies into the same directory as your tests.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitAppDomainUsage.Single">
<summary>
A test domain is created - this is how NUnit worked prior to version 2.4
</summary>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnitInternalTraceLevel">
<summary>
Represents the level of detail at which NUnit should set internal tracing.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitInternalTraceLevel.Off">
<summary>
Do not display any trace messages
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitInternalTraceLevel.Error">
<summary>
Display Error messages only
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitInternalTraceLevel.Warning">
<summary>
Display Warning level and higher messages
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitInternalTraceLevel.Info">
<summary>
Display informational and higher messages
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitInternalTraceLevel.Debug">
<summary>
Display debug messages and higher - i.e. all messages
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitInternalTraceLevel.Verbose">
<summary>
Display debug messages and higher - i.e. all messages
</summary>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnitInternalTraceLevelExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Common.Tools.NUnit.NUnitInternalTraceLevel"/>.
</summary>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitInternalTraceLevelExtensions.GetArgumentValue(Cake.Common.Tools.NUnit.NUnitInternalTraceLevel)">
<summary>
Gets the LEVEL value for the --trace command line argument for the given <see cref="T:Cake.Common.Tools.NUnit.NUnitInternalTraceLevel"/>.
</summary>
<param name="level">The <see cref="T:Cake.Common.Tools.NUnit.NUnitInternalTraceLevel"/> value for which to get the <see cref="T:System.String"/> representation.</param>
<returns>Returns the appropriate <see cref="T:System.String"/> representation for the given <see cref="T:Cake.Common.Tools.NUnit.NUnitInternalTraceLevel"/> value.</returns>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnitProcessOption">
<summary>
Represents the various ways NUnit loads tests in processes.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitProcessOption.Single">
<summary>
All the tests are run in the nunit-console process. This is the default.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitProcessOption.Separate">
<summary>
A separate process is created to run the tests.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitProcessOption.Multiple">
<summary>
A separate process is created for each test assembly.
</summary>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnitRunner">
<summary>
The NUnit unit test runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NUnit.NUnitRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitRunner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.NUnit.NUnitSettings)">
<summary>
Runs the tests in the specified assemblies, using the specified settings.
</summary>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitRunner.ProcessExitCode(System.Int32)">
<summary>
Customized NUnit exit code handling.
Throws <see cref="T:Cake.Core.CakeException"/> on non-zero exit code.
</summary>
<param name="exitCode">The process exit code.</param>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnitSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NUnit.NUnitRunner" />.
</summary>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NUnit.NUnitSettings" /> class.
</summary>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.ResultsFile">
<summary>
Gets or sets the name of the XML result file.
</summary>
<value>
The name of the XML result file. Defaults to <c>TestResult.xml</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.NoResults">
<summary>
Gets or sets a value indicating whether to generate the XML result file.
</summary>
<value>
<c>true</c> if the XML result file should be generated; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.Framework">
<summary>
Gets or sets the version of the runtime to be used when executing tests.
</summary>
<value>
The version of the runtime to be used when executing tests.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.Include">
<summary>
Gets or sets the categories to include in a run.
</summary>
<value>The categories to include in a run.</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.Exclude">
<summary>
Gets or sets the categories to exclude from a run.
</summary>
<value>
The categories to exclude from a run.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.Timeout">
<summary>
Gets or sets the default timeout to be used for test cases in this run.
If any test exceeds the timeout value, it is cancelled and reported as an error.
</summary>
<value>The default timeout to be used for test cases in this run.</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.ShadowCopy">
<summary>
Gets or sets a value indicating whether tests should be run as a shadow copy.
Default value is <c>true</c>.
</summary>
<value>
<c>true</c> if tests should be run as a shadow copy; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.NoThread">
<summary>
Gets or sets a value indicating whether the main thread should be used for running tests.
</summary>
<value>
<c>true</c> if the main thread should be used for running tests; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.NoLogo">
<summary>
Gets or sets a value indicating whether to show copyright information at the start of the program.
</summary>
<value>
<c>true</c> if to show copyright information at the start of the program; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.StopOnError">
<summary>
Gets or sets a value indicating whether execution of the test run should terminate
immediately on the first test failure or error.
</summary>
<value>
<c>true</c> if execution of the test run should terminate immediately on the first test failure or error;
otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.Trace">
<summary>
Gets or sets the amount of information that NUnit should write to its internal trace log.
</summary>
<value>The amount of information that NUnit should write to its internal trace log.</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.OutputFile">
<summary>
Gets or sets the location that NUnit should write test output.
</summary>
<value>The location that NUnit should write test output.</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.ErrorOutputFile">
<summary>
Gets or sets the location that NUnit should write test error output.
</summary>
<value>The location that NUnit should write test error output.</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.Process">
<summary>
Gets or sets a value indicating how NUnit should load tests in processes.
The Default value is <see cref="F:Cake.Common.Tools.NUnit.NUnitProcessOption.Single"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.UseSingleThreadedApartment">
<summary>
Gets or sets a value indicating whether Single Threaded Apartment state (STA) will be used.
Corresponds to the /apartment command line option.
</summary>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.AppDomainUsage">
<summary>
Gets or sets a value to control creation of AppDomains for running tests.
Corresponds to the /domain command line switch.
The default is to use multiple domains if multiple assemblies are listed on the command line.
Otherwise a single domain is used.
</summary>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.X86">
<summary>
Gets or sets a value indicating whether to run tests in an x86 process on 64 bit systems.
</summary>
<value>
<c>true</c> to run tests in an x86 process on 64 bit systems; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.Labels">
<summary>
Gets or sets a value indicating whether to cause an identifying label to be displayed at the start of each test case.
</summary>
<value>
<c>true</c> to cause an identifying label to be displayed at the start of each test case; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.NamespaceDoc">
<summary>
This namespace contain types used
to interact with Octopus Deploy.
</summary>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings">
<summary>
Contains settings used by <see cref="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseCreator.CreateRelease(System.String,Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings)"/>.
See Octopus Deploy documentation <see href="http://docs.octopusdeploy.com/display/OD/Creating+releases">here</see>.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings"/> class.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.ReleaseNumber">
<summary>
Gets or sets the release number to use for the new release.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.DefaultPackageVersion">
<summary>
Gets or sets the default version number of all packages to use the new release.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.Packages">
<summary>
Gets or sets the version number to use for a package in the release.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.PackagesFolder">
<summary>
Gets or sets the folder containing NuGet packages.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.ReleaseNotes">
<summary>
Gets or sets the release notes for the new release.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.ReleaseNotesFile">
<summary>
Gets or sets the path to a file that contains Release Notes for the new release.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.IgnoreExisting">
<summary>
Gets or sets a value indicating whether to Ignore Existing release flag.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.DeployTo">
<summary>
Gets or sets environment to automatically deploy to, e.g., Production.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.ShowProgress">
<summary>
Gets or sets a value indicating whether progress of the deployment should be followed. (Sets --waitfordeployment and --norawlog to true.)
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.ForcePackageDownload">
<summary>
Gets or sets a value indicating whether to force downloading of already installed packages. Default false.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.WaitForDeployment">
<summary>
Gets or sets a value indicating whether to wait synchronously for deployment to finish.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.DeploymentTimeout">
<summary>
Gets or sets maximum time (timespan format) that the console session will wait for the deployment to finish (default 00:10:00).
This will not stop the deployment. Requires WaitForDeployment parameter set.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.CancelOnTimeout">
<summary>
Gets or sets a value indicating whether to cancel the deployment if the deployment timeout is reached(default false).
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.DeploymentChecksLeepCycle">
<summary>
Gets or sets how much time should elapse between deployment status checks(default 00:00:10).
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.GuidedFailure">
<summary>
Gets or sets a value indicating whether to use Guided Failure mode. If not specified, will use default setting from environment.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.SpecificMachines">
<summary>
Gets or sets list of machines names to target in the deployed environment.If not specified all machines in the environment will be considered.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.Force">
<summary>
Gets or sets a value indicating whether a project is configured to skip packages with already-installed versions, override this setting to force re-deployment (flag, default false).
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.SkipSteps">
<summary>
Gets or sets a list of steps to be skipped. Takes step names.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.NoRawLog">
<summary>
Gets or sets a value indicating whether print the raw log of failed tasks or not.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.RawLogFile">
<summary>
Gets or sets a file where to redirect the raw log of failed tasks.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.Variables">
<summary>
Gets or sets values for any prompted variables.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.DeployAt">
<summary>
Gets or sets time at which deployment should start (scheduled deployment), specified as any valid DateTimeOffset format, and assuming the time zone is the current local time zone.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.Tenant">
<summary>
Gets or sets a tenant the deployment will be performed for; specify this argument multiple times to add multiple tenants or use `*` wildcard to deploy to tenants able to deploy.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.TenantTags">
<summary>
Gets or sets a tenant tags used to match tenants that the deployment will be performed for; specify this argument multiple times to add multiple tenant tags.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.Channel">
<summary>
Gets or sets the octopus channel for the new release.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.IgnoreChannelRules">
<summary>
Gets or sets a value indicating whether octopus channel rules should be ignored.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.DeploymentProgress">
<summary>
Gets or sets a value indicating whether progress of the deployment will be shown.
</summary>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.DeploymentQueryResultParser">
<summary>
Parses the Console Output of the Octo.exe call when called with list-deployments.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.DeploymentQueryResultParser.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OctopusDeploy.DeploymentQueryResultParser"/> class.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.DeploymentQueryResultParser.ParseResults(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Parse the results from The Deployment Query.
</summary>
<param name="output">Console Output from the Run Process.</param>
<returns>A collection of Octopus deployments.</returns>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.DeploymentQueryResultParser.ParseSet(System.Collections.Generic.List{System.String})">
<summary>
Parses a set of lines from the output.
</summary>
<param name="lineSet">A set of lines to parse.</param>
<returns>an OctopusDeployment or null.</returns>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployAliases">
<summary>
<para>Contains functionality related to <see href="https://octopus.com/">Octopus Deploy</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the appropriate settings class:
<code>
#tool "nuget:?package=OctopusTools"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployAliases.OctoCreateRelease(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings)">
<summary>
Creates a release for the specified Octopus Deploy Project.
</summary>
<param name="context">The cake context.</param>
<param name="projectName">The name of the project.</param>
<param name="settings">The settings.</param>
<example>
<code>
// Minimum required
OctoCreateRelease(projectNameOnServer, new CreateReleaseSettings {
Server = "http://octopus-deploy.example",
ApiKey = "API-XXXXXXXXXXXXXXXXXXXX"
});
OctoCreateRelease(projectNameOnServer, new CreateReleaseSettings {
Server = "http://octopus-deploy.example",
Username = "DeployUser",
Password = "a-very-secure-password"
});
OctoCreateRelease(projectNameOnServer, new CreateReleaseSettings {
ConfigurationFile = @"C:\OctopusDeploy.config"
});
// Additional Options
OctoCreateRelease(projectNameOnServer, new CreateReleaseSettings {
ToolPath = "./tools/OctopusTools/Octo.exe"
EnableDebugLogging = true,
IgnoreSslErrors = true,
EnableServiceMessages = true, // Enables teamcity services messages when logging
ReleaseNumber = "1.8.2",
DefaultPackageVersion = "1.0.0.0", // All packages in the release should be 1.0.0.0
Packages = new Dictionary<string, string>
{
{ "PackageOne", "1.0.2.3" },
{ "PackageTwo", "5.2.3" }
},
PackagesFolder = @"C:\MyOtherNuGetFeed",
// One or the other
ReleaseNotes = "Version 2.0 \n What a milestone we have ...",
ReleaseNotesFile = "./ReleaseNotes.md",
IgnoreExisting = true // if this release number already exists, ignore it
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployAliases.OctoPush(Cake.Core.ICakeContext,System.String,System.String,Cake.Core.IO.FilePath,Cake.Common.Tools.OctopusDeploy.OctopusPushSettings)">
<summary>
Pushes the specified package to the Octopus Deploy repository.
</summary>
<param name="context">The cake context.</param>
<param name="server">The Octopus server URL.</param>
<param name="apiKey">The user's API key.</param>
<param name="packagePath">Path to the package.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployAliases.OctoPush(Cake.Core.ICakeContext,System.String,System.String,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.OctopusDeploy.OctopusPushSettings)">
<summary>
Pushes the specified packages to the Octopus Deploy repository.
</summary>
<param name="context">The cake context.</param>
<param name="server">The Octopus server URL.</param>
<param name="apiKey">The user's API key.</param>
<param name="packagePaths">Paths to the packages.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployAliases.OctoPack(Cake.Core.ICakeContext,System.String)">
<summary>
Packs the specified folder into an Octopus Deploy package.
</summary>
<param name="context">The cake context.</param>
<param name="id">The package ID.</param>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployAliases.OctoPack(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.OctopusDeploy.OctopusPackSettings)">
<summary>
Packs the specified folder into an Octopus Deploy package.
</summary>
<param name="context">The cake context.</param>
<param name="id">The package ID.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployAliases.OctoDeployRelease(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String,System.String,Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings)">
<summary>
Deploys the specified already existing release into a specified environment
See <see href="http://docs.octopusdeploy.com/display/OD/Deploying+releases">Octopus Documentation</see> for more details.
</summary>
<param name="context">The cake context.</param>
<param name="server">The Octopus server URL.</param>
<param name="apiKey">The user's API key.</param>
<param name="projectName">Name of the target project.</param>
<param name="deployTo">Target environment name.</param>
<param name="releaseNumber">Version number of the release to deploy. Specify "latest" for the latest release.</param>
<param name="settings">Deployment settings.</param>
<example>
<code>
// bare minimum
OctoDeployRelease("http://octopus-deploy.example", "API-XXXXXXXXXXXXXXXXXXXX", "MyGreatProject", "Testing", "2.1.15-RC" new OctopusDeployReleaseDeploymentSettings());
// All of deployment arguments
OctoDeployRelease("http://octopus-deploy.example", "API-XXXXXXXXXXXXXXXXXXXX", "MyGreatProject", "Testing", "2.1.15-RC" new OctopusDeployReleaseDeploymentSettings {
ShowProgress = true,
ForcePackageDownload = true,
WaitForDeployment = true,
DeploymentTimeout = TimeSpan.FromMinutes(1),
CancelOnTimeout = true,
DeploymentChecksLeapCycle = TimeSpan.FromMinutes(77),
GuidedFailure = true,
SpecificMachines = new string[] { "Machine1", "Machine2" },
Force = true,
SkipSteps = new[] { "Step1", "Step2" },
NoRawLog = true,
RawLogFile = "someFile.txt",
DeployAt = new DateTime(2010, 6, 15).AddMinutes(1),
Tenant = new[] { "Tenant1", "Tenant2" },
TenantTags = new[] { "Tag1", "Tag2" },
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployAliases.OctoPromoteRelease(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String,System.String,Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings)">
<summary>
Promotes the specified already existing release into a specified environment
See <see href="https://octopus.com/docs/api-and-integration/octo.exe-command-line/promoting-releases">Octopus Documentation</see> for more details.
</summary>
<param name="context">The cake context.</param>
<param name="server">The Octopus server URL.</param>
<param name="apiKey">The user's API key.</param>
<param name="projectName">Name of the target project.</param>
<param name="deployFrom">Source environment name.</param>
<param name="deployTo">Target environment name.</param>
<param name="settings">Deployment settings.</param>
<example>
<code>
// bare minimum
OctoPromoteRelease("http://octopus-deploy.example", "API-XXXXXXXXXXXXXXXXXXXX", "MyGreatProject", "Testing", "Staging", new OctopusDeployPromoteReleaseSettings());
// All of deployment arguments
OctoPromoteRelease("http://octopus-deploy.example", "API-XXXXXXXXXXXXXXXXXXXX", "MyGreatProject", "Testing", "Staging", new OctopusDeployPromoteReleaseSettings {
ShowProgress = true,
ForcePackageDownload = true,
WaitForDeployment = true,
DeploymentTimeout = TimeSpan.FromMinutes(1),
CancelOnTimeout = true,
DeploymentChecksLeapCycle = TimeSpan.FromMinutes(77),
GuidedFailure = true,
SpecificMachines = new string[] { "Machine1", "Machine2" },
Force = true,
SkipSteps = new[] { "Step1", "Step2" },
NoRawLog = true,
RawLogFile = "someFile.txt",
DeployAt = new DateTime(2010, 6, 15).AddMinutes(1),
Tenant = new[] { "Tenant1", "Tenant2" },
TenantTags = new[] { "Tag1", "Tag2" },
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployDeploymentQuerier">
<summary>
Allows you to query your Octopus Deploy server deployment history.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployDeploymentQuerier.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployDeploymentQuerier"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployDeploymentQuerier.QueryOctopusDeployments(System.String,System.String,Cake.Common.Tools.OctopusDeploy.OctopusDeploymentQuerySettings)">
<summary>
Pushes the specified packages to Octopus Deploy internal repository.
</summary>
<param name="server">The Octopus server URL.</param>
<param name="apiKey">The user's API key.</param>
<param name="querySettings">The query.</param>
<returns>A list of Octopus Deployments.</returns>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployment">
<summary>
An object representing a deployment in Octopus Deploy.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployment.ProjectName">
<summary>
gets or sets the Name of the Deployment's Project.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployment.Environment">
<summary>
gets or sets the Environment the project was deployed to.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployment.Channel">
<summary>
gets or sets the Deployment's channel.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployment.Created">
<summary>
gets or sets When the deployment was created.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployment.Assembled">
<summary>
gets or sets when the deployment was assembled.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployment.Version">
<summary>
gets or sets the deployed project version.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployment.PackageVersions">
<summary>
gets or sets the list of packages in the deployment.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployment.ReleaseNotesHtml">
<summary>
gets or sets the release notes for the deployment (HTML Markup).
</summary>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeploymentQuerySettings">
<summary>
Contains settings used by <see cref="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployDeploymentQuerier.QueryOctopusDeployments(System.String,System.String,Cake.Common.Tools.OctopusDeploy.OctopusDeploymentQuerySettings)"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeploymentQuerySettings.EnvironmentName">
<summary>
Gets or Sets a value that is an Octopus Environment Name to filter for.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeploymentQuerySettings.ProjectName">
<summary>
Gets or Sets a value that is an Octopus Project Name to filter for.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeploymentQuerySettings.TenantName">
<summary>
Gets or Sets a value that is an Octopus Tenant Name to filter for.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeploymentQuerySettings.Count">
<summary>
Gets or Sets a value that indicates how many deployments to retrieve
in Date Descending order (most recent first)
Default: 1.
</summary>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployPacker">
<summary>
The Octopus deploy package packer.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployPacker.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployPacker"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployPacker.Pack(System.String,Cake.Common.Tools.OctopusDeploy.OctopusPackSettings)">
<summary>
Creates an Octopus deploy package with the specified ID.
</summary>
<param name="id">The package ID.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings">
<summary>
Possible arguments to pass to Octo.exe for promoting a release. See <see href="https://octopus.com/docs/api-and-integration/octo.exe-command-line/promoting-releases">Octopus Deploy documentation</see>.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings"/> class.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.UpdateVariables">
<summary>
Gets or sets a value indicating whether overwrite the variable snapshot for the release by re-importing the variables from the project.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.ShowProgress">
<summary>
Gets or sets a value indicating whether progress of the deployment should be followed. (Sets --waitfordeployment and --norawlog to true.)
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.ForcePackageDownload">
<summary>
Gets or sets a value indicating whether to force downloading of already installed packages. Default false.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.WaitForDeployment">
<summary>
Gets or sets a value indicating whether to wait synchronously for deployment to finish.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.DeploymentTimeout">
<summary>
Gets or sets maximum time (timespan format) that the console session will wait for the deployment to finish (default 00:10:00).
This will not stop the deployment. Requires WaitForDeployment parameter set.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.CancelOnTimeout">
<summary>
Gets or sets a value indicating whether to cancel the deployment if the deployment timeout is reached(default false).
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.DeploymentChecksLeepCycle">
<summary>
Gets or sets how much time should elapse between deployment status checks(default 00:00:10).
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.GuidedFailure">
<summary>
Gets or sets a value indicating whether to use Guided Failure mode. If not specified, will use default setting from environment.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.SpecificMachines">
<summary>
Gets or sets list of machines names to target in the deployed environment.If not specified all machines in the environment will be considered.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.Force">
<summary>
Gets or sets a value indicating whether a project is configured to skip packages with already-installed versions, override this setting to force re-deployment (flag, default false).
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.SkipSteps">
<summary>
Gets or sets a list of steps to be skipped. Takes step names.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.NoRawLog">
<summary>
Gets or sets a value indicating whether print the raw log of failed tasks or not.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.RawLogFile">
<summary>
Gets or sets a file where to redirect the raw log of failed tasks.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.Variables">
<summary>
Gets or sets values for any prompted variables.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.DeployAt">
<summary>
Gets or sets time at which deployment should start (scheduled deployment), specified as any valid DateTimeOffset format, and assuming the time zone is the current local time zone.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.Tenant">
<summary>
Gets or sets a tenant the deployment will be performed for; specify this argument multiple times to add multiple tenants or use `*` wildcard to deploy to tenants able to deploy.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.TenantTags">
<summary>
Gets or sets a tenant tags used to match tenants that the deployment will be performed for; specify this argument multiple times to add multiple tenant tags.
</summary>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployPusher">
<summary>
The Octopus Deploy package push runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployPusher.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployPusher"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployPusher.PushPackage(System.String,System.String,Cake.Core.IO.FilePath[],Cake.Common.Tools.OctopusDeploy.OctopusPushSettings)">
<summary>
Pushes the specified packages to Octopus Deploy internal repository.
</summary>
<param name="server">The Octopus server URL.</param>
<param name="apiKey">The user's API key.</param>
<param name="packagePaths">Paths to the packages to be pushed.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseCreator">
<summary>
The Octopus Deploy release creator runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseCreator.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseCreator"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseCreator.CreateRelease(System.String,Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings)">
<summary>
Creates a release for the specified project in OctopusDeploy.
</summary>
<param name="projectName">The target project name.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeployer">
<summary>
The Octopus Deploy Release Deploy runner. This class facilitates deploying existing releases in Octopus Deploy.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeployer.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeployer"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeployer.DeployRelease(System.String,System.String,System.String,System.String,System.String,Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings)">
<summary>
Requests a deployment of a specified release to an environment.
</summary>
<param name="server">Octopus Server URL.</param>
<param name="apiKey">The user's API key.</param>
<param name="projectName">Name of the target project.</param>
<param name="deployTo">Environment to deploy to, e.g., Production.</param>
<param name="releaseNumber">Release number to be deployed to.</param>
<param name="settings">Settings for the deployment.</param>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings">
<summary>
Possible arguments to pass to Octo.exe for deploying a release. See <see href="http://docs.octopusdeploy.com/display/OD/Deploying+releases">Octopus Deploy documentation</see>.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings"/> class.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.ShowProgress">
<summary>
Gets or sets a value indicating whether progress of the deployment should be followed. (Sets --waitfordeployment and --norawlog to true.)
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.ForcePackageDownload">
<summary>
Gets or sets a value indicating whether to force downloading of already installed packages. Default false.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.WaitForDeployment">
<summary>
Gets or sets a value indicating whether to wait synchronously for deployment to finish.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.DeploymentTimeout">
<summary>
Gets or sets maximum time (timespan format) that the console session will wait for the deployment to finish (default 00:10:00).
This will not stop the deployment. Requires WaitForDeployment parameter set.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.CancelOnTimeout">
<summary>
Gets or sets a value indicating whether to cancel the deployment if the deployment timeout is reached(default false).
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.DeploymentChecksLeepCycle">
<summary>
Gets or sets how much time should elapse between deployment status checks(default 00:00:10).
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.GuidedFailure">
<summary>
Gets or sets a value indicating whether to use Guided Failure mode. If not specified, will use default setting from environment.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.SpecificMachines">
<summary>
Gets or sets list of machines names to target in the deployed environment.If not specified all machines in the environment will be considered.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.Force">
<summary>
Gets or sets a value indicating whether a project is configured to skip packages with already-installed versions, override this setting to force re-deployment (flag, default false).
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.SkipSteps">
<summary>
Gets or sets a list of steps to be skipped. Takes step names.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.NoRawLog">
<summary>
Gets or sets a value indicating whether print the raw log of failed tasks or not.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.RawLogFile">
<summary>
Gets or sets a file where to redirect the raw log of failed tasks.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.Variables">
<summary>
Gets or sets values for any prompted variables.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.DeployAt">
<summary>
Gets or sets time at which deployment should start (scheduled deployment), specified as any valid DateTimeOffset format, and assuming the time zone is the current local time zone.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.Tenant">
<summary>
Gets or sets a tenant the deployment will be performed for; specify this argument multiple times to add multiple tenants or use `*` wildcard to deploy to tenants able to deploy.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.TenantTags">
<summary>
Gets or sets a tenant tags used to match tenants that the deployment will be performed for; specify this argument multiple times to add multiple tenant tags.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.Channel">
<summary>
Gets or sets the channel to use when getting the release to deploy.
</summary>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleasePromoter">
<summary>
The Octopus Deploy Promote Release runner. This class facilitates promoting existing releases in Octopus Deploy.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleasePromoter.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleasePromoter"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleasePromoter.PromoteRelease(System.String,System.String,System.String,System.String,System.String,Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings)">
<summary>
Requests a promotion of a specified release to an environment.
</summary>
<param name="server">Octopus Server URL.</param>
<param name="apiKey">The user's API key.</param>
<param name="projectName">Name of the target project.</param>
<param name="deployFrom">Environment to promote from, e.g., Staging.</param>
<param name="deployTo">Environment to promote to, e.g., Production.</param>
<param name="settings">Settings for the deployment.</param>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployToolSettings">
<summary>
Base class for tool settings used by all commands in <see cref="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployTool`1"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployCommonToolSettings">
<summary>
Contains the common settings used by all commands in <see cref="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployTool`1"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployCommonToolSettings.Username">
<summary>
Gets or sets the username to use when authenticating with the server.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployCommonToolSettings.Password">
<summary>
Gets or sets the password to use when authenticating with the server.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployCommonToolSettings.Server">
<summary>
Gets or sets the octopus server url.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployCommonToolSettings.ApiKey">
<summary>
Gets or sets the user's API key.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployCommonToolSettings.ConfigurationFile">
<summary>
Gets or sets the text file of default values.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployCommonToolSettings.EnableDebugLogging">
<summary>
Gets or sets a value indicating whether the enable debug logging flag is set.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployCommonToolSettings.IgnoreSslErrors">
<summary>
Gets or sets a value indicating whether the ignore SSL errors flag is set.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployCommonToolSettings.EnableServiceMessages">
<summary>
Gets or sets a value indicating whether the enable service messages flag is set.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployCommonToolSettings.Space">
<summary>
Gets or sets the name of a space within which this command will be executed. The default space will be used if it is omitted.
</summary>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployTool`1">
<summary>
Base class for all octopus deploy related tools.
</summary>
<typeparam name="TSettings">The settings type.</typeparam>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployTool`1.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployTool`1"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployTool`1.Environment">
<summary>
Gets the environment.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployTool`1.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployTool`1.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusPackFormat">
<summary>
Represents the format of an Octopus package.
</summary>
</member>
<member name="F:Cake.Common.Tools.OctopusDeploy.OctopusPackFormat.NuPkg">
<summary>
NuGet package
</summary>
</member>
<member name="F:Cake.Common.Tools.OctopusDeploy.OctopusPackFormat.Zip">
<summary>
Zip package
</summary>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings">
<summary>
Contains the settings used by OctoPack.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings.Version">
<summary>
Gets or sets the version.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings.Format">
<summary>
Gets or sets the package format.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings.OutFolder">
<summary>
Gets or sets the folder into which the package will be written. Defaults to the current folder.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings.BasePath">
<summary>
Gets or sets the root folder containing files and folders to pack. Defaults to the current folder.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings.Author">
<summary>
Gets or sets the author. Only applies to NuGet packages.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings.Title">
<summary>
Gets or sets the title. Only applies to NuGet packages.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings.Description">
<summary>
Gets or sets the description. Only applies to NuGet packages.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings.ReleaseNotes">
<summary>
Gets or sets the release notes. Only applies to NuGet packages.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings.ReleaseNotesFile">
<summary>
Gets or sets the release notes file. Only applies to NuGet packages.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings.Include">
<summary>
Gets or sets the file patterns to include. If none are specified, defaults to **.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings.Overwrite">
<summary>
Gets or sets a value indicating whether to allow an existing package with the same ID/version to be overwritten.
</summary>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusPushSettings">
<summary>
Contains settings used by <see cref="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployPusher.PushPackage(System.String,System.String,Cake.Core.IO.FilePath[],Cake.Common.Tools.OctopusDeploy.OctopusPushSettings)"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPushSettings.ReplaceExisting">
<summary>
Gets or sets a value indicating whether to overwrite an existing package.
</summary>
</member>
<member name="T:Cake.Common.Tools.Roundhouse.NamespaceDoc">
<summary>
This namespace contain types used
to interact with Roundhouse.
</summary>
</member>
<member name="T:Cake.Common.Tools.Roundhouse.RecoveryMode">
<summary>
Defines the recovery model for SQL Server.
</summary>
</member>
<member name="F:Cake.Common.Tools.Roundhouse.RecoveryMode.NoChange">
<summary>
Doesn't change the mode
</summary>
</member>
<member name="F:Cake.Common.Tools.Roundhouse.RecoveryMode.Simple">
<summary>
Does not create backup before migration
</summary>
</member>
<member name="F:Cake.Common.Tools.Roundhouse.RecoveryMode.Full">
<summary>
Creates log backup before migration
</summary>
</member>
<member name="T:Cake.Common.Tools.Roundhouse.RoundhouseAliases">
<summary>
<para>Contains functionality related to <see href="https://github.com/chucknorris/roundhouse">RoundhousE</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.Roundhouse.RoundhouseSettings" /> class:
<code>
#tool "nuget:?package=roundhouse"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.Roundhouse.RoundhouseAliases.RoundhouseMigrate(Cake.Core.ICakeContext,Cake.Common.Tools.Roundhouse.RoundhouseSettings)">
<summary>
Executes Roundhouse with the given configured settings.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<example>
<code>
RoundhouseMigrate(new RoundhouseSettings{
ServerName = "Sql2008R2",
DatabaseName = "AdventureWorks2008R2",
SqlFilesDirectory = "./src/sql"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Roundhouse.RoundhouseAliases.RoundhouseDrop(Cake.Core.ICakeContext,Cake.Common.Tools.Roundhouse.RoundhouseSettings)">
<summary>
Executes Roundhouse migration to drop the database using the provided settings.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<example>
<code>
RoundhouseDrop(new RoundhouseSettings{
ServerName = "Sql2008R2",
DatabaseName = "AdventureWorks2008R2"
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.Roundhouse.RoundhouseRunner">
<summary>
The Roundhouse console application runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.Roundhouse.RoundhouseRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Roundhouse.RoundhouseRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.Roundhouse.RoundhouseRunner.Run(Cake.Common.Tools.Roundhouse.RoundhouseSettings,System.Boolean)">
<summary>
Runs Roundhouse with the given settings.
</summary>
<param name="settings">The settings.</param>
<param name="drop">Will drop/delete the database if set to <c>true</c>.</param>
</member>
<member name="M:Cake.Common.Tools.Roundhouse.RoundhouseRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.Roundhouse.RoundhouseRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.Roundhouse.RoundhouseSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Roundhouse.RoundhouseRunner" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.ServerName">
<summary>
Gets or sets the server name.
</summary>
<value>
The server on which create/migrate should happen.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.DatabaseName">
<summary>
Gets or sets the database name.
</summary>
<value>
The database you want to create/migrate.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.ConnectionString">
<summary>
Gets or sets the connection string.
</summary>
<value>
As an alternative to ServerName and Database - You can provide an entire connection string instead.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.ConnectionStringAdmin">
<summary>
Gets or sets the connection string for admin connections.
</summary>
<value>
This is used for connecting to master when you may have a different uid and password than normal.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.CommandTimeout">
<summary>
Gets or sets the timeout (in seconds) for normal connections.
</summary>
<value>
This is the timeout when commands are run. This is not for admin commands or restore.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.CommandTimeoutAdmin">
<summary>
Gets or sets the timeout (in seconds) for admin connections.
</summary>
<value>
This is the timeout when administration commands are run (except for restore, which has its own).
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.SqlFilesDirectory">
<summary>
Gets or sets the sql files directory.
</summary>
<value>
The directory where your SQL scripts are.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.RepositoryPath">
<summary>
Gets or sets the location of the source code repository.
</summary>
<value>
Path to code repository to be able to correlate versions.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.VersionFile">
<summary>
Gets or sets the version file.
</summary>
<value>
Path to the file to use for applying version number. Either a .XML file, a .DLL or a .TXT file that a version can be resolved from.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.VersionXPath">
<summary>
Gets or sets the XPath to locate version in the <see cref="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.VersionFile" />.
</summary>
<value>
Works in conjunction with an XML version file.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.AlterDatabaseFolderName">
<summary>
Gets or sets the folder name for 'alterDatabase' scripts.
</summary>
<value>
The name of the folder where you keep your alter database scripts. Read up on token replacement. You will want to use {{DatabaseName}} here instead of specifying a database name.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.RunAfterCreateDatabaseFolderName">
<summary>
Gets or sets the folder name for 'runAfterCreateDatabase' scripts.
</summary>
<value>
The name of the folder where you will keep scripts that ONLY run after a database is created.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.RunBeforeUpFolderName">
<summary>
Gets or sets the folder name for 'runBeforeUp' scripts.
</summary>
<value>
The name of the folder where you keep scripts that you want to run before your update scripts.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.UpFolderName">
<summary>
Gets or sets the folder name for 'up' scripts.
</summary>
<value>
The name of the folder where you keep your update scripts.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.RunFirstAfterUpFolderName">
<summary>
Gets or sets the folder name for 'runFirstAfterUp' scripts.
</summary>
<value>
The name of the folder where you keep any functions, views, or sprocs that are order dependent. If you have a function that depends on a view, you definitely need the view in this folder.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.FunctionsFolderName">
<summary>
Gets or sets the folder name for 'functions' scripts.
</summary>
<value>
The name of the folder where you keep your functions.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.ViewsFolderName">
<summary>
Gets or sets the folder name for 'views' scripts.
</summary>
<value>
The name of the folder where you keep your views.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.SprocsFolderName">
<summary>
Gets or sets the folder name for 'sprocs' scripts.
</summary>
<value>
The name of the folder where you keep your stored procedures.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.IndexesFolderName">
<summary>
Gets or sets the folder name for 'indexes' scripts.
</summary>
<value>
The name of the folder where you keep your indexes.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.RunAfterOtherAnyTimeScriptsFolderName">
<summary>
Gets or sets the folder name for 'runAfterOtherAnyTimeScripts' scripts.
</summary>
<value>
The name of the folder where you keep scripts that will be run after all of the other any time scripts complete.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.PermissionsFolderName">
<summary>
Gets or sets the folder name for 'permissions' scripts.
</summary>
<value>
The name of the folder where you keep your permissions scripts.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.BeforeMigrationFolderName">
<summary>
Gets or sets the folder name for 'beforeMig' scripts.
</summary>
<value>
The name of the folder for scripts to run before migration and outside of a transaction.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.AfterMigrationFolderName">
<summary>
Gets or sets the folder name for 'afterMig' scripts.
</summary>
<value>
The name of the folder for scripts to run before migration and outside of a transaction.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.SchemaName">
<summary>
Gets or sets the schema name to use instead of [RoundhousE].
</summary>
<value>
The schema where RH stores its tables.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.Environment">
<summary>
Gets or sets the environment for RH to be scoped.
</summary>
<value>
This allows RH to be environment aware and only run scripts that are in a particular environment based on the naming of the script. LOCAL.something**.ENV.**sql would only be run in the LOCAL environment.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.Restore">
<summary>
Gets or sets a value indicating whether perform a restore.
</summary>
<value>
This instructs RH to do a restore (with the <see cref="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.RestoreFilePath"/> parameter) of a database before running migration scripts.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.RestoreFilePath">
<summary>
Gets or sets the restore file path.
</summary>
<value>
File path of back when Restore is set to true.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.CreateDatabaseCustomScript">
<summary>
Gets or sets the custom database creation script.
</summary>
<value>
This instructs RH to use this script for creating a database instead of the default based on the SQLType.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.OutputPath">
<summary>
Gets or sets the output path.
</summary>
<value>
Path to where migration artifacts are stored.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.WarnOnOneTimeScriptChanges">
<summary>
Gets or sets a value indicating whether to warn when previously run scripts have changed.
</summary>
<value>
Instructs RH to execute changed one time scripts (DDL/DML in 'Up'/<see cref="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.UpFolderName"/>) that have previously been run against the database instead of failing. A warning is logged for each one time scripts that is rerun.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.Silent">
<summary>
Gets or sets a value indicating whether to keep RH silent.
</summary>
<value>
Tells RH not to ask for any input when it runs.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.DatabaseType">
<summary>
Gets or sets database type.
</summary>
<value>
Database Type (fully qualified class name implementing [roundhouse.sql.Database, roundhouse]).
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.Drop">
<summary>
Gets or sets a value indicating whether to drop the DB.
</summary>
<value>
This instructs RH to remove a database and not run migration scripts.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.WithTransaction">
<summary>
Gets or sets a value indicating whether to use transactions.
</summary>
<value>
This instructs RH to run inside of a transaction.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.RecoveryMode">
<summary>
Gets or sets SQL Server recovery mode.
</summary>
<value>
This sets the recovery model for SQL Server during migration. (NoChange, Simple, Full).
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.DryRun">
<summary>
Gets or sets a value indicating whether to perform a dry run.
</summary>
<value>
This instructs RH to log what would have run, but not to actually run anything against the database. Use this option if you are trying to figure out what RH is going to do.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.DoNotCreateDatabase">
<summary>
Gets or sets a value indicating whether to create a database if it does not exist.
</summary>
<value>
This instructs RH to not create a database if it does not exists. Defaults to <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.DisableOutput">
<summary>
Gets or sets a value indicating whether to disable output of backup, items ran, permissions dumps, etc.
</summary>
<value>
Disable output of backups, items ran, permissions dumps, etc. Log files are kept. Useful for example in CI environment. Defaults to <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.Baseline">
<summary>
Gets or sets a value indicating whether to create an insert for its recording tables, but not run anything.
</summary>
<value>
This instructs RH to create an insert for its recording tables, but not to actually run anything against the database. Use this option if you already have scripts that have been run through other means. Defaults to <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.Debug">
<summary>
Gets or sets a value indicating whether to write debug messages.
</summary>
<value>
This instructs RH to write out all messages. Defaults to <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.RunAllAnyTimeScripts">
<summary>
Gets or sets a value indicating whether to execute any time scripts.
</summary>
<value>
This instructs RH to run any time scripts every time it is run. Defaults to <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.DisableTokenReplacement">
<summary>
Gets or sets a value indicating whether to perform token replacement.
</summary>
<value>
This instructs RH to not perform token replacement {{somename}}. Defaults to <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.SearchAllSubdirectoriesInsteadOfTraverse">
<summary>
Gets or sets a value indicating whether to search all subdirectories.
</summary>
<value>
Each Migration folder's subdirectories are traversed by default. This option pulls back scripts from the main directory and all subdirectories at once. Defaults to <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Tools.SignTool.NamespaceDoc">
<summary>
This namespace contain types used for
signing assemblies with SignTool.
</summary>
</member>
<member name="T:Cake.Common.Tools.SignTool.ISignToolResolver">
<summary>
Represents a sign tool resolver.
</summary>
<remarks>
This exists only to be able to test the sign tool.
Do not use this interface since it will be removed.
</remarks>
</member>
<member name="M:Cake.Common.Tools.SignTool.ISignToolResolver.GetPath">
<summary>
Resolves the path to the sign tool.
</summary>
<returns>The path to the sign tool.</returns>
</member>
<member name="T:Cake.Common.Tools.SignTool.SignToolDigestAlgorithm">
<summary>
Digest algorithm for SignTool.
</summary>
</member>
<member name="F:Cake.Common.Tools.SignTool.SignToolDigestAlgorithm.Sha1">
<summary>
SHA-1 digest algorithm
</summary>
</member>
<member name="F:Cake.Common.Tools.SignTool.SignToolDigestAlgorithm.Sha256">
<summary>
SHA-256 digest algorithm.
</summary>
</member>
<member name="M:Cake.Common.Tools.SignTool.SignToolResolver.GetPath">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Tools.SignTool.SignToolSignAliases">
<summary>
<para>Contains functionality related to signing assemblies with PFX certificates using <see href="https://msdn.microsoft.com/en-gb/library/windows/desktop/aa387764(v=vs.85).aspx">SignTool</see>.</para>
<para>
In order to use the commands for this alias, SignTool will need to be installed on the machine where
the Cake script is being executed. This is typically achieved by installing the correct Windows SDK.
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.SignTool.SignToolSignAliases.Sign(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.SignTool.SignToolSignSettings)">
<summary>
Signs the specified assembly.
</summary>
<param name="context">The context.</param>
<param name="assembly">The target assembly.</param>
<param name="settings">The settings.</param>
<example>
<code>
Task("Sign")
.IsDependentOn("Clean")
.IsDependentOn("Restore")
.IsDependentOn("Build")
.Does(() =>
{
var file = "Core.dll";
Sign(file, new SignToolSignSettings {
TimeStampUri = new Uri("http://timestamp.digicert.com"),
CertPath = "digitalcertificate.pfx",
Password = "TopSecret"
});
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.SignTool.SignToolSignAliases.Sign(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.SignTool.SignToolSignSettings)">
<summary>
Signs the specified assembly.
</summary>
<param name="context">The context.</param>
<param name="assembly">The target assembly.</param>
<param name="settings">The settings.</param>
<example>
<code>
Task("Sign")
.IsDependentOn("Clean")
.IsDependentOn("Restore")
.IsDependentOn("Build")
.Does(() =>
{
var file = new FilePath("Core.dll");
Sign(file, new SignToolSignSettings {
TimeStampUri = new Uri("http://timestamp.digicert.com"),
CertPath = "digitalcertificate.pfx",
Password = "TopSecret"
});
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.SignTool.SignToolSignAliases.Sign(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Tools.SignTool.SignToolSignSettings)">
<summary>
Signs the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The target assembly.</param>
<param name="settings">The settings.</param>
<example>
<code>
Task("Sign")
.IsDependentOn("Clean")
.IsDependentOn("Restore")
.IsDependentOn("Build")
.Does(() =>
{
var files = new string[] { "Core.dll", "Common.dll" };
Sign(files, new SignToolSignSettings {
TimeStampUri = new Uri("http://timestamp.digicert.com"),
CertPath = "digitalcertificate.pfx",
Password = "TopSecret"
});
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.SignTool.SignToolSignAliases.Sign(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.SignTool.SignToolSignSettings)">
<summary>
Signs the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The target assembly.</param>
<param name="settings">The settings.</param>
<example>
<code>
Task("Sign")
.IsDependentOn("Clean")
.IsDependentOn("Restore")
.IsDependentOn("Build")
.Does(() =>
{
var files = GetFiles(solutionDir + "/**/bin/" + configuration + "/**/*.exe");
Sign(files, new SignToolSignSettings {
TimeStampUri = new Uri("http://timestamp.digicert.com"),
CertPath = "digitalcertificate.pfx",
Password = "TopSecret"
});
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.SignTool.SignToolSignRunner">
<summary>
The SignTool SIGN assembly runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.SignTool.SignToolSignRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.IRegistry)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.SignTool.SignToolSignRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="registry">The registry.</param>
</member>
<member name="M:Cake.Common.Tools.SignTool.SignToolSignRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.IRegistry,Cake.Common.Tools.SignTool.ISignToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.SignTool.SignToolSignRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="registry">The registry.</param>
<param name="resolver">The resolver.</param>
</member>
<member name="M:Cake.Common.Tools.SignTool.SignToolSignRunner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.SignTool.SignToolSignSettings)">
<summary>
Signs the specified assemblies.
</summary>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.SignTool.SignToolSignRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>
The name of the tool (<c>SignTool SIGN</c>).
</returns>
</member>
<member name="M:Cake.Common.Tools.SignTool.SignToolSignRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.SignTool.SignToolSignRunner.GetAlternativeToolPaths(Cake.Common.Tools.SignTool.SignToolSignSettings)">
<summary>
Gets alternative file paths which the tool may exist in.
</summary>
<param name="settings">The settings.</param>
<returns>The default tool path.</returns>
</member>
<member name="T:Cake.Common.Tools.SignTool.SignToolSignSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.SignTool.SignToolSignRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.TimeStampUri">
<summary>
Gets or sets the timestamp server's URL. Timestamp will only be added if <c>TimeStampUri</c> is set.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.CertThumbprint">
<summary>
Gets or sets the thumbprint for locating a certificate in the store.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.CertSubjectName">
<summary>
Gets or sets the name of the subject of the signing certificate. This value can be a substring of the entire subject name.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.CertPath">
<summary>
Gets or sets the <c>PFX</c> certificate path.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.Password">
<summary>
Gets or sets the <c>PFX</c> certificate password.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.Description">
<summary>
Gets or sets the signed content's description.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.DescriptionUri">
<summary>
Gets or sets the signed content's expanded description URL.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.DigestAlgorithm">
<summary>
Gets or sets the file digest algorithm.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.TimeStampDigestAlgorithm">
<summary>
Gets or sets the timestamp digest algorithm.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.AppendSignature">
<summary>
Gets or sets a value indicating whether the signature should be appended.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.UseMachineStore">
<summary>
Gets or sets a value indicating whether a machine store, instead of a user store, is used.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.AdditionalCertPath">
<summary>
Gets or sets the path to an additional certificate that is to be added to the signature block.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.StoreName">
<summary>
Gets or sets the store to open when searching for the certificate.
</summary>
</member>
<member name="T:Cake.Common.Tools.WiX.NamespaceDoc">
<summary>
This namespace contain types used to interact with WiX.
</summary>
</member>
<member name="T:Cake.Common.Tools.WiX.Architecture">
<summary>
The architecture for the package.
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Architecture.X64">
<summary>
Architecture: <c>x86_64</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Architecture.X86">
<summary>
Architecture: <c>x86</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Architecture.IA64">
<summary>
Architecture: <c>Itanium</c>
</summary>
</member>
<member name="T:Cake.Common.Tools.WiX.CandleRunner">
<summary>
The WiX Candle runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.WiX.CandleRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.WiX.CandleRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.CandleRunner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.WiX.CandleSettings)">
<summary>
Runs Candle with the specified source files and settings.
</summary>
<param name="sourceFiles">The source files (<c>.wxs</c>) to compile.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.CandleRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.WiX.CandleRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.WiX.CandleSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.WiX.CandleRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.CandleSettings.Architecture">
<summary>
Gets or sets a value indicating which architecture to build the MSI package for.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.CandleSettings.Defines">
<summary>
Gets or sets the pre processor defines.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.CandleSettings.Extensions">
<summary>
Gets or sets the WiX extensions to use.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.CandleSettings.FIPS">
<summary>
Gets or sets a value indicating whether FIPS compliant algorithms should be used.
</summary>
<value>
<c>true</c> if FIPS compliant algorithms should be used, otherwise <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.CandleSettings.NoLogo">
<summary>
Gets or sets a value indicating whether to show the logo information.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.CandleSettings.OutputDirectory">
<summary>
Gets or sets the output directory for the object files.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.CandleSettings.Pedantic">
<summary>
Gets or sets a value indicating whether to show pedantic messages.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.CandleSettings.ShowSourceTrace">
<summary>
Gets or sets a value indicating whether to show source trace for errors, warnings and verbose messages.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.CandleSettings.Verbose">
<summary>
Gets or sets a value indicating whether to show verbose output.
</summary>
</member>
<member name="T:Cake.Common.Tools.WiX.Heat.HeatRunner">
<summary>
The WiX Heat runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.WiX.Heat.HeatRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.WiX.Heat.HeatRunner" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="toolService">The tool service.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.Heat.HeatRunner.Run(Cake.Core.IO.DirectoryPath,Cake.Core.IO.FilePath,Cake.Common.Tools.WiX.Heat.WiXHarvestType,Cake.Common.Tools.WiX.Heat.HeatSettings)">
<summary>
Runs the Wix Heat runner for the specified directory path.
</summary>
<param name="directoryPath">The directory path.</param>
<param name="outputFile">The output file.</param>
<param name="harvestType">The WiX harvest type.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.Heat.HeatRunner.Run(Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Common.Tools.WiX.Heat.WiXHarvestType,Cake.Common.Tools.WiX.Heat.HeatSettings)">
<summary>
Runs the Wix Heat runner for the specified directory path.
</summary>
<param name="objectFile">The object file.</param>
<param name="outputFile">The output file.</param>
<param name="harvestType">The WiX harvest type.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.Heat.HeatRunner.Run(System.String,Cake.Core.IO.FilePath,Cake.Common.Tools.WiX.Heat.WiXHarvestType,Cake.Common.Tools.WiX.Heat.HeatSettings)">
<summary>
Runs the Wix Heat runner for the specified directory path.
</summary>
<param name="harvestTarget">The harvest target.</param>
<param name="outputFile">The output file.</param>
<param name="harvestType">The WiX harvest type.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.Heat.HeatRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns> The name of the tool. </returns>
</member>
<member name="M:Cake.Common.Tools.WiX.Heat.HeatRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns> The tool executable name. </returns>
</member>
<member name="T:Cake.Common.Tools.WiX.Heat.HeatSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.WiX.Heat.HeatRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.Extensions">
<summary>
Gets or sets the WiX extensions to use.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.NoLogo">
<summary>
Gets or sets a value indicating whether [no logo].
</summary>
<value>
<c>true</c> if [no logo]; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.SuppressSpecificWarnings">
<summary>
Gets or sets the suppress specific warnings.
</summary>
<value>
The suppress specific warnings.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.TreatSpecificWarningsAsErrors">
<summary>
Gets or sets the treat specific warnings as errors.
</summary>
<value>
The treat specific warnings as errors.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.Verbose">
<summary>
Gets or sets a value indicating whether output is verbose.
</summary>
<value>
<c>true</c> if verbose; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.AutogeneratedGuid">
<summary>
Gets or sets a value indicating whether to auto generate <see cref="T:System.Guid"/> at compile time.
</summary>
<value>
<c>true</c> if [autogenerated unique identifier]; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.GenerateGuid">
<summary>
Gets or sets a value indicating whether all components are given a guid.
</summary>
<value>
<c>true</c> if [generate unique identifier]; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.OutputFile">
<summary>
Gets or sets the output file.
</summary>
<value>
The output file.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.SuppressFragments">
<summary>
Gets or sets a value indicating whether to suppress the
generation of fragments for directories and components.
</summary>
<value>
<c>true</c> if [suppress fragments]; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.SuppressUniqueIds">
<summary>
Gets or sets a value indicating whether to suppress unique identifiers
for files, components, and directories.
</summary>
<value>
<c>true</c> if [suppress unique ids]; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.Transform">
<summary>
Gets or sets the transform to apply to harvested files.
</summary>
<value>
The transform.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.File">
<summary>
Gets or sets the file.
</summary>
<value>
The file.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.ComponentGroupName">
<summary>
Gets or sets the name of the component group.
</summary>
<value>
The name of the component group.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.DirectoryReferenceId">
<summary>
Gets or sets the directory reference identifier for generated directory elements.
</summary>
<value>
The directory reference identifier.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.PreprocessorVariable">
<summary>
Gets or sets the preprocessor variable.
</summary>
<value>
The preprocessor variable.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.GenerateBinderVariables">
<summary>
Gets or sets a value indicating whether generate binder variables instead
of preprocessor variables.
</summary>
<value>
<c>true</c> if [generate binder variables]; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.SuppressCom">
<summary>
Gets or sets a value indicating whether the COM elements.
</summary>
<value>
<c>true</c> if [suppress COM]; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.SuppressRegistry">
<summary>
Gets or sets a value indicating whether [suppress registry].
</summary>
<value>
<c>true</c> if [suppress registry]; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.SuppressRootDirectory">
<summary>
Gets or sets a value indicating whether [suppress root directory].
</summary>
<value>
<c>true</c> if [suppress root directory]; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.Configuration">
<summary>
Gets or sets the configuration to set when harvesting the project.
</summary>
<value>
The configuration.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.DirectoryId">
<summary>
Gets or sets the overridden directory identifier for generated directory elements.
</summary>
<value>
The directory identifier.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.Generate">
<summary>
Gets or sets the type of elements to generate.
</summary>
<value>
The generate.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.GenerateGuidWithoutBraces">
<summary>
Gets or sets a value indicating whether to generate guids without curly braces.
</summary>
<value>
<c>true</c> if generate guids without curly braces; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.KeepEmptyDirectories">
<summary>
Gets or sets a value indicating whether to keep empty directories.
</summary>
<value>
<c>true</c> if keep empty directories; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.Platform">
<summary>
Gets or sets the platform to set when harvesting the project.
</summary>
<value>
The platform.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.OutputGroup">
<summary>
Gets or sets the output group of Visual Studio project.
</summary>
<value>
The output group.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.ProjectName">
<summary>
Gets or sets the overridden project name to use in variables.
</summary>
<value>
The name of the project.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.Template">
<summary>
Gets or sets the template to use when harvesting.
</summary>
<value>
The template.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.Indent">
<summary>
Gets or sets the indentation multiplier, overrides default of 4.
</summary>
<value>
The indent.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.SuppressVb6Com">
<summary>
Gets or sets a value indicating whether to suppress VB6 COM registration entries.
</summary>
<value>
<c>true</c> if suppress VB6 COM registration entries; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Tools.WiX.Heat.WiXGenerateType">
<summary>
Type of elements to generate.
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXGenerateType.Components">
<summary>
Generates components
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXGenerateType.Container">
<summary>
Generates a container
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXGenerateType.PayloadGroup">
<summary>
Generates a payload group
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXGenerateType.Layout">
<summary>
Generates a layout
</summary>
</member>
<member name="T:Cake.Common.Tools.WiX.Heat.WiXHarvestType">
<summary>
The type of object file to harvest from.
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXHarvestType.Dir">
<summary>
Harvest a directory.
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXHarvestType.File">
<summary>
Harvest a file
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXHarvestType.Project">
<summary>
Harvest outputs of a Visual Studio project.
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXHarvestType.Website">
<summary>
Harvest an IIS web site.
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXHarvestType.Perf">
<summary>
Harvest performance counters from a category.
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXHarvestType.Reg">
<summary>
Harvest registry information from a reg file.
</summary>
</member>
<member name="T:Cake.Common.Tools.WiX.Heat.WiXOutputGroupType">
<summary>
The Output Group of Visual Studio project.
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXOutputGroupType.Binaries">
<summary>
OutputGroup: <c>Binaries</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXOutputGroupType.Symbols">
<summary>
OutputGroup: <c>Symbols</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXOutputGroupType.Documents">
<summary>
OutputGroup: <c>Documents</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXOutputGroupType.Satellites">
<summary>
OutputGroup: <c>Satellites</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXOutputGroupType.Sources">
<summary>
OutputGroup: <c>Sources</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXOutputGroupType.Content">
<summary>
OutputGroup: <c>Content</c>
</summary>
</member>
<member name="T:Cake.Common.Tools.WiX.Heat.WiXTemplateType">
<summary>
Template type to use for harvesting.
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXTemplateType.Fragment">
<summary>
TemplateType: <c>Fragment</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXTemplateType.Module">
<summary>
TemplateType: <c>Module</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXTemplateType.Product">
<summary>
TemplateType: <c>Product</c>
</summary>
</member>
<member name="T:Cake.Common.Tools.WiX.LightRunner">
<summary>
The WiX Light runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.WiX.LightRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.WiX.LightRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The Cake environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.LightRunner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.WiX.LightSettings)">
<summary>
Runs Light with the specified input object files and settings.
</summary>
<param name="objectFiles">The object files (<c>.wixobj</c>).</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.LightRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.WiX.LightRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.WiX.LightSettings">
<summary>
Contains settings used by the <see cref="T:Cake.Common.Tools.WiX.LightRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.LightSettings.Defines">
<summary>
Gets or sets the defined WiX variables.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.LightSettings.Extensions">
<summary>
Gets or sets the WiX extensions to use.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.LightSettings.RawArguments">
<summary>
Gets or sets raw command line arguments to pass through to the linker.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.LightSettings.NoLogo">
<summary>
Gets or sets a value indicating whether to show the logo information.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.LightSettings.OutputFile">
<summary>
Gets or sets the path to the output file (i.e. the resulting MSI package).
</summary>
</member>
<member name="T:Cake.Common.Tools.WiX.WiXAliases">
<summary>
<para>Contains functionality related to <see href="http://wixtoolset.org/">WiX</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the appropriate settings class:
<code>
#tool "nuget:?package=WiX"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.WiX.WiXAliases.WiXCandle(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.WiX.CandleSettings)">
<summary>
Compiles all <c>.wxs</c> sources matching the specified pattern.
</summary>
<example>
<code>
CandleSettings settings = new CandleSettings {
Architecture = Architecture.X64,
Verbose = true
};
WiXCandle("./src/*.wxs", settings);
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The globbing pattern.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.WiXAliases.WiXCandle(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.WiX.CandleSettings)">
<summary>
Compiles all <c>.wxs</c> sources in the provided source files.
</summary>
<example>
<code>
var files = GetFiles("./src/*.wxs");
CandleSettings settings = new CandleSettings {
Architecture = Architecture.X64,
Verbose = true
};
WiXCandle(files, settings);
</code>
</example>
<param name="context">The context.</param>
<param name="sourceFiles">The source files.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.WiXAliases.WiXLight(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.WiX.LightSettings)">
<summary>
Links all <c>.wixobj</c> files matching the specified pattern.
</summary>
<example>
<code>
LightSettings settings = new LightSettings {
RawArguments = "-O1 -pedantic -v"
};
WiXLight("./src/*.wixobj", settings);
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The globbing pattern.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.WiXAliases.WiXLight(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.WiX.LightSettings)">
<summary>
Links all <c>.wixobj</c> files in the provided object files.
</summary>
<example>
<code>
var files = GetFiles("./src/*.wxs");
LightSettings settings = new LightSettings {
RawArguments = "-O1 -pedantic -v"
};
WiXLight(files, settings);
</code>
</example>
<param name="context">The context.</param>
<param name="objectFiles">The object files.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.WiXAliases.WiXHeat(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Core.IO.FilePath,Cake.Common.Tools.WiX.Heat.WiXHarvestType)">
<summary>
Harvests files in the provided object files.
</summary>
<example>
<code>
DirectoryPath harvestDirectory = Directory("./src");
var filePath = new FilePath("Wix.Directory.wxs");
WiXHeat(harvestDirectory, filePath, WiXHarvestType.Dir);
</code>
</example>
<param name="context">The context.</param>
<param name="directoryPath">The object files.</param>
<param name="outputFile">The output file.</param>
<param name="harvestType">The WiX harvest type.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.WiXAliases.WiXHeat(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Core.IO.FilePath,Cake.Common.Tools.WiX.Heat.WiXHarvestType,Cake.Common.Tools.WiX.Heat.HeatSettings)">
<summary>
Harvests files in the provided directory path.
</summary>
<example>
<code>
DirectoryPath harvestDirectory = Directory("./src");
var filePath = File("Wix.Directory.wxs");
Information(MakeAbsolute(harvestDirectory).FullPath);
WiXHeat(harvestDirectory, filePath, WiXHarvestType.Dir, new HeatSettings { NoLogo = true });
</code>
</example>
<param name="context">The context.</param>
<param name="directoryPath">The directory path.</param>
<param name="outputFile">The output file.</param>
<param name="harvestType">The WiX harvest type.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.WiXAliases.WiXHeat(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Common.Tools.WiX.Heat.WiXHarvestType)">
<summary>
Harvests from the desired files.
</summary>
<example>
<code>
var harvestFile = File("./tools/Cake/Cake.Core.dll");
var filePath = File("Wix.File.wxs");
WiXHeat(harvestFile, filePath, WiXHarvestType.File);
</code>
</example>
<param name="context">The context.</param>
<param name="objectFile">The object file.</param>
<param name="outputFile">The output file.</param>
<param name="harvestType">The WiX harvest type.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.WiXAliases.WiXHeat(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Common.Tools.WiX.Heat.WiXHarvestType,Cake.Common.Tools.WiX.Heat.HeatSettings)">
<summary>
Harvests from the desired files.
</summary>
<example>
<code>
var harvestFiles = File("./tools/Cake/*.dll");
var filePath = File("Wix.File.wxs");
WiXHeat(harvestFiles, filePath, WiXHarvestType.File, new HeatSettings { NoLogo = true });
</code>
</example>
<param name="context">The context.</param>
<param name="objectFile">The object file.</param>
<param name="outputFile">The output file.</param>
<param name="harvestType">The WiX harvest type.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.WiXAliases.WiXHeat(Cake.Core.ICakeContext,System.String,Cake.Core.IO.FilePath,Cake.Common.Tools.WiX.Heat.WiXHarvestType)">
<summary>
Harvests files for a website or performance.
</summary>
<example>
<code>
var filePath = File("Wix.Website.wxs");
WiXHeat("Default Web Site", filePath, WiXHarvestType.Website);
</code>
</example>
<param name="context">The context.</param>
<param name="harvestTarget">The harvest target.</param>
<param name="outputFile">The output file.</param>
<param name="harvestType">The WiX harvest type.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.WiXAliases.WiXHeat(Cake.Core.ICakeContext,System.String,Cake.Core.IO.FilePath,Cake.Common.Tools.WiX.Heat.WiXHarvestType,Cake.Common.Tools.WiX.Heat.HeatSettings)">
<summary>
Harvests files for a website or performance.
</summary>
<example>
<code>
var filePath = File("Wix.Website.wxs");
WiXHeat("Default Web Site", filePath, WiXHarvestType.Website, new HeatSettings { NoLogo = true });
</code>
</example>
<param name="context">The context.</param>
<param name="harvestTarget">The harvest target.</param>
<param name="outputFile">The output file.</param>
<param name="harvestType">The WiX harvest type.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.XBuild.NamespaceDoc">
<summary>
This namespace contain types used
to interact with XBuild.
</summary>
</member>
<member name="T:Cake.Common.Tools.XBuild.XBuildAliases">
<summary>
<para>Contains functionality related to <see href="http://www.mono-project.com/docs/tools+libraries/tools/xbuild/">XBuild</see>.</para>
<para>
In order to use the commands for this alias, XBuild (which is part of Mono) will already have to be installed on the machine the
Cake Script is being executed.
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildAliases.XBuild(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Builds the specified solution using XBuild.
</summary>
<param name="context">The context.</param>
<param name="solution">The solution to build.</param>
<example>
<code>
XBuild("./src/Cake.sln");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildAliases.XBuild(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,System.Action{Cake.Common.Tools.XBuild.XBuildSettings})">
<summary>
Builds the specified solution using XBuild.
</summary>
<param name="context">The context.</param>
<param name="solution">The solution to build.</param>
<param name="configurator">The settings configurator.</param>
<example>
<code>
XBuild("./src/Cake.sln", configurator =>
configurator.SetConfiguration("Debug")
.SetVerbosity(Verbosity.Minimal)
.UseToolVersion(XBuildToolVersion.NET40));
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildAliases.XBuild(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.XBuild.XBuildSettings)">
<summary>
Builds the specified solution using XBuild.
</summary>
<param name="context">The context.</param>
<param name="solution">The solution to build.</param>
<param name="settings">The settings.</param>
<example>
<code>
XBuild("./src/Cake.sln", new XBuildSettings {
Verbosity = Verbosity.Minimal,
ToolVersion = XBuildToolVersion.NET40,
Configuration = "Release"
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.XBuild.XBuildRunner">
<summary>
The XBuild runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.XBuild.XBuildRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="runner">The runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildRunner.Run(Cake.Core.IO.FilePath,Cake.Common.Tools.XBuild.XBuildSettings)">
<summary>
Runs XBuild with the specified settings.
</summary>
<param name="solution">The solution to build.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildRunner.GetAlternativeToolPaths(Cake.Common.Tools.XBuild.XBuildSettings)">
<summary>
Gets alternative file paths which the tool may exist in.
</summary>
<param name="settings">The settings.</param>
<returns>The default tool path.</returns>
</member>
<member name="T:Cake.Common.Tools.XBuild.XBuildSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.XBuild.XBuildRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.XBuild.XBuildSettings.Targets">
<summary>
Gets the targets.
</summary>
<value>The targets.</value>
</member>
<member name="P:Cake.Common.Tools.XBuild.XBuildSettings.Properties">
<summary>
Gets the properties.
</summary>
<value>The properties.</value>
</member>
<member name="P:Cake.Common.Tools.XBuild.XBuildSettings.ToolVersion">
<summary>
Gets or sets the tool version.
</summary>
<value>The tool version.</value>
</member>
<member name="P:Cake.Common.Tools.XBuild.XBuildSettings.Configuration">
<summary>
Gets or sets the configuration.
</summary>
<value>The configuration.</value>
</member>
<member name="P:Cake.Common.Tools.XBuild.XBuildSettings.Verbosity">
<summary>
Gets or sets the amount of information to display in the build log.
Each logger displays events based on the verbosity level that you set for that logger.
</summary>
<value>The build log verbosity.</value>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.XBuild.XBuildSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.XBuild.XBuildSettingsExtensions">
<summary>
Contains functionality related to XBuild settings.
</summary>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildSettingsExtensions.WithTarget(Cake.Common.Tools.XBuild.XBuildSettings,System.String)">
<summary>
Adds a XBuild target to the configuration.
</summary>
<param name="settings">The settings.</param>
<param name="target">The XBuild target.</param>
<returns>The same <see cref="T:Cake.Common.Tools.XBuild.XBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildSettingsExtensions.UseToolVersion(Cake.Common.Tools.XBuild.XBuildSettings,Cake.Common.Tools.XBuild.XBuildToolVersion)">
<summary>
Sets the tool version.
</summary>
<param name="settings">The settings.</param>
<param name="version">The version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.XBuild.XBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildSettingsExtensions.WithProperty(Cake.Common.Tools.XBuild.XBuildSettings,System.String,System.String[])">
<summary>
Adds a property to the configuration.
</summary>
<param name="settings">The settings.</param>
<param name="name">The property name.</param>
<param name="values">The property values.</param>
<returns>The same <see cref="T:Cake.Common.Tools.XBuild.XBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildSettingsExtensions.SetConfiguration(Cake.Common.Tools.XBuild.XBuildSettings,System.String)">
<summary>
Sets the configuration.
</summary>
<param name="settings">The settings.</param>
<param name="configuration">The configuration.</param>
<returns>The same <see cref="T:Cake.Common.Tools.XBuild.XBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildSettingsExtensions.SetVerbosity(Cake.Common.Tools.XBuild.XBuildSettings,Cake.Core.Diagnostics.Verbosity)">
<summary>
Sets the build log verbosity.
</summary>
<param name="settings">The settings.</param>
<param name="verbosity">The build log verbosity.</param>
<returns>The same <see cref="T:Cake.Common.Tools.XBuild.XBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Common.Tools.XBuild.XBuildToolVersion">
<summary>
Represents a XBuild tool version.
</summary>
</member>
<member name="F:Cake.Common.Tools.XBuild.XBuildToolVersion.Default">
<summary>
The highest available XBuild tool version.
</summary>
</member>
<member name="F:Cake.Common.Tools.XBuild.XBuildToolVersion.NET20">
<summary>
XBuild tool version: <c>.NET 2.0</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.XBuild.XBuildToolVersion.NET30">
<summary>
XBuild tool version: <c>.NET 3.0</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.XBuild.XBuildToolVersion.NET35">
<summary>
XBuild tool version: <c>.NET 3.5</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.XBuild.XBuildToolVersion.NET40">
<summary>
XBuild tool version: <c>.NET 4.0</c>
</summary>
</member>
<member name="T:Cake.Common.Tools.XUnit.NamespaceDoc">
<summary>
This namespace contain types used to interact with XUnit.
</summary>
</member>
<member name="T:Cake.Common.Tools.XUnit.ParallelismOption">
<summary>
Represents XUnit2's options for parallel test execution.
</summary>
</member>
<member name="F:Cake.Common.Tools.XUnit.ParallelismOption.None">
<summary>
Turn off all parallelization
</summary>
</member>
<member name="F:Cake.Common.Tools.XUnit.ParallelismOption.Collections">
<summary>
Only parallelize collections
</summary>
</member>
<member name="F:Cake.Common.Tools.XUnit.ParallelismOption.Assemblies">
<summary>
Only parallelize assemblies
</summary>
</member>
<member name="F:Cake.Common.Tools.XUnit.ParallelismOption.All">
<summary>
Parallelize assemblies and collections.
</summary>
</member>
<member name="T:Cake.Common.Tools.XUnit.XUnit2Aliases">
<summary>
<para>Contains functionality related to running <see href="https://github.com/xunit/xunit">xunit</see> tests.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.XUnit.XUnit2Settings" /> class:
<code>
#tool "nuget:?package=xunit.runner.console"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2Aliases.XUnit2(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Runs all xUnit.net v2 tests in the assemblies matching the specified pattern.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<example>
<code>
XUnit2("./src/**/bin/Release/*.Tests.dll");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2Aliases.XUnit2(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.XUnit.XUnit2Settings)">
<summary>
Runs all xUnit.net v2 tests in the assemblies matching the specified pattern.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="settings">The settings.</param>
<example>
<code>
XUnit2("./src/**/bin/Release/*.Tests.dll",
new XUnit2Settings {
Parallelism = ParallelismOption.All,
HtmlReport = true,
NoAppDomain = true,
OutputDirectory = "./build"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2Aliases.XUnit2(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Runs all xUnit.net v2 tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<example>
<code>
XUnit2(new []{
"./src/Cake.Common.Tests/bin/Release/Cake.Common.Tests.dll",
"./src/Cake.Core.Tests/bin/Release/Cake.Core.Tests.dll",
"./src/Cake.NuGet.Tests/bin/Release/Cake.NuGet.Tests.dll",
"./src/Cake.Tests/bin/Release/Cake.Tests.dll"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2Aliases.XUnit2(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Runs all xUnit.net tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<example>
<code>
var testAssemblies = GetFiles("./src/**/bin/Release/*.Tests.dll");
XUnit2(testAssemblies);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2Aliases.XUnit2(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Tools.XUnit.XUnit2Settings)">
<summary>
Runs all xUnit.net v2 tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
<example>
<code>
XUnit2(new []{
"./src/Cake.Common.Tests/bin/Release/Cake.Common.Tests.dll",
"./src/Cake.Core.Tests/bin/Release/Cake.Core.Tests.dll",
"./src/Cake.NuGet.Tests/bin/Release/Cake.NuGet.Tests.dll",
"./src/Cake.Tests/bin/Release/Cake.Tests.dll"
},
new XUnit2Settings {
Parallelism = ParallelismOption.All,
HtmlReport = true,
NoAppDomain = true,
OutputDirectory = "./build"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2Aliases.XUnit2(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.XUnit.XUnit2Settings)">
<summary>
Runs all xUnit.net v2 tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
<example>
<code>
var testAssemblies = GetFiles("./src/**/bin/Release/*.Tests.dll");
XUnit2(testAssemblies,
new XUnit2Settings {
Parallelism = ParallelismOption.All,
HtmlReport = true,
NoAppDomain = true,
OutputDirectory = "./build"
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.XUnit.XUnit2Runner">
<summary>
The xUnit.net v2 test runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2Runner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.XUnit.XUnit2Runner" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="runner">The runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2Runner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.XUnit.XUnit2Settings)">
<summary>
Runs the tests in the specified assembly.
</summary>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2Runner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2Runner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.XUnit.XUnit2Settings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.XUnit.XUnit2Runner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.ShadowCopy">
<summary>
Gets or sets a value indicating whether tests should be run as a shadow copy.
Default value is <c>true</c>.
</summary>
<value>
<c>true</c> if tests should be run as a shadow copy; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.OutputDirectory">
<summary>
Gets or sets the output directory.
</summary>
<value>The output directory.</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.NUnitReport">
<summary>
Gets or sets a value indicating whether an NUnit style XML report should be generated.
</summary>
<value>
<c>true</c> if an NUnit Style XML report should be generated; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.JUnitReport">
<summary>
Gets or sets a value indicating whether an JUnit style XML report should be generated.
</summary>
<value>
<c>true</c> if an JUnit Style XML report should be generated; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.XmlReport">
<summary>
Gets or sets a value indicating whether an XML report should be generated.
</summary>
<value>
<c>true</c> if an XML report should be generated; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.XmlReportV1">
<summary>
Gets or sets a value indicating whether an xUnit.net v1 style XML report should be generated.
</summary>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.HtmlReport">
<summary>
Gets or sets a value indicating whether an HTML report should be generated.
</summary>
<value>
<c>true</c> if an HTML report should be generated; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.ReportName">
<summary>
Gets or sets the name that should be used for the HTML and XML reports.
</summary>
<value>The custom report name.</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.NoAppDomain">
<summary>
Gets or sets a value indicating whether to not use app domains to run test code.
</summary>
<value>
<c>true</c> to not use app domains to run test code; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.Parallelism">
<summary>
Gets or sets the parallelism option.
Corresponds to the -parallel command line switch.
</summary>
<value>
The parallelism option.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.UseX86">
<summary>
Gets or sets a value indicating whether to run tests in using x86 test runner.
</summary>
<value>
<c>true</c> to run tests with the x86 test runner; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.MaxThreads">
<summary>
Gets or sets the maximum thread count for collection parallelization.
</summary>
<value>
<c>null</c> (default);
<c>0</c>: run with unbounded thread count;
<c>>0</c>: limit task thread pool size to value;.
</value>
<exception cref="T:System.ArgumentOutOfRangeException" accessor="set">value < 0.</exception>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.TraitsToInclude">
<summary>
Gets the traits to include.
</summary>
<remarks>
Only run tests with matching name/value traits.
If more than one is specified, it acts as an OR operation.
</remarks>
<value>
The traits to include.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.TraitsToExclude">
<summary>
Gets the traits to exclude.
</summary>
<remarks>
Do not run tests with matching name/value traits.
If more than one is specified, it acts as an AND operation.
</remarks>
<value>
The traits to exclude.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.NamespacesToInclude">
<summary>
Gets the namespaces to include.
</summary>
<remarks>
Runs all methods in a given namespace (i.e., 'MyNamespace.MySubNamespace')
If more than one is specified, it acts as an OR operation.
</remarks>
<value>
The namespaces to include.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.ClassesToInclude">
<summary>
Gets the class names to include.
</summary>
<remarks>
Runs all methods in a given test class (should be fully specified; i.e., 'MyNamespace.MyClass')
If more than one is specified, it acts as an OR operation.
</remarks>
<value>
The class names to include.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.MethodsToInclude">
<summary>
Gets the test methods to include.
</summary>
<remarks>
Runs the given test methods (should be fully specified; i.e., 'MyNamespace.MyClass.MyTestMethod')
If more than one is specified, it acts as an OR operation.
</remarks>
<value>
The namespaces to include.
</value>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2Settings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.XUnit.XUnit2Settings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.XUnit.XUnit2SettingsExtensions">
<summary>
Contains functionality related to XUnit2 settings.
</summary>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2SettingsExtensions.IncludeTrait(Cake.Common.Tools.XUnit.XUnit2Settings,System.String,System.String[])">
<summary>
Adds a trait to the settings, to include in test execution.
</summary>
<param name="settings">The settings.</param>
<param name="name">The trait name.</param>
<param name="values">The trait values.</param>
<returns>The same <see cref="T:Cake.Common.Tools.XUnit.XUnit2Settings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2SettingsExtensions.ExcludeTrait(Cake.Common.Tools.XUnit.XUnit2Settings,System.String,System.String[])">
<summary>
Adds a trait to the settings, to exclude in test execution.
</summary>
<param name="settings">The settings.</param>
<param name="name">The trait name.</param>
<param name="values">The trait values.</param>
<returns>The same <see cref="T:Cake.Common.Tools.XUnit.XUnit2Settings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2SettingsExtensions.IncludeNamespace(Cake.Common.Tools.XUnit.XUnit2Settings,System.String)">
<summary>
Adds a namespace to the settings, to include in test execution. Namespace should be fully qualified; i.e., MyNameSpace.MySubNamespace.
</summary>
<param name="settings">The settings.</param>
<param name="namespaceToInclude">The namespace to include.</param>
<returns>The same <see cref="T:Cake.Common.Tools.XUnit.XUnit2Settings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2SettingsExtensions.IncludeClass(Cake.Common.Tools.XUnit.XUnit2Settings,System.String)">
<summary>
Adds a class name to the settings, to include in test execution. Class name should be fully qualified; i.e., MyNameSpace.MyClassName.
</summary>
<param name="settings">The settings.</param>
<param name="classNameToInclude">The class name to include.</param>
<returns>The same <see cref="T:Cake.Common.Tools.XUnit.XUnit2Settings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2SettingsExtensions.IncludeMethod(Cake.Common.Tools.XUnit.XUnit2Settings,System.String)">
<summary>
Adds a method name to the settings, to include in test execution. Method name should be fully qualified; i.e., MyNameSpace.MyClassName.MyMethod.
</summary>
<param name="settings">The settings.</param>
<param name="methodNameToInclude">The method name to include.</param>
<returns>The same <see cref="T:Cake.Common.Tools.XUnit.XUnit2Settings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Common.Tools.XUnit.XUnitAliases">
<summary>
<para>Contains functionality related to running <see href="https://github.com/xunit/xunit">xunit</see> tests.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.XUnit.XUnitSettings" /> class:
<code>
#tool "nuget:?package=xunit.runner.console&version=2.2.0"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnitAliases.XUnit(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Runs all xUnit.net tests in the assemblies matching the specified pattern.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<example>
<code>
XUnit("./src/**/bin/Release/*.Tests.dll");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnitAliases.XUnit(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.XUnit.XUnitSettings)">
<summary>
Runs all xUnit.net tests in the assemblies matching the specified pattern.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="settings">The settings.</param>
<example>
<code>
XUnit("./src/**/bin/Release/*.Tests.dll",
new XUnitSettings {
HtmlReport = true,
OutputDirectory = "./build"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnitAliases.XUnit(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Runs all xUnit.net tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<example>
<code>
XUnit(new []{
"./src/Cake.Common.Tests/bin/Release/Cake.Common.Tests.dll",
"./src/Cake.Core.Tests/bin/Release/Cake.Core.Tests.dll",
"./src/Cake.NuGet.Tests/bin/Release/Cake.NuGet.Tests.dll",
"./src/Cake.Tests/bin/Release/Cake.Tests.dll"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnitAliases.XUnit(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Runs all xUnit.net tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<example>
<code>
var testAssemblies = GetFiles("./src/**/bin/Release/*.Tests.dll");
XUnit(testAssemblies);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnitAliases.XUnit(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Tools.XUnit.XUnitSettings)">
<summary>
Runs all xUnit.net tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
<example>
<code>
XUnit(new []{
"./src/Cake.Common.Tests/bin/Release/Cake.Common.Tests.dll",
"./src/Cake.Core.Tests/bin/Release/Cake.Core.Tests.dll",
"./src/Cake.NuGet.Tests/bin/Release/Cake.NuGet.Tests.dll",
"./src/Cake.Tests/bin/Release/Cake.Tests.dll"
},
new XUnitSettings {
HtmlReport = true,
OutputDirectory = "./build"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnitAliases.XUnit(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.XUnit.XUnitSettings)">
<summary>
Runs all xUnit.net tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
<example>
<code>
var testAssemblies = GetFiles("./src/**/bin/Release/*.Tests.dll");
XUnit(testAssemblies,
new XUnitSettings {
HtmlReport = true,
OutputDirectory = "./build"
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.XUnit.XUnitRunner">
<summary>
The xUnit.net (v1) test runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnitRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.XUnit.XUnitRunner" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="runner">The runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnitRunner.Run(Cake.Core.IO.FilePath,Cake.Common.Tools.XUnit.XUnitSettings)">
<summary>
Runs the tests in the specified assembly.
</summary>
<param name="assemblyPath">The assembly path.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnitRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnitRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.XUnit.XUnitSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.XUnit.XUnitRunner" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnitSettings.ShadowCopy">
<summary>
Gets or sets a value indicating whether tests should be run as a shadow copy.
Default value is <c>true</c>.
</summary>
<value>
<c>true</c> if tests should be run as a shadow copy; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnitSettings.OutputDirectory">
<summary>
Gets or sets the output directory.
</summary>
<value>The output directory.</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnitSettings.XmlReport">
<summary>
Gets or sets a value indicating whether an XML report should be generated.
</summary>
<value>
<c>true</c> if an XML report should be generated; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnitSettings.HtmlReport">
<summary>
Gets or sets a value indicating whether an HTML report should be generated.
</summary>
<value>
<c>true</c> if an HTML report should be generated; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnitSettings.Silent">
<summary>
Gets or sets a value indicating whether or not output running test count.
</summary>
<value>
<c>true</c> if running test count should be outputted; otherwise, <c>false</c>.
</value>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnitSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.XUnit.XUnitSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.Xml.NamespaceDoc">
<summary>
This namespace contain types used to
interact with XML documents.
</summary>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySetter">
<summary>
The Chocolatey package pinner used to pin Chocolatey packages.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySetter.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySetter"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySetter.Set(System.String,System.String,Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySettings)">
<summary>
Pins Chocolatey packages using the specified package id and settings.
</summary>
<param name="apiKey">The API key.</param>
<param name="source">The Server URL where the API key is valid.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySetter"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySettings.Debug">
<summary>
Gets or sets a value indicating whether to run in debug mode.
</summary>
<value>The debug flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySettings.Verbose">
<summary>
Gets or sets a value indicating whether to run in verbose mode.
</summary>
<value>The verbose flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySettings.Force">
<summary>
Gets or sets a value indicating whether to run in forced mode.
</summary>
<value>The force flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySettings.Noop">
<summary>
Gets or sets a value indicating whether to run in noop mode.
</summary>
<value>The noop flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySettings.LimitOutput">
<summary>
Gets or sets a value indicating whether to run in limited output mode.
</summary>
<value>The limit output flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySettings.ExecutionTimeout">
<summary>
Gets or sets the execution timeout value.
</summary>
<value>The execution timeout.</value>
<remarks>Default is 2700 seconds.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySettings.CacheLocation">
<summary>
Gets or sets the location of the download cache.
</summary>
<value>The download cache location.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySettings.AllowUnofficial">
<summary>
Gets or sets a value indicating whether to run in allow unofficial mode.
</summary>
<value>The allow unofficial flag.</value>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.ChocolateyAliases">
<summary>
<para>Contains functionality for working with <see href="https://github.com/chocolatey/choco">Chocolatey</see>.</para>
<para>
In order to use the commands for this alias, Chocolatey will require to be installed on the machine where the build script
is being run. See this <see href="https://github.com/chocolatey/choco/wiki/Installation">page</see> for details on how
Chocolatey can be installed.
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyPack(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings)">
<summary>
Creates a Chocolatey package using the specified Nuspec file.
</summary>
<param name="context">The context.</param>
<param name="nuspecFilePath">The nuspec file path.</param>
<param name="settings">The settings.</param>
<example>
<code>
var chocolateyPackSettings = new ChocolateyPackSettings {
Id = "TestChocolatey",
Title = "The tile of the package",
Version = "0.0.0.1",
Authors = new[] {"John Doe"},
Owners = new[] {"Contoso"},
Summary = "Excellent summary of what the package does",
Description = "The description of the package",
ProjectUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
PackageSourceUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
ProjectSourceUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
DocsUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
MailingListUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
BugTrackerUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
Tags = new [] {"Cake", "Script", "Build"},
Copyright = "Some company 2015",
LicenseUrl = new Uri("https://github.com/SomeUser/TestChocolatey/blob/master/LICENSE.md"),
RequireLicenseAcceptance= false,
IconUrl = new Uri("http://cdn.rawgit.com/SomeUser/TestChocolatey/master/icons/testchocolatey.png"),
ReleaseNotes = new [] {"Bug fixes", "Issue fixes", "Typos"},
Files = new [] {
new ChocolateyNuSpecContent {Source = "bin/TestChocolatey.dll", Target = "bin"},
},
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
};
ChocolateyPack("./nuspec/TestChocolatey.nuspec", chocolateyPackSettings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyPack(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings)">
<summary>
Creates Chocolatey packages using the specified Nuspec files.
</summary>
<param name="context">The context.</param>
<param name="filePaths">The nuspec file paths.</param>
<param name="settings">The settings.</param>
<example>
<code>
var chocolateyPackSettings = new ChocolateyPackSettings {
Id = "TestChocolatey",
Title = "The tile of the package",
Version = "0.0.0.1",
Authors = new[] {"John Doe"},
Owners = new[] {"Contoso"},
Summary = "Excellent summary of what the package does",
Description = "The description of the package",
ProjectUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
PackageSourceUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
ProjectSourceUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
DocsUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
MailingListUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
BugTrackerUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
Tags = new [] {"Cake", "Script", "Build"},
Copyright = "Some company 2015",
LicenseUrl = new Uri("https://github.com/SomeUser/TestChocolatey/blob/master/LICENSE.md"),
RequireLicenseAcceptance= false,
IconUrl = new Uri("http://cdn.rawgit.com/SomeUser/TestChocolatey/master/icons/testchocolatey.png"),
ReleaseNotes = new [] {"Bug fixes", "Issue fixes", "Typos"},
Files = new [] {
new ChocolateyNuSpecContent {Source = "bin/TestChocolatey.dll", Target = "bin"},
},
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
};
var nuspecFiles = GetFiles("./**/*.nuspec");
ChocolateyPack(nuspecFiles, chocolateyPackSettings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyPack(Cake.Core.ICakeContext,Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings)">
<summary>
Creates a Chocolatey package using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<example>
<code>
var chocolateyPackSettings = new ChocolateyPackSettings {
Id = "TestChocolatey",
Title = "The tile of the package",
Version = "0.0.0.1",
Authors = new[] {"John Doe"},
Owners = new[] {"Contoso"},
Summary = "Excellent summary of what the package does",
Description = "The description of the package",
ProjectUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
PackageSourceUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
ProjectSourceUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
DocsUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
MailingListUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
BugTrackerUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
Tags = new [] {"Cake", "Script", "Build"},
Copyright = "Some company 2015",
LicenseUrl = new Uri("https://github.com/SomeUser/TestChocolatey/blob/master/LICENSE.md"),
RequireLicenseAcceptance= false,
IconUrl = new Uri("http://cdn.rawgit.com/SomeUser/TestChocolatey/master/icons/testchocolatey.png"),
ReleaseNotes = new [] {"Bug fixes", "Issue fixes", "Typos"},
Files = new [] {
new ChocolateyNuSpecContent {Source = "bin/TestChocolatey.dll", Target = "bin"},
},
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
};
ChocolateyPack(chocolateyPackSettings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyInstall(Cake.Core.ICakeContext,System.String)">
<summary>
Installs a Chocolatey package.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to install.</param>
<example>
<code>
ChocolateyInstall("MyChocolateyPackage");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyInstall(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings)">
<summary>
Installs a Chocolatey package using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to install.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyInstall("MyChocolateyPackage", new ChocolateyInstallSettings {
Source = true,
Version = "1.2.3",
Prerelease = false,
Forcex86 = false,
InstallArguments = "arg1",
OverrideArguments = false,
NotSilent = false,
PackageParameters = "param1",
AllowDowngrade = false,
SideBySide = false,
IgnoreDependencies = false,
ForceDependencies = false,
SkipPowerShell = false,
User = "user",
Password = "password",
IgnoreChecksums = false,
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyInstallFromConfig(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Installs Chocolatey packages using the specified package configuration.
</summary>
<param name="context">The context.</param>
<param name="packageConfigPath">The package configuration to install.</param>
<example>
<code>
ChocolateyInstallFromConfig("./tools/packages.config");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyInstallFromConfig(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings)">
<summary>
Installs Chocolatey packages using the specified package configuration and settings.
</summary>
<param name="context">The context.</param>
<param name="packageConfigPath">The package configuration to install.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyInstallFromConfig("./tools/packages.config", new ChocolateyInstallSettings {
Source = true,
Version = "1.2.3",
Prerelease = false,
Forcex86 = false,
InstallArguments = "arg1",
OverrideArguments = false,
NotSilent = false,
PackageParameters = "param1",
AllowDowngrade = false,
SideBySide = false,
IgnoreDependencies = false,
ForceDependencies = false,
SkipPowerShell = false,
User = "user",
Password = "password",
IgnoreChecksums = false,
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyUninstall(Cake.Core.ICakeContext,System.String)">
<summary>
Uninstalls a Chocolatey package.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to uninstall.</param>
<example>
<code>
ChocolateyUninstall("MyChocolateyPackage");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyUninstall(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings)">
<summary>
Uninstalls a Chocolatey package using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to uninstall.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyUninstall("MyChocolateyPackage", new ChocolateyUninstallSettings {
Source = true,
Version = "1.2.3",
UninstallArguments = "arg1",
OverrideArguments = false,
NotSilent = false,
PackageParameters = "param1",
SideBySide = false,
IgnoreDependencies = false,
ForceDependencies = false,
SkipPowerShell = false,
Debug = false,
Verbose = false,
FailOnStandardError = false,
UseSystemPowershell = false,
AllVersions = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false,
GlobalArguments = false,
GlobalPackageParameters = false,
IgnorePackageExitCodes = false,
UsePackageExitCodes = false,
UseAutoUninstaller = false,
SkipAutoUninstaller = false,
FailOnAutoUninstaller = false,
IgnoreAutoUninstaller = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyUninstall(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Uninstalls a Chocolatey package.
</summary>
<param name="context">The context.</param>
<param name="packageIds">The ids of the packages to uninstall.</param>
<example>
<code>
ChocolateyUninstall("MyChocolateyPackage");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyUninstall(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings)">
<summary>
Uninstalls Chocolatey packages using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="packageIds">The ids of the packages to uninstall.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyUninstall("MyChocolateyPackage", new ChocolateyUninstallSettings {
Source = true,
Version = "1.2.3",
UninstallArguments = "arg1",
OverrideArguments = false,
NotSilent = false,
PackageParameters = "param1",
SideBySide = false,
IgnoreDependencies = false,
ForceDependencies = false,
SkipPowerShell = false,
Debug = false,
Verbose = false,
FailOnStandardError = false,
UseSystemPowershell = false,
AllVersions = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false,
GlobalArguments = false,
GlobalPackageParameters = false,
IgnorePackageExitCodes = false,
UsePackageExitCodes = false,
UseAutoUninstaller = false,
SkipAutoUninstaller = false,
FailOnAutoUninstaller = false,
IgnoreAutoUninstaller = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyPin(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinSettings)">
<summary>
Pins a Chocolatey package using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="name">The name.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyPin("MyChocolateyPackage", new ChocolateyPinSettings {
Version = "1.2.3",
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyApiKey(Cake.Core.ICakeContext,System.String,System.String,Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySettings)">
<summary>
Sets the Api Key for a Chocolatey Source using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="apiKey">The API Key.</param>
<param name="source">The source.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyApiKey("myApiKey", "http://www.mysource.com", new ChocolateyApiKeySettings {
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyConfig(Cake.Core.ICakeContext,System.String,System.String,Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSettings)">
<summary>
Sets the config parameter using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="name">The name.</param>
<param name="value">The value.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyConfig("cacheLocation", @"c:\temp", new ChocolateyConfigSettings {
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyEnableFeature(Cake.Core.ICakeContext,System.String)">
<summary>
Enables a Chocolatey Feature using the specified name.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the feature.</param>
<example>
<code>
ChocolateyEnableFeature("checkSumFiles");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyEnableFeature(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureSettings)">
<summary>
Enables a Chocolatey Feature using the specified name and settings.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the feature.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyEnableFeature("checkSumFiles", new ChocolateyFeatureSettings {
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyDisableFeature(Cake.Core.ICakeContext,System.String)">
<summary>
Disables a Chocolatey Feature using the specified name.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the feature.</param>
<example>
<code>
ChocolateyDisableFeature("checkSumFiles");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyDisableFeature(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureSettings)">
<summary>
Disables a Chocolatey Feature using the specified name and settings.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the feature.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyDisableFeature("checkSumFiles", new ChocolateyFeatureSettings {
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyAddSource(Cake.Core.ICakeContext,System.String,System.String)">
<summary>
Adds Chocolatey package source using the specified name &source to global user config.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<param name="source">Path to the package(s) source.</param>
<example>
<code>
ChocolateyAddSource("MySource", "http://www.mysource.com");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyAddSource(Cake.Core.ICakeContext,System.String,System.String,Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings)">
<summary>
Adds Chocolatey package source using the specified name, source & settings to global user config.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<param name="source">Path to the package(s) source.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyAddSource("MySource", "http://www.mysource.com", new ChocolateySourcesSettings {
UserName = "user",
Password = "password",
Priority = 13,
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyRemoveSource(Cake.Core.ICakeContext,System.String)">
<summary>
Removes Chocolatey package source using the specified name & source from global user config.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<example>
<code>
ChocolateyRemoveSource("MySource");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyRemoveSource(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings)">
<summary>
Removes Chocolatey package source using the specified name, source & settings from global user config.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyRemoveSource("MySource", new ChocolateySourcesSettings {
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyEnableSource(Cake.Core.ICakeContext,System.String)">
<summary>
Enables a Chocolatey Source using the specified name.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<example>
<code>
ChocolateyEnableSource("MySource");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyEnableSource(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings)">
<summary>
Enables a Chocolatey Source using the specified name and settings.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyEnableSource("MySource", new ChocolateySourcesSettings {
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyDisableSource(Cake.Core.ICakeContext,System.String)">
<summary>
Disables a Chocolatey Source using the specified name.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<example>
<code>
ChocolateyDisableSource("MySource");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyDisableSource(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings)">
<summary>
Disables a Chocolatey Source using the specified name and settings.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyDisableSource("MySource", new ChocolateySourcesSettings {
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyPush(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings)">
<summary>
Pushes a Chocolatey package to a Chocolatey server and publishes it.
</summary>
<param name="context">The context.</param>
<param name="packageFilePath">The <c>.nupkg</c> file path.</param>
<param name="settings">The settings.</param>
<example>
<code>
// Get the path to the package.
var package = "./chocolatey/MyChocolateyPackage.0.0.1.nupkg";
// Push the package.
ChocolateyPush(package, new ChocolateyPushSettings {
Source = "http://example.com/chocolateyfeed",
ApiKey = "4003d786-cc37-4004-bfdf-c4f3e8ef9b3a"
Timeout = 300
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyPush(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings)">
<summary>
Pushes Chocolatey packages to a Chocolatey server and publishes them.
</summary>
<param name="context">The context.</param>
<param name="packageFilePaths">The <c>.nupkg</c> file paths.</param>
<param name="settings">The settings.</param>
<example>
<code>
// Get the paths to the packages.
var packages = GetFiles("./**/*.nupkg");
// Push the package.
ChocolateyPush(packages, new ChocolateyPushSettings {
Source = "http://example.com/chocolateyfeed",
ApiKey = "4003d786-cc37-4004-bfdf-c4f3e8ef9b3a"
Timeout = 300
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyUpgrade(Cake.Core.ICakeContext,System.String)">
<summary>
Upgrades Chocolatey package.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to upgrade.</param>
<example>
<code>
ChocolateyUpgrade("MyChocolateyPackage");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyUpgrade(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings)">
<summary>
Upgrades Chocolatey package using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to upgrade.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyUpgrade("MyChocolateyPackage", new ChocolateyUpgradeSettings {
Source = true,
Version = "1.2.3",
Prerelease = false,
Forcex86 = false,
InstallArguments = "arg1",
OverrideArguments = false,
NotSilent = false,
PackageParameters = "param1",
AllowDowngrade = false,
SideBySide = false,
IgnoreDependencies = false,
SkipPowerShell = false,
FailOnUnfound = false,
FailOnNotInstalled = false,
User = "user",
Password = "password",
IgnoreChecksums = false,
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyNew(Cake.Core.ICakeContext,System.String)">
<summary>
Generate package specification files for a new package using the default settings.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to create.</param>
<example>
<code>
ChocolateyNew("MyChocolateyPackage");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyNew(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings)">
<summary>
Generate package specification files for a new package using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to create.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyNew("MyChocolateyPackage", new ChocolateyNewSettings {
PackageVersion = "1.2.3",
MaintainerName = "John Doe",
MaintainerRepo = "johndoe"
});
</code>
</example>
<example>
<code>
var settings = new ChocolateyNewSettings {
MaintainerName = "John Doe"
}
settings.AdditionalPropertyValues("Tags", "CustomPackage");
ChocolateyNew("MyChocolateyPackage", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyDownload(Cake.Core.ICakeContext,System.String)">
<summary>
Downloads a Chocolatey package to the current working directory.
Requires Chocolatey licensed edition.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to download.</param>
<example>
<code>
ChocolateyDownload("MyChocolateyPackage");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyDownload(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings)">
<summary>
Downloads a Chocolatey package using the specified settings.
Requires Chocolatey licensed edition.
Features requiring Chocolatey for Business or a minimum version are documented
in <see cref="T:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings"/>.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to install.</param>
<param name="settings">The settings.</param>
<example>
<para>Download a package to a specific folder:</para>
<code>
ChocolateyDownload(
"MyChocolateyPackage",
new ChocolateyDownloadSettings {
OutputDirectory = @"C:\download\"
});
</code>
<para>Download and internalize a package:</para>
<code>
ChocolateyDownload(
"MyChocolateyPackage",
new ChocolateyDownloadSettings {
Internalize = true
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.ChocolateySettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.ChocolateySettings"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.Debug">
<summary>
Gets or sets a value indicating whether to run in debug mode.
</summary>
<value>The debug flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.Verbose">
<summary>
Gets or sets a value indicating whether to run in verbose mode.
</summary>
<value>The verbose flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.AcceptLicense">
<summary>
Gets or sets a value indicating whether to accept license for package.
</summary>
<value>The accept license flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.Force">
<summary>
Gets or sets a value indicating whether to run in forced mode.
</summary>
<value>The force flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.Noop">
<summary>
Gets or sets a value indicating whether to run in noop mode.
</summary>
<value>The noop flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.LimitOutput">
<summary>
Gets or sets a value indicating whether to run in limited output mode.
</summary>
<value>The limit output flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.ExecutionTimeout">
<summary>
Gets or sets the execution timeout value.
</summary>
<value>The execution timeout.</value>
<remarks>Default is 2700 seconds.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.CacheLocation">
<summary>
Gets or sets the location of the download cache.
</summary>
<value>The download cache location.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.AllowUnofficial">
<summary>
Gets or sets a value indicating whether to run in allow unofficial mode.
</summary>
<value>The allow unofficial flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.Source">
<summary>
Gets or sets a package sources to use for this command.
</summary>
<value>The package source to use for this command.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.Version">
<summary>
Gets or sets the version of the package to install.
If none specified, the latest will be used.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.OverrideArguments">
<summary>
Gets or sets a value indicating whether to override the passed arguments.
</summary>
<value>The override arguments flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.NotSilent">
<summary>
Gets or sets a value indicating whether or not to install silently.
</summary>
<value>The not silent flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.PackageParameters">
<summary>
Gets or sets the parameters to pass to the package.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.SideBySide">
<summary>
Gets or sets a value indicating whether to allow side by side installation.
</summary>
<value>The side by side installation flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.SkipPowerShell">
<summary>
Gets or sets a value indicating whether to skip the PowerShell installation of package.
</summary>
<value>The skip powershell flag.</value>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.ChocolateyTool`1">
<summary>
Base class for all Chocolatey related tools.
</summary>
<typeparam name="TSettings">The settings type.</typeparam>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyTool`1.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.ChocolateyTool`1"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyTool`1.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyTool`1.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyTool`1.GetAlternativeToolPaths(`0)">
<summary>
Gets alternative file paths which the tool may exist in.
</summary>
<param name="settings">The settings.</param>
<returns>The default tool path.</returns>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyTool`1.AddCommonArguments(Cake.Common.Tools.Chocolatey.ChocolateySettings,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Adds common arguments to the process builder.
</summary>
<param name="settings">The settings.</param>
<param name="builder">The process argument builder.</param>
<returns>The process argument builder.</returns>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.ChocolateyToolResolver">
<summary>
Contains Chocolatey path resolver functionality.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyToolResolver.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.ChocolateyToolResolver" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyToolResolver.ResolvePath">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSetter">
<summary>
The Chocolatey configuration setter.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSetter.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSetter"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSetter.Set(System.String,System.String,Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSettings)">
<summary>
Sets Chocolatey configuration parameters using the settings.
</summary>
<param name="name">The name of the config parameter.</param>
<param name="value">The value to assign to the parameter.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSetter"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSettings.Debug">
<summary>
Gets or sets a value indicating whether to run in debug mode.
</summary>
<value>The debug flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSettings.Verbose">
<summary>
Gets or sets a value indicating whether to run in verbose mode.
</summary>
<value>The verbose flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSettings.Force">
<summary>
Gets or sets a value indicating whether to run in forced mode.
</summary>
<value>The force flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSettings.Noop">
<summary>
Gets or sets a value indicating whether to run in noop mode.
</summary>
<value>The noop flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSettings.LimitOutput">
<summary>
Gets or sets a value indicating whether to run in limited output mode.
</summary>
<value>The limit output flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSettings.ExecutionTimeout">
<summary>
Gets or sets the execution timeout value.
</summary>
<value>The execution timeout.</value>
<remarks>Default is 2700 seconds.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSettings.CacheLocation">
<summary>
Gets or sets the location of the download cache.
</summary>
<value>The download cache location.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSettings.AllowUnofficial">
<summary>
Gets or sets a value indicating whether to run in allow unofficial mode.
</summary>
<value>The allow unofficial flag.</value>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloader">
<summary>
The Chocolatey package downloader used to download Chocolatey packages.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloader.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloader"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloader.Download(System.String,Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings)">
<summary>
Downloads Chocolatey packages using the specified package id and settings.
Requires Chocolatey licensed edition.
Features requiring Chocolatey for Business or a minimum version are documented
in <see cref="T:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings"/>.
</summary>
<param name="packageId">The source package id.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloader"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.Prerelease">
<summary>
Gets or sets a value indicating whether to allow downloading of prerelease packages.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.OutputDirectory">
<summary>
Gets or sets the directory for the downloaded Chocolatey packages.
By default the current working directory is used.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.IgnoreDependencies">
<summary>
Gets or sets a value indicating whether to ignore dependencies.
Requires Chocolatey licensed edition.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.Internalize">
<summary>
Gets or sets a value indicating whether all external resources should be downloaded
and the package be recompiled to use the local resources instead.
Requires Chocolatey business edition.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.InternalizeAllUrls">
<summary>
Gets or sets a value indicating whether all URLs, not only from known helpers, should be internalized.
Requires Chocolatey business edition (Licensed version 1.11.1+).
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.ResourcesLocation">
<summary>
Gets or sets the location for downloaded resource when <see cref="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.Internalize"/> is set.
<c>null</c> or <see cref="F:System.String.Empty"/> if downloaded resources should be embedded in the package.
Can be a file share or an internal URL location.
When it is a file share, it will attempt to download to that location.
When it is an internal url, it will download locally and give further instructions
where it should be uploaded to match package edits.
By default resources are embedded in the package.
Requires Chocolatey business edition.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.DownloadLocation">
<summary>
Gets or sets the location where resources should be downloaded to when <see cref="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.ResourcesLocation"/> is set.
<c>null</c> or <see cref="F:System.String.Empty"/> if <see cref="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.ResourcesLocation"/> should be used.
By default <see cref="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.ResourcesLocation"/> is used.
Requires Chocolatey business edition.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.AppendUseOriginalLocation">
<summary>
Gets or sets a value indicating whether the <c>-useOriginalLocation</c> parameter will be passed to any
<c>Install-ChocolateyPackage</c> call in the package and avoiding downloading of resources when
<see cref="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.Internalize"/> is set.
Overrides the global <c>internalizeAppendUseOriginalLocation</c> feature.
By default set to <c>false</c>.
Requires Chocolatey business edition and Chocolatey v0.10.1 or newer.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.User">
<summary>
Gets or sets the user for authenticated feeds.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.Password">
<summary>
Gets or sets the password for authenticated feeds.
</summary>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureToggler"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureSettings.Debug">
<summary>
Gets or sets a value indicating whether to run in debug mode.
</summary>
<value>The debug flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureSettings.Verbose">
<summary>
Gets or sets a value indicating whether to run in verbose mode.
</summary>
<value>The verbose flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureSettings.Force">
<summary>
Gets or sets a value indicating whether to run in forced mode.
</summary>
<value>The force flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureSettings.Noop">
<summary>
Gets or sets a value indicating whether to run in noop mode.
</summary>
<value>The noop flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureSettings.LimitOutput">
<summary>
Gets or sets a value indicating whether to run in limited output mode.
</summary>
<value>The limit output flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureSettings.ExecutionTimeout">
<summary>
Gets or sets the execution timeout value.
</summary>
<value>The execution timeout.</value>
<remarks>Default is 2700 seconds.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureSettings.CacheLocation">
<summary>
Gets or sets the location of the download cache.
</summary>
<value>The download cache location.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureSettings.AllowUnofficial">
<summary>
Gets or sets a value indicating whether to run in allow unofficial mode.
</summary>
<value>The allow unofficial flag.</value>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureToggler">
<summary>
The Chocolatey feature toggler used to enable/disable Chocolatey Features.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureToggler.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureToggler"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureToggler.EnableFeature(System.String,Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureSettings)">
<summary>
Pins Chocolatey packages using the specified package id and settings.
</summary>
<param name="name">The name of the feature.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureToggler.DisableFeature(System.String,Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureSettings)">
<summary>
Pins Chocolatey packages using the specified package id and settings.
</summary>
<param name="name">The name of the feature.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.IChocolateyToolResolver">
<summary>
Represents a Chocolatey path resolver.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.IChocolateyToolResolver.ResolvePath">
<summary>
Resolves the path to choco.exe.
</summary>
<returns>The path to choco.exe.</returns>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstaller">
<summary>
The Chocolatey package installer used to install Chocolatey packages.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstaller.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstaller"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstaller.InstallFromConfig(Cake.Core.IO.FilePath,Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings)">
<summary>
Installs Chocolatey packages using the specified package configuration file and settings.
</summary>
<param name="packageConfigPath">Path to package configuration to use for install.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstaller.Install(System.String,Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings)">
<summary>
Installs Chocolatey packages using the specified package id and settings.
</summary>
<param name="packageId">The source package id.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstaller"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.Prerelease">
<summary>
Gets or sets a value indicating whether to allow installation of prerelease packages.
This flag is not required when restoring packages by installing from packages.config.
</summary>
<value>
<c>true</c> to allow installation of prerelease packages; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.Forcex86">
<summary>
Gets or sets a value indicating whether to force installation of the x86 version of package.
</summary>
<value>The force x86 flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.InstallArguments">
<summary>
Gets or sets the install arguments to pass to native installer.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.AllowDowngrade">
<summary>
Gets or sets a value indicating whether to allow downgrade of package.
</summary>
<value>The downgrade package flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.IgnoreDependencies">
<summary>
Gets or sets a value indicating whether to ignore dependencies.
</summary>
<value>The ignore dependencies flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.ForceDependencies">
<summary>
Gets or sets a value indicating whether to force dependencies.
</summary>
<value>The force dependencies flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.User">
<summary>
Gets or sets the user for authenticated feeds.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.Password">
<summary>
Gets or sets the password for authenticated feeds.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.IgnoreChecksums">
<summary>
Gets or sets a value indicating whether to ignore checksums.
</summary>
<value>The ignore checksums flag.</value>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.New.ChocolateyScaffolder"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.OutputDirectory">
<summary>
Gets or sets the path where the package will be created.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.PackageVersion">
<summary>
Gets or sets the version of the package to be created.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.MaintainerName">
<summary>
Gets or sets the owner of the package to be created.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.MaintainerRepo">
<summary>
Gets or sets the repository of the package source.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.InstallerType">
<summary>
Gets or sets the type of the installer.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.Url">
<summary>
Gets or sets the URL where the software to be installed can be downloaded from.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.Url64">
<summary>
Gets or sets the URL where the 64-Bit version of the software to be installed can be downloaded from.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.SilentArgs">
<summary>
Gets or sets the arguments for running the installer silently.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.AdditionalPropertyValues">
<summary>
Gets the list of additional property values which should be passed to the template.
</summary>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.New.ChocolateyScaffolder">
<summary>
The Chocolatey project scaffolder used to generate package specification files for a new package.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.New.ChocolateyScaffolder.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.New.ChocolateyScaffolder"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.New.ChocolateyScaffolder.CreatePackage(System.String,Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings)">
<summary>
Generate package specification files for a new package.
</summary>
<param name="packageId">Id of the new package.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Pack.ChocolateyNuSpecContent">
<summary>
Represents a Chocolatey nuspec file.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyNuSpecContent.Source">
<summary>
Gets or sets the location of the file or files to include.
The path is relative to the NuSpec file unless an absolute path is specified.
The wildcard character - <c>*</c> - is allowed.
Using a double wildcard - <c>**</c> implies a recursive directory search.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyNuSpecContent.Target">
<summary>
Gets or sets the relative path to the directory within the package where the source files will be placed.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyNuSpecContent.Exclude">
<summary>
Gets or sets the file or files to exclude.
This is usually combined with a wildcard value in the <c>src</c> attribute.
The <c>exclude</c> attribute can contain a semi-colon delimited list of files or a file pattern.
Using a double wildcard - <c>**</c> - implies a recursive exclude pattern.
</summary>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Pack.ChocolateyNuSpecDependency">
<summary>
Represents a Chocolatey NuGet nuspec dependency.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyNuSpecDependency.Id">
<summary>
Gets or sets the dependency's package ID.
</summary>
<value>The dependency's package ID.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyNuSpecDependency.Version">
<summary>
Gets or sets the dependency's version.
</summary>
<value>The dependency's version.</value>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPacker">
<summary>
The Chocolatey packer.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPacker.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Diagnostics.ICakeLog,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPacker"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="log">The log.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPacker.Pack(Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings)">
<summary>
Creates a Chocolatey package from the specified settings.
</summary>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPacker.Pack(Cake.Core.IO.FilePath,Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings)">
<summary>
Creates a Chocolatey package from the specified Nuspec file.
</summary>
<param name="nuspecFilePath">The nuspec file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPacker"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Id">
<summary>
Gets or sets the package ID.
</summary>
<value>The package ID.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Title">
<summary>
Gets or sets the package title.
</summary>
<value>The package title.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Version">
<summary>
Gets or sets the Nuspec version.
</summary>
<value>The Nuspec version.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Authors">
<summary>
Gets or sets the package authors.
</summary>
<value>The package authors.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Owners">
<summary>
Gets or sets the package owners.
</summary>
<value>The package owners.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Summary">
<summary>
Gets or sets the package summary.
</summary>
<value>The package summary.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Description">
<summary>
Gets or sets the package description.
</summary>
<value>The package description.</value>
<remarks>Markdown format is allowed for this property.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.ProjectUrl">
<summary>
Gets or sets the package project URL.
</summary>
<value>The package project URL.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.PackageSourceUrl">
<summary>
Gets or sets the package Source URL.
</summary>
<value>The package Source URL.</value>
<remarks>Requires at least Chocolatey 0.9.9.7.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.ProjectSourceUrl">
<summary>
Gets or sets the package project Source URL.
</summary>
<value>The package project Source URL.</value>
<remarks>Requires at least Chocolatey 0.9.9.7.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.DocsUrl">
<summary>
Gets or sets the package documentation URL.
</summary>
<value>The package documentation URL.</value>
<remarks>Requires at least Chocolatey 0.9.9.7.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.MailingListUrl">
<summary>
Gets or sets the package mailing list URL.
</summary>
<value>The package mailing list URL.</value>
<remarks>Requires at least Chocolatey 0.9.9.7.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.BugTrackerUrl">
<summary>
Gets or sets the package bug tracker URL.
</summary>
<value>The package bug tracker URL.</value>
<remarks>Requires at least Chocolatey 0.9.9.7.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Tags">
<summary>
Gets or sets the package tags.
</summary>
<value>The package tags.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Copyright">
<summary>
Gets or sets the package copyright.
</summary>
<value>The package copyright.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.LicenseUrl">
<summary>
Gets or sets the package license URL.
</summary>
<value>The package license URL.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.RequireLicenseAcceptance">
<summary>
Gets or sets a value indicating whether users has to accept the package license.
</summary>
<value>
<c>true</c> if users has to accept the package license; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.IconUrl">
<summary>
Gets or sets the package icon URL.
</summary>
<value>The package icon URL.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.ReleaseNotes">
<summary>
Gets or sets the package release notes.
</summary>
<value>The package release notes.</value>
<remarks>Markdown format is allowed for this property.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Files">
<summary>
Gets or sets the package files.
</summary>
<value>The package files.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Dependencies">
<summary>
Gets or sets the package dependencies.
</summary>
<value>The package files.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Debug">
<summary>
Gets or sets a value indicating whether to run in debug mode.
</summary>
<value>The debug flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Verbose">
<summary>
Gets or sets a value indicating whether to run in verbose mode.
</summary>
<value>The verbose flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Force">
<summary>
Gets or sets a value indicating whether to run in forced mode.
</summary>
<value>The force flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Noop">
<summary>
Gets or sets a value indicating whether to run in noop mode.
</summary>
<value>The noop flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.LimitOutput">
<summary>
Gets or sets a value indicating whether to run in limited output mode.
</summary>
<value>The limit output flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.ExecutionTimeout">
<summary>
Gets or sets the execution timeout value.
</summary>
<value>The execution timeout.</value>
<remarks>Default is 2700 seconds.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.CacheLocation">
<summary>
Gets or sets the location of the download cache.
</summary>
<value>The download cache location.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.AllowUnofficial">
<summary>
Gets or sets a value indicating whether to run in allow unofficial mode.
</summary>
<value>The allow unofficial flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.OutputDirectory">
<summary>
Gets or sets a value indicating the Working Directory that should be used while running choco.exe.
</summary>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinner">
<summary>
The Chocolatey package pinner used to pin Chocolatey packages.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinner.Pin(System.String,Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinSettings)">
<summary>
Pins Chocolatey packages using the specified package id and settings.
</summary>
<param name="name">The name of the package.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinSettings.Debug">
<summary>
Gets or sets a value indicating whether to run in debug mode.
</summary>
<value>The debug flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinSettings.Verbose">
<summary>
Gets or sets a value indicating whether to run in verbose mode.
</summary>
<value>The verbose flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinSettings.Force">
<summary>
Gets or sets a value indicating whether to run in forced mode.
</summary>
<value>The force flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinSettings.Noop">
<summary>
Gets or sets a value indicating whether to run in noop mode.
</summary>
<value>The noop flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinSettings.LimitOutput">
<summary>
Gets or sets a value indicating whether to run in limited output mode.
</summary>
<value>The limit output flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinSettings.ExecutionTimeout">
<summary>
Gets or sets the execution timeout value.
</summary>
<value>The execution timeout.</value>
<remarks>Default is 2700 seconds.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinSettings.CacheLocation">
<summary>
Gets or sets the location of the download cache.
</summary>
<value>The download cache location.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinSettings.AllowUnofficial">
<summary>
Gets or sets a value indicating whether to run in allow unofficial mode.
</summary>
<value>The allow unofficial flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinSettings.Version">
<summary>
Gets or sets the version of the package to install.
If none specified, the latest will be used.
</summary>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Push.ChocolateyPusher">
<summary>
The Chocolatey package pusher.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Push.ChocolateyPusher.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.Push.ChocolateyPusher"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Push.ChocolateyPusher.Push(Cake.Core.IO.FilePath,Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings)">
<summary>
Pushes a Chocolatey package to a Chocolatey server and publishes it.
</summary>
<param name="packageFilePath">The package file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.Push.ChocolateyPusher"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings.Debug">
<summary>
Gets or sets a value indicating whether to run in debug mode.
</summary>
<value>The debug flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings.Verbose">
<summary>
Gets or sets a value indicating whether to run in verbose mode.
</summary>
<value>The verbose flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings.Force">
<summary>
Gets or sets a value indicating whether to run in forced mode.
</summary>
<value>The force flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings.Noop">
<summary>
Gets or sets a value indicating whether to run in noop mode.
</summary>
<value>The noop flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings.LimitOutput">
<summary>
Gets or sets a value indicating whether to run in limited output mode.
</summary>
<value>The limit output flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings.ExecutionTimeout">
<summary>
Gets or sets the execution timeout value.
</summary>
<value>The execution timeout.</value>
<remarks>Default is 2700 seconds.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings.CacheLocation">
<summary>
Gets or sets the location of the download cache.
</summary>
<value>The download cache location.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings.AllowUnofficial">
<summary>
Gets or sets a value indicating whether to run in allow unofficial mode.
</summary>
<value>The allow unofficial flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings.Source">
<summary>
Gets or sets the server URL. If not specified, chocolatey.org is used.
</summary>
<value>The server URL.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings.ApiKey">
<summary>
Gets or sets the API key for the server.
</summary>
<value>The API key for the server.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings.Timeout">
<summary>
Gets or sets the timeout for pushing to a server.
Defaults to 300 seconds (5 minutes).
</summary>
<value>The timeout for pushing to a server.</value>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Sources.ChocolateySources">
<summary>
The Chocolatey sources is used to work with user config feeds & credentials.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Sources.ChocolateySources.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.Sources.ChocolateySources"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Sources.ChocolateySources.AddSource(System.String,System.String,Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings)">
<summary>
Adds Chocolatey package source using the specified settings to global user config.
</summary>
<param name="name">Name of the source.</param>
<param name="source">Path to the package(s) source.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Sources.ChocolateySources.RemoveSource(System.String,Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings)">
<summary>
Remove specified Chocolatey package source.
</summary>
<param name="name">Name of the source.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Sources.ChocolateySources.EnableSource(System.String,Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings)">
<summary>
Enable specified Chocolatey package source.
</summary>
<param name="name">Name of the source.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Sources.ChocolateySources.DisableSource(System.String,Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings)">
<summary>
Disable specified Chocolatey package source.
</summary>
<param name="name">Name of the source.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.Sources.ChocolateySources"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings.Debug">
<summary>
Gets or sets a value indicating whether to run in debug mode.
</summary>
<value>The debug flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings.Verbose">
<summary>
Gets or sets a value indicating whether to run in verbose mode.
</summary>
<value>The verbose flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings.Force">
<summary>
Gets or sets a value indicating whether to run in forced mode.
</summary>
<value>The force flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings.Noop">
<summary>
Gets or sets a value indicating whether to run in noop mode.
</summary>
<value>The noop flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings.LimitOutput">
<summary>
Gets or sets a value indicating whether to run in limited output mode.
</summary>
<value>The limit output flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings.ExecutionTimeout">
<summary>
Gets or sets the execution timeout value.
</summary>
<value>The execution timeout.</value>
<remarks>Default is 2700 seconds.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings.CacheLocation">
<summary>
Gets or sets the location of the download cache.
</summary>
<value>The download cache location.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings.AllowUnofficial">
<summary>
Gets or sets a value indicating whether to run in allow unofficial mode.
</summary>
<value>The allow unofficial flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings.UserName">
<summary>
Gets or sets the (optional) user name.
</summary>
<value>Optional user name to be used when connecting to an authenticated source.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings.Password">
<summary>
Gets or sets the (optional) password.
</summary>
<value>Optional password to be used when connecting to an authenticated source.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings.Priority">
<summary>
Gets or sets the (optional) priority.
</summary>
<value>Optional priority to be used when creating source.</value>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstaller">
<summary>
The Chocolatey package uninstall used to uninstall Chocolatey packages.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstaller.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstaller"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstaller.Uninstall(System.Collections.Generic.IEnumerable{System.String},Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings)">
<summary>
Uninstalls Chocolatey packages using the specified package id and settings.
</summary>
<param name="packageIds">List of package ids to uninstall.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstaller"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings.FailOnStandardError">
<summary>
Gets or sets a value indicating whether it fails on standard error output.
</summary>
<value>The fail on standard error flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings.UseSystemPowershell">
<summary>
Gets or sets a value indicating whether an external process is used instead of built in PowerShell host.
</summary>
<value>The use system powershell flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings.AllVersions">
<summary>
Gets or sets a value indicating whether to uninstall all versions.
</summary>
<value>The all versions flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings.UninstallArguments">
<summary>
Gets or sets the uninstall arguments to pass to native installer.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings.GlobalArguments">
<summary>
Gets or sets a value indicating whether install arguments should be applied to dependent packages.
</summary>
<value>The global arguments flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings.GlobalPackageParameters">
<summary>
Gets or sets a value indicating whether global parameters are passed to the package.
</summary>
<value>The global package parameters flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings.ForceDependencies">
<summary>
Gets or sets a value indicating whether to force dependencies.
</summary>
<value>The force dependencies flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings.IgnorePackageExitCodes">
<summary>
Gets or sets a value indicating whether to Exit with a 0 for success and 1 for non-success
no matter what package scripts provide for exit codes.
</summary>
<value>The ignore package exit codes flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings.UsePackageExitCodes">
<summary>
Gets or sets a value indicating whether to use package exit codes.
</summary>
<value>The use package exit codes flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings.UseAutoUninstaller">
<summary>
Gets or sets a value indicating whether to use auto uninstaller service when uninstalling.
</summary>
<value>The use auto uninstaller flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings.SkipAutoUninstaller">
<summary>
Gets or sets a value indicating whether to skip auto uninstaller service when uninstalling.
</summary>
<value>The skip auto uninstaller flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings.FailOnAutoUninstaller">
<summary>
Gets or sets a value indicating whether to fail the package uninstall if the auto
uninstaller reports and error.
</summary>
<value>The fail auto uninstaller flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings.IgnoreAutoUninstaller">
<summary>
Gets or sets a value indicating whether to not fail the package if auto
uninstaller reports an error.
</summary>
<value>The ignore auto uninstaller flag.</value>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgrader">
<summary>
The Chocolatey package upgrader.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgrader.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgrader"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgrader.Upgrade(System.String,Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings)">
<summary>
Upgrades Chocolatey packages using the specified settings.
</summary>
<param name="packageId">The source package id.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgrader"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.Prerelease">
<summary>
Gets or sets a value indicating whether to allow upgrading to prerelease versions.
This flag is not required when updating prerelease packages that are already installed.
</summary>
<value>
<c>true</c> to allow updating to prerelease versions; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.Forcex86">
<summary>
Gets or sets a value indicating whether to force installation of the x86 version of package.
</summary>
<value>The force x86 flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.InstallArguments">
<summary>
Gets or sets the install arguments to pass to native installer.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.AllowDowngrade">
<summary>
Gets or sets a value indicating whether to allow downgrade of package.
</summary>
<value>The downgrade package flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.IgnoreDependencies">
<summary>
Gets or sets a value indicating whether to ignore dependencies.
</summary>
<value>The ignore dependencies flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.FailOnUnfound">
<summary>
Gets or sets a value indicating whether to fail on unfound packages.
</summary>
<value>The skip powershell flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.FailOnNotInstalled">
<summary>
Gets or sets a value indicating whether to fail on not installed packages.
</summary>
<value>The skip powershell flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.User">
<summary>
Gets or sets the user for authenticated feeds.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.Password">
<summary>
Gets or sets the password for authenticated feeds.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.IgnoreChecksums">
<summary>
Gets or sets a value indicating whether to ignore checksums.
</summary>
<value>The ignore checksums flag.</value>
</member>
<member name="T:Cake.Common.Tools.DotCover.Analyse.DotCoverAnalyser">
<summary>
DotCover Analyser builder.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotCover.Analyse.DotCoverAnalyser.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotCover.Analyse.DotCoverAnalyser" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotCover.Analyse.DotCoverAnalyser.Analyse(Cake.Core.ICakeContext,System.Action{Cake.Core.ICakeContext},Cake.Core.IO.FilePath,Cake.Common.Tools.DotCover.Analyse.DotCoverAnalyseSettings)">
<summary>
Runs DotCover Analyse with the specified settings.
</summary>
<param name="context">The context.</param>
<param name="action">The action.</param>
<param name="outputPath">The output file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotCover.Analyse.DotCoverAnalyseSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotCover.Analyse.DotCoverAnalyser" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotCover.Analyse.DotCoverAnalyseSettings.ReportType">
<summary>
Gets or sets the type of the report.
This represents the <c>/ReportType</c> option.
The Default value is <see cref="F:Cake.Common.Tools.DotCover.DotCoverReportType.XML"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotCover.Cover.DotCoverCoverer">
<summary>
DotCover Coverer builder.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotCover.Cover.DotCoverCoverer.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotCover.Cover.DotCoverCoverer" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotCover.Cover.DotCoverCoverer.Cover(Cake.Core.ICakeContext,System.Action{Cake.Core.ICakeContext},Cake.Core.IO.FilePath,Cake.Common.Tools.DotCover.Cover.DotCoverCoverSettings)">
<summary>
Runs DotCover Cover with the specified settings.
</summary>
<param name="context">The context.</param>
<param name="action">The action.</param>
<param name="outputPath">The output file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotCover.Cover.DotCoverCoverSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotCover.Cover.DotCoverCoverer" />.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotCover.DotCoverAliases">
<summary>
<para>Contains functionality related to <see href="https://www.jetbrains.com/dotcover/">DotCover</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the appropriate settings class:
<code>
#tool "nuget:?package=JetBrains.dotCover.CommandLineTools"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverAliases.DotCoverAnalyse(Cake.Core.ICakeContext,System.Action{Cake.Core.ICakeContext},Cake.Core.IO.FilePath,Cake.Common.Tools.DotCover.Analyse.DotCoverAnalyseSettings)">
<summary>
Runs <see href="https://www.jetbrains.com/dotcover/help/dotCover__Console_Runner_Commands.html#analyse">DotCover Analyse</see>
for the specified action and settings.
</summary>
<param name="context">The context.</param>
<param name="action">The action to run DotCover for.</param>
<param name="outputFile">The DotCover output file.</param>
<param name="settings">The settings.</param>
<example>
<code>
DotCoverAnalyse(tool => {
tool.XUnit2("./**/App.Tests.dll",
new XUnit2Settings {
ShadowCopy = false
});
},
new FilePath("./result.xml"),
new DotCoverAnalyseSettings()
.WithFilter("+:App")
.WithFilter("-:App.Tests"));
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverAliases.DotCoverCover(Cake.Core.ICakeContext,System.Action{Cake.Core.ICakeContext},Cake.Core.IO.FilePath,Cake.Common.Tools.DotCover.Cover.DotCoverCoverSettings)">
<summary>
Runs <see href="https://www.jetbrains.com/dotcover/help/dotCover__Console_Runner_Commands.html#cover">DotCover Cover</see>
for the specified action and settings.
</summary>
<param name="context">The context.</param>
<param name="action">The action to run DotCover for.</param>
<param name="outputFile">The DotCover output file.</param>
<param name="settings">The settings.</param>
<example>
<code>
DotCoverCover(tool => {
tool.XUnit2("./**/App.Tests.dll",
new XUnit2Settings {
ShadowCopy = false
});
},
new FilePath("./result.dcvr"),
new DotCoverCoverSettings()
.WithFilter("+:App")
.WithFilter("-:App.Tests"));
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverAliases.DotCoverReport(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Common.Tools.DotCover.Report.DotCoverReportSettings)">
<summary>
Runs <see href="https://www.jetbrains.com/dotcover/help/dotCover__Console_Runner_Commands.html#report">DotCover Report</see>
for the specified action and settings.
</summary>
<param name="context">The context.</param>
<param name="sourceFile">The DotCover coverage snapshot file name.</param>
<param name="outputFile">The DotCover output file.</param>
<param name="settings">The settings.</param>
<example>
<code>
DotCoverReport(new FilePath("./result.dcvr"),
new FilePath("./result.html"),
new DotCoverReportSettings {
ReportType = DotCoverReportType.HTML
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverAliases.DotCoverMerge(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Core.IO.FilePath)">
<summary>
Runs <see href="https://www.jetbrains.com/dotcover/help/dotCover__Console_Runner_Commands.html#merge">DotCover Merge</see>
for the specified action and settings.
</summary>
<param name="context">The context.</param>
<param name="sourceFiles">The list of DotCover coverage snapshot files.</param>
<param name="outputFile">The merged output file.</param>
<example>
<code>
DotCoverMerge(new[] {
new FilePath("./result1.dcvr"),
new FilePath("./result2.dcvr")
},
new FilePath("./merged.dcvr"));
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverAliases.DotCoverMerge(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Core.IO.FilePath,Cake.Common.Tools.DotCover.Merge.DotCoverMergeSettings)">
<summary>
Runs <see href="https://www.jetbrains.com/dotcover/help/dotCover__Console_Runner_Commands.html#merge">DotCover Merge</see>
for the specified action and settings.
</summary>
<param name="context">The context.</param>
<param name="sourceFiles">The list of DotCover coverage snapshot files.</param>
<param name="outputFile">The merged output file.</param>
<param name="settings">The settings.</param>
<example>
<code>
DotCoverMerge(new[] {
new FilePath("./result1.dcvr"),
new FilePath("./result2.dcvr")
},
new FilePath("./merged.dcvr"),
new DotCoverMergeSettings {
LogFile = new FilePath("./log.txt")
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotCover.DotCoverTool`1" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotCover.DotCoverCoverageSettings.TargetWorkingDir">
<summary>
Gets or sets program working directory
This represents the <c>/TargetWorkingDir</c> option.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotCover.DotCoverCoverageSettings.Scope">
<summary>
Gets the assemblies loaded in the specified scope into coverage results.
Ant-style patterns are supported here (e.g.ProjectFolder/**/*.dll)
This represents the <c>/Scope</c> option.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotCover.DotCoverCoverageSettings.Filters">
<summary>
Gets the coverage filters using the following syntax: +:module=*;class=*;function=*;
Use -:myassembly to exclude an assembly from code coverage.
Asterisk wildcard (*) is supported here.
This represents the <c>/Filters</c> option.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotCover.DotCoverCoverageSettings.AttributeFilters">
<summary>
Gets the attribute filters using the following syntax: filter1;filter2;...
Asterisk wildcard(*) is supported here
This represents the <c>/AttributeFilters</c> option.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotCover.DotCoverCoverageSettings.ProcessFilters">
<summary>
Gets the coverage process filters using the following syntax: +:test.exe;program.exe*;
Use -:anexe to exclude an assembly from code coverage.
This represents the <c>/ProcessFilters</c> option.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotCover.DotCoverCoverageSettings.DisableDefaultFilters">
<summary>
Gets or sets a value indicating whether the default (automatically added) filters should be disabled
This represents the <c>/DisableDefaultFilters</c> option.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverCoverageSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettingsExtensions">
<summary>
Contains extensions for <see cref="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettings"/>.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverCoverageSettingsExtensions.WithScope``1(``0,System.String)">
<summary>
Adds the scope.
</summary>
<param name="settings">The settings.</param>
<param name="scope">The scope.</param>
<typeparam name="T">The settings type, derived from <see cref="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettings"/>.</typeparam>
<returns>The same <see cref="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverCoverageSettingsExtensions.WithFilter``1(``0,System.String)">
<summary>
Adds the filter.
</summary>
<param name="settings">The settings.</param>
<param name="filter">The filter.</param>
<typeparam name="T">The settings type, derived from <see cref="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettings"/>.</typeparam>
<returns>The same <see cref="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverCoverageSettingsExtensions.WithAttributeFilter``1(``0,System.String)">
<summary>
Adds the attribute filter.
</summary>
<param name="settings">The settings.</param>
<param name="attributeFilter">The filter.</param>
<typeparam name="T">The settings type, derived from <see cref="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettings"/>.</typeparam>
<returns>The same <see cref="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverCoverageSettingsExtensions.WithProcessFilter``1(``0,System.String)">
<summary>
Adds the filter.
</summary>
<param name="settings">The settings.</param>
<param name="filter">The process filter.</param>
<typeparam name="T">The settings type, derived from <see cref="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettings"/>.</typeparam>
<returns>The same <see cref="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Common.Tools.DotCover.DotCoverCoverageTool`1">
<summary>
DotCover Coverage tool.
</summary>
<typeparam name="TSettings">The settings type.</typeparam>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverCoverageTool`1.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotCover.DotCoverCoverageTool`1" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverCoverageTool`1.GetTargetArguments(Cake.Core.ICakeContext,System.Action{Cake.Core.ICakeContext})">
<summary>
Get arguments from the target executable.
</summary>
<param name="context">The context.</param>
<param name="action">The action to run DotCover for.</param>
<returns>The process arguments.</returns>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverCoverageTool`1.GetCoverageArguments(Cake.Common.Tools.DotCover.DotCoverCoverageSettings)">
<summary>
Get arguments from coverage settings.
</summary>
<param name="settings">The settings.</param>
<returns>The process arguments.</returns>
</member>
<member name="T:Cake.Common.Tools.DotCover.DotCoverReportType">
<summary>
Represents DotCover ReportType.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotCover.DotCoverReportType.XML">
<summary>
ReportType: <c>XML</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.DotCover.DotCoverReportType.HTML">
<summary>
ReportType: <c>HTML</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.DotCover.DotCoverReportType.JSON">
<summary>
ReportType: <c>JSON</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.DotCover.DotCoverReportType.DetailedXML">
<summary>
ReportType: <c>DetailedXML</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.DotCover.DotCoverReportType.NDependXML">
<summary>
ReportType: <c>NDependXML</c>
</summary>
</member>
<member name="T:Cake.Common.Tools.DotCover.DotCoverSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotCover.DotCoverTool`1" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotCover.DotCoverSettings.LogFile">
<summary>
Gets or sets a value that enables logging and specifies log file name
This represents the <c>/LogFile</c> option.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotCover.DotCoverSettings.ConfigFile">
<summary>
Gets or sets a value that enables DotCover configuration file.
A configuration file is a reasonable alternative
to specifying all parameters in-line or having them in a batch file.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotCover.DotCoverSettingsExtensions">
<summary>
Contains extensions for <see cref="T:Cake.Common.Tools.DotCover.DotCoverSettings"/>.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverSettingsExtensions.WithConfigFile``1(``0,Cake.Core.IO.FilePath)">
<summary>
Adds the scope.
</summary>
<param name="settings">The settings.</param>
<param name="configFile">The DotCover configuration file.</param>
<typeparam name="T">The settings type, derived from <see cref="T:Cake.Common.Tools.DotCover.DotCoverSettings"/>.</typeparam>
<returns>The same <see cref="T:Cake.Common.Tools.DotCover.DotCoverSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Common.Tools.DotCover.DotCoverTool`1">
<summary>
Base class for all DotCover related tools.
</summary>
<typeparam name="TSettings">The settings type.</typeparam>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverTool`1.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotCover.DotCoverTool`1" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverTool`1.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverTool`1.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverTool`1.GetArguments(Cake.Common.Tools.DotCover.DotCoverSettings)">
<summary>
Get arguments from global settings.
</summary>
<param name="settings">The settings.</param>
<returns>The process arguments.</returns>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverTool`1.GetConfigurationFileArgument(Cake.Common.Tools.DotCover.DotCoverSettings)">
<summary>
Get configuration full path from coverage settings.
</summary>
<param name="settings">The settings.</param>
<returns>The process arguments.</returns>
</member>
<member name="T:Cake.Common.Tools.DotCover.Merge.DotCoverMerger">
<summary>
DotCover Merge merger.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotCover.Merge.DotCoverMerger.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotCover.Merge.DotCoverMerger" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotCover.Merge.DotCoverMerger.Merge(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Core.IO.FilePath,Cake.Common.Tools.DotCover.Merge.DotCoverMergeSettings)">
<summary>
Runs DotCover Merge with the specified settings.
</summary>
<param name="sourceFiles">The list of DotCover coverage snapshot files.</param>
<param name="outputFile">The merged output file.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotCover.Merge.DotCoverMergeSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotCover.Merge.DotCoverMerger" />.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotCover.Report.DotCoverReporter">
<summary>
DotCover Report reporter.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotCover.Report.DotCoverReporter.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotCover.Report.DotCoverReporter" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotCover.Report.DotCoverReporter.Report(Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Common.Tools.DotCover.Report.DotCoverReportSettings)">
<summary>
Runs DotCover Cover with the specified settings.
</summary>
<param name="sourceFile">The DotCover coverage snapshot file name.</param>
<param name="outputFile">The DotCover output file.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotCover.Report.DotCoverReportSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotCover.Report.DotCoverReporter" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotCover.Report.DotCoverReportSettings.ReportType">
<summary>
Gets or sets the type of the report.
This represents the <c>/ReportType</c> option.
The Default value is <see cref="F:Cake.Common.Tools.DotCover.DotCoverReportType.XML"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.BuildServer.DotNetCoreBuildServer">
<summary>
.NET Core project builder.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.BuildServer.DotNetCoreBuildServer.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNetCore.BuildServer.DotNetCoreBuildServer" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.BuildServer.DotNetCoreBuildServer.Shutdown(Cake.Common.Tools.DotNetCore.BuildServer.DotNetCoreBuildServerSettings)">
<summary>
Build the project using the specified path and settings.
</summary>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.BuildServer.DotNetCoreBuildServerSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNetCore.BuildServer.DotNetCoreBuildServer" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.BuildServer.DotNetCoreBuildServerSettings.MSBuild">
<summary>
Gets or sets if to shuts down the MSBuild build server.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.BuildServer.DotNetCoreBuildServerSettings.Razor">
<summary>
Gets or sets if to shuts down the the Razor build server.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.BuildServer.DotNetCoreBuildServerSettings.VBCSCompiler">
<summary>
Gets or sets if to shuts down the VB/C# compiler build server.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.Build.DotNetCoreBuilder">
<summary>
.NET Core project builder.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.Build.DotNetCoreBuilder.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNetCore.Build.DotNetCoreBuilder" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.Build.DotNetCoreBuilder.Build(System.String,Cake.Common.Tools.DotNetCore.Build.DotNetCoreBuildSettings)">
<summary>
Build the project using the specified path and settings.
</summary>
<param name="project">The target project path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.Build.DotNetCoreBuildSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNetCore.Build.DotNetCoreBuilder" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Build.DotNetCoreBuildSettings.OutputDirectory">
<summary>
Gets or sets the output directory.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Build.DotNetCoreBuildSettings.Runtime">
<summary>
Gets or sets the target runtime.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Build.DotNetCoreBuildSettings.Configuration">
<summary>
Gets or sets the configuration under which to build.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Build.DotNetCoreBuildSettings.Framework">
<summary>
Gets or sets the specific framework to compile.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Build.DotNetCoreBuildSettings.VersionSuffix">
<summary>
Gets or sets the value that defines what `*` should be replaced with in version field in project.json.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Build.DotNetCoreBuildSettings.NoIncremental">
<summary>
Gets or sets a value indicating whether to mark the build as unsafe for incrementality.
This turns off incremental compilation and forces a clean rebuild of the project dependency graph.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Build.DotNetCoreBuildSettings.NoDependencies">
<summary>
Gets or sets a value indicating whether to ignore project to project references and only build the root project.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Build.DotNetCoreBuildSettings.NoRestore">
<summary>
Gets or sets a value indicating whether to not do implicit NuGet package restore.
This makes build faster, but requires restore to be done before build is executed.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Build.DotNetCoreBuildSettings.NoLogo">
<summary>
Gets or sets a value indicating whether to display the startup banner or the copyright message.
</summary>
<remarks>
Available since .NET Core 3.0 SDK.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Build.DotNetCoreBuildSettings.Sources">
<summary>
Gets or sets the specified NuGet package sources to use during the build.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Build.DotNetCoreBuildSettings.MSBuildSettings">
<summary>
Gets or sets additional arguments to be passed to MSBuild.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.Clean.DotNetCoreCleaner">
<summary>
.NET Core project cleaner.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.Clean.DotNetCoreCleaner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNetCore.Clean.DotNetCoreCleaner" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.Clean.DotNetCoreCleaner.Clean(System.String,Cake.Common.Tools.DotNetCore.Clean.DotNetCoreCleanSettings)">
<summary>
Cleans the project's output using the specified path and settings.
</summary>
<param name="project">The target project path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.Clean.DotNetCoreCleanSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNetCore.Clean.DotNetCoreCleaner" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Clean.DotNetCoreCleanSettings.OutputDirectory">
<summary>
Gets or sets the output directory.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Clean.DotNetCoreCleanSettings.Configuration">
<summary>
Gets or sets the configuration under which to build.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Clean.DotNetCoreCleanSettings.Framework">
<summary>
Gets or sets the specific framework to compile.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Clean.DotNetCoreCleanSettings.Runtime">
<summary>
Gets or sets the target runtime.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Clean.DotNetCoreCleanSettings.NoLogo">
<summary>
Gets or sets a value indicating whether to display the startup banner or the copyright message.
</summary>
<remarks>
Available since .NET Core 3.0 SDK.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Clean.DotNetCoreCleanSettings.MSBuildSettings">
<summary>
Gets or sets additional arguments to be passed to MSBuild.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.DotNetCoreAliases">
<summary>
<para>Contains functionality related to <see href="https://github.com/dotnet/cli">.NET Core CLI</see>.</para>
<para>
In order to use the commands for this alias, the .Net Core CLI tools will need to be installed on the machine where
the Cake script is being executed. See this <see href="https://www.microsoft.com/net/core">page</see> for information
on how to install.
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreExecute(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Execute an assembly.
</summary>
<param name="context">The context.</param>
<param name="assemblyPath">The assembly path.</param>
<example>
<code>
DotNetCoreExecute("./bin/Debug/app.dll");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreExecute(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Execute an assembly with arguments in the specific path.
</summary>
<param name="context">The context.</param>
<param name="assemblyPath">The assembly path.</param>
<param name="arguments">The arguments.</param>
<example>
<code>
DotNetCoreExecute("./bin/Debug/app.dll", "--arg");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreExecute(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.ProcessArgumentBuilder,Cake.Common.Tools.DotNetCore.Execute.DotNetCoreExecuteSettings)">
<summary>
Execute an assembly with arguments in the specific path with settings.
</summary>
<param name="context">The context.</param>
<param name="assemblyPath">The assembly path.</param>
<param name="arguments">The arguments.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreExecuteSettings
{
FrameworkVersion = "1.0.3"
};
DotNetCoreExecute("./bin/Debug/app.dll", "--arg", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreRestore(Cake.Core.ICakeContext)">
<summary>
Restore all NuGet Packages.
</summary>
<param name="context">The context.</param>
<example>
<code>
DotNetCoreRestore();
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreRestore(Cake.Core.ICakeContext,System.String)">
<summary>
Restore all NuGet Packages in the specified path.
</summary>
<param name="context">The context.</param>
<param name="root">List of projects and project folders to restore. Each value can be: a path to a project.json or global.json file, or a folder to recursively search for project.json files.</param>
<example>
<code>
DotNetCoreRestore("./src/*");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreRestore(Cake.Core.ICakeContext,Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestoreSettings)">
<summary>
Restore all NuGet Packages with the settings.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreRestoreSettings
{
Sources = new[] {"https://www.example.com/nugetfeed", "https://www.example.com/nugetfeed2"},
FallbackSources = new[] {"https://www.example.com/fallbacknugetfeed"},
PackagesDirectory = "./packages",
Verbosity = Information,
DisableParallel = true,
InferRuntimes = new[] {"runtime1", "runtime2"}
};
DotNetCoreRestore(settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreRestore(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestoreSettings)">
<summary>
Restore all NuGet Packages in the specified path with settings.
</summary>
<param name="context">The context.</param>
<param name="root">List of projects and project folders to restore. Each value can be: a path to a project.json or global.json file, or a folder to recursively search for project.json files.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreRestoreSettings
{
Sources = new[] {"https://www.example.com/nugetfeed", "https://www.example.com/nugetfeed2"},
FallbackSources = new[] {"https://www.example.com/fallbacknugetfeed"},
PackagesDirectory = "./packages",
Verbosity = Information,
DisableParallel = true,
InferRuntimes = new[] {"runtime1", "runtime2"}
};
DotNetCoreRestore("./src/*", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreBuild(Cake.Core.ICakeContext,System.String)">
<summary>
Build all projects.
</summary>
<param name="context">The context.</param>
<param name="project">The projects path.</param>
<example>
<code>
DotNetCoreBuild("./src/*");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreBuild(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNetCore.Build.DotNetCoreBuildSettings)">
<summary>
Build all projects.
</summary>
<param name="context">The context.</param>
<param name="project">The projects path.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreBuildSettings
{
Framework = "netcoreapp2.0",
Configuration = "Debug",
OutputDirectory = "./artifacts/"
};
DotNetCoreBuild("./src/*", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCorePack(Cake.Core.ICakeContext,System.String)">
<summary>
Package all projects.
</summary>
<param name="context">The context.</param>
<param name="project">The projects path.</param>
<example>
<code>
DotNetCorePack("./src/*");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCorePack(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNetCore.Pack.DotNetCorePackSettings)">
<summary>
Package all projects.
</summary>
<param name="context">The context.</param>
<param name="project">The projects path.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCorePackSettings
{
Configuration = "Release",
OutputDirectory = "./artifacts/"
};
DotNetCorePack("./src/*", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreRun(Cake.Core.ICakeContext)">
<summary>
Run all projects.
</summary>
<param name="context">The context.</param>
<example>
<code>
DotNetCoreRun();
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreRun(Cake.Core.ICakeContext,System.String)">
<summary>
Run project.
</summary>
<param name="context">The context.</param>
<param name="project">The project path.</param>
<example>
<code>
DotNetCoreRun("./src/Project");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreRun(Cake.Core.ICakeContext,System.String,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Run project with path and arguments.
</summary>
<param name="context">The context.</param>
<param name="project">The project path.</param>
<param name="arguments">The arguments.</param>
<example>
<code>
DotNetCoreRun("./src/Project", "--args");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreRun(Cake.Core.ICakeContext,System.String,Cake.Core.IO.ProcessArgumentBuilder,Cake.Common.Tools.DotNetCore.Run.DotNetCoreRunSettings)">
<summary>
Run project with settings.
</summary>
<param name="context">The context.</param>
<param name="project">The project path.</param>
<param name="arguments">The arguments.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreRunSettings
{
Framework = "netcoreapp2.0",
Configuration = "Release"
};
DotNetCoreRun("./src/Project", "--args", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreRun(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNetCore.Run.DotNetCoreRunSettings)">
<summary>
Run project with settings.
</summary>
<param name="context">The context.</param>
<param name="project">The project path.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreRunSettings
{
Framework = "netcoreapp2.0",
Configuration = "Release"
};
DotNetCoreRun("./src/Project", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCorePublish(Cake.Core.ICakeContext,System.String)">
<summary>
Publish all projects.
</summary>
<param name="context">The context.</param>
<param name="project">The projects path.</param>
<example>
<code>
DotNetCorePublish("./src/*");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCorePublish(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings)">
<summary>
Publish all projects.
</summary>
<param name="context">The context.</param>
<param name="project">The projects path.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCorePublishSettings
{
Framework = "netcoreapp2.0",
Configuration = "Release",
OutputDirectory = "./artifacts/"
};
DotNetCorePublish("./src/*", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreTest(Cake.Core.ICakeContext)">
<summary>
Test project.
</summary>
<param name="context">The context.</param>
<example>
<code>
DotNetCoreTest();
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreTest(Cake.Core.ICakeContext,System.String)">
<summary>
Test project with path.
</summary>
<param name="context">The context.</param>
<param name="project">The project path.</param>
<example>
<para>Specify the path to the .csproj file in the test project.</para>
<code>
DotNetCoreTest("./test/Project.Tests/Project.Tests.csproj");
</code>
<para>You could also specify a task that runs multiple test projects.</para>
<para>Cake task:</para>
<code>
Task("Test")
.Does(() =>
{
var projectFiles = GetFiles("./test/**/*.csproj");
foreach(var file in projectFiles)
{
DotNetCoreTest(file.FullPath);
}
});
</code>
<para>If your test project is using project.json, the project parameter should just be the directory path.</para>
<code>
DotNetCoreTest("./test/Project.Tests/");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreTest(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNetCore.Test.DotNetCoreTestSettings)">
<summary>
Test project with settings.
</summary>
<param name="context">The context.</param>
<param name="project">The project path.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreTestSettings
{
Configuration = "Release"
};
DotNetCoreTest("./test/Project.Tests/Project.Tests.csproj", settings);
</code>
<para>You could also specify a task that runs multiple test projects.</para>
<para>Cake task:</para>
<code>
Task("Test")
.Does(() =>
{
var settings = new DotNetCoreTestSettings
{
Configuration = "Release"
};
var projectFiles = GetFiles("./test/**/*.csproj");
foreach(var file in projectFiles)
{
DotNetCoreTest(file.FullPath, settings);
}
});
</code>
<para>If your test project is using project.json, the project parameter should just be the directory path.</para>
<code>
var settings = new DotNetCoreTestSettings
{
Configuration = "Release"
};
DotNetCoreTest("./test/Project.Tests/", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreTest(Cake.Core.ICakeContext,System.String,Cake.Core.IO.ProcessArgumentBuilder,Cake.Common.Tools.DotNetCore.Test.DotNetCoreTestSettings)">
<summary>
Test project with settings.
</summary>
<param name="context">The context.</param>
<param name="project">The project path.</param>
<param name="arguments">The arguments.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreTestSettings
{
Configuration = "Release"
};
DotNetCoreTest("./test/Project.Tests/Project.Tests.csproj", settings);
</code>
<para>You could also specify a task that runs multiple test projects.</para>
<para>Cake task:</para>
<code>
Task("Test")
.Does(() =>
{
var settings = new DotNetCoreTestSettings
{
Configuration = "Release"
};
var projectFiles = GetFiles("./test/**/*.csproj");
foreach(var file in projectFiles)
{
DotNetCoreTest(file.FullPath, "MSTest.MapInconclusiveToFailed=true", settings);
}
});
</code>
<para>If your test project is using project.json, the project parameter should just be the directory path.</para>
<code>
var settings = new DotNetCoreTestSettings
{
Configuration = "Release"
};
DotNetCoreTest("./test/Project.Tests/", "MSTest.MapInconclusiveToFailed=true", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreClean(Cake.Core.ICakeContext,System.String)">
<summary>
Cleans a project's output.
</summary>
<param name="context">The context.</param>
<param name="project">The project's path.</param>
<example>
<code>
DotNetCoreClean("./src/project");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreClean(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNetCore.Clean.DotNetCoreCleanSettings)">
<summary>
Cleans a project's output.
</summary>
<param name="context">The context.</param>
<param name="project">The projects path.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreCleanSettings
{
Framework = "netcoreapp2.0",
Configuration = "Debug",
OutputDirectory = "./artifacts/"
};
DotNetCoreClean("./src/project", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreNuGetDelete(Cake.Core.ICakeContext)">
<summary>
Delete a NuGet Package from a server.
</summary>
<param name="context">The context.</param>
<example>
<code>
DotNetCoreNuGetDelete();
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreNuGetDelete(Cake.Core.ICakeContext,System.String)">
<summary>
Deletes a package from nuget.org.
</summary>
<param name="context">The context.</param>
<param name="packageName">Name of package to delete.</param>
<example>
<code>
DotNetCoreNuGetDelete("Microsoft.AspNetCore.Mvc");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreNuGetDelete(Cake.Core.ICakeContext,System.String,System.String)">
<summary>
Deletes a specific version of a package from nuget.org.
</summary>
<param name="context">The context.</param>
<param name="packageName">Name of package to delete.</param>
<param name="packageVersion">Version of package to delete.</param>
<example>
<code>
DotNetCoreRestore("Microsoft.AspNetCore.Mvc", "1.0");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreNuGetDelete(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNetCore.NuGet.Delete.DotNetCoreNuGetDeleteSettings)">
<summary>
Deletes a package from a server.
</summary>
<param name="context">The context.</param>
<param name="packageName">Name of package to delete.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreNuGetDeleteSettings
{
Source = "https://www.example.com/nugetfeed",
NonInteractive = true
};
DotNetCoreNuGetDelete("Microsoft.AspNetCore.Mvc", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreNuGetDelete(Cake.Core.ICakeContext,Cake.Common.Tools.DotNetCore.NuGet.Delete.DotNetCoreNuGetDeleteSettings)">
<summary>
Deletes a package from a server using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreNuGetDeleteSettings
{
Source = "https://www.example.com/nugetfeed",
NonInteractive = true
};
DotNetCoreNuGetDelete(settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreNuGetDelete(Cake.Core.ICakeContext,System.String,System.String,Cake.Common.Tools.DotNetCore.NuGet.Delete.DotNetCoreNuGetDeleteSettings)">
<summary>
Deletes a package from a server using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="packageName">Name of package to delete.</param>
<param name="packageVersion">Version of package to delete.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreNuGetDeleteSettings
{
Source = "https://www.example.com/nugetfeed",
NonInteractive = true
};
DotNetCoreNuGetDelete("Microsoft.AspNetCore.Mvc", "1.0", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreNuGetPush(Cake.Core.ICakeContext,System.String)">
<summary>
Pushes one or more packages to a server.
</summary>
<param name="context">The context.</param>
<param name="packageName">Name of package to push.</param>
<example>
<code>
DotNetCoreNuGetPush("*.nupkg");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreNuGetPush(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNetCore.NuGet.Push.DotNetCoreNuGetPushSettings)">
<summary>
Pushes one or more packages to a server using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="packageName">Name of package to push.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreNuGetPushSettings
{
Source = "https://www.example.com/nugetfeed",
ApiKey = "4003d786-cc37-4004-bfdf-c4f3e8ef9b3a"
};
DotNetCoreNuGetPush("foo*.nupkg", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreNuGetAddSource(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourceSettings)">
<summary>
Add the specified NuGet source.
</summary>
<param name="context">The context.</param>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreNuGetSourceSettings
{
Source = "https://www.example.com/nugetfeed",
UserName = "username",
Password = "password",
StorePasswordInClearText = true,
ValidAuthenticationTypes = "basic,negotiate"
};
DotNetCoreNuGetAddSource("example", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreNuGetDisableSource(Cake.Core.ICakeContext,System.String)">
<summary>
Disable the specified NuGet source.
</summary>
<param name="context">The context.</param>
<param name="name">The name of the source.</param>
<example>
<code>
DotNetCoreNuGetDisableSource("example");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreNuGetDisableSource(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourceSettings)">
<summary>
Disable the specified NuGet source.
</summary>
<param name="context">The context.</param>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreNuGetSourceSettings
{
ConfigFile = "NuGet.config"
};
DotNetCoreNuGetDisableSource("example", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreNuGetEnableSource(Cake.Core.ICakeContext,System.String)">
<summary>
Enable the specified NuGet source.
</summary>
<param name="context">The context.</param>
<param name="name">The name of the source.</param>
<example>
<code>
DotNetCoreNuGetEnableSource("example");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreNuGetEnableSource(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourceSettings)">
<summary>
Enable the specified NuGet source.
</summary>
<param name="context">The context.</param>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreNuGetSourceSettings
{
ConfigFile = "NuGet.config"
};
DotNetCoreNuGetEnableSource("example", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreNuGetHasSource(Cake.Core.ICakeContext,System.String)">
<summary>
Determines whether the specified NuGet source exists.
</summary>
<param name="context">The context.</param>
<param name="name">The name of the source.</param>
<returns>Whether the specified NuGet source exists.</returns>
<example>
<code>
var exists = DotNetCoreNuGetHasSource("example");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreNuGetHasSource(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourceSettings)">
<summary>
Determines whether the specified NuGet source exists.
</summary>
<param name="context">The context.</param>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
<returns>Whether the specified NuGet source exists.</returns>
<example>
<code>
var settings = new DotNetCoreNuGetSourceSettings
{
ConfigFile = "NuGet.config"
};
var exists = DotNetCoreNuGetHasSource("example", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreNuGetRemoveSource(Cake.Core.ICakeContext,System.String)">
<summary>
Remove the specified NuGet source.
</summary>
<param name="context">The context.</param>
<param name="name">The name of the source.</param>
<example>
<code>
DotNetCoreNuGetRemoveSource("example");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreNuGetRemoveSource(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourceSettings)">
<summary>
Remove the specified NuGet source.
</summary>
<param name="context">The context.</param>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreNuGetSourceSettings
{
ConfigFile = "NuGet.config"
};
DotNetCoreNuGetRemoveSource("example", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreNuGetUpdateSource(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourceSettings)">
<summary>
Update the specified NuGet source.
</summary>
<param name="context">The context.</param>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreNuGetSourceSettings
{
Source = "https://www.example.com/nugetfeed",
UserName = "username",
Password = "password",
StorePasswordInClearText = true,
ValidAuthenticationTypes = "basic,negotiate"
};
DotNetCoreNuGetUpdateSource("example", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreMSBuild(Cake.Core.ICakeContext)">
<summary>
Builds the specified targets in a project file found in the current working directory.
</summary>
<param name="context">The context.</param>
<example>
<code>
DotNetCoreMSBuild();
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreMSBuild(Cake.Core.ICakeContext,System.String)">
<summary>
Builds the specified targets in the project file.
</summary>
<param name="context">The context.</param>
<param name="projectOrDirectory">Project file or directory to search for project file.</param>
<example>
<code>
DotNetCoreMSBuild("foobar.proj");
</code>
</example>
<remarks>
If a directory is specified, MSBuild searches that directory for a project file.
</remarks>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreMSBuild(Cake.Core.ICakeContext,Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings)">
<summary>
Builds the specified targets in a project file found in the current working directory.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreMSBuildSettings
{
NoLogo = true,
MaxCpuCount = -1
};
DotNetCoreMSBuild(settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreMSBuild(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings)">
<summary>
Builds the specified targets in the project file.
</summary>
<param name="context">The context.</param>
<param name="projectOrDirectory">Project file or directory to search for project file.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreMSBuildSettings
{
NoLogo = true,
MaxCpuCount = -1
};
DotNetCoreMSBuild("foobar.proj", settings);
</code>
</example>
<remarks>
If a project file is not specified, MSBuild searches the current working directory for a file that has a file
extension that ends in "proj" and uses that file. If a directory is specified, MSBuild searches that directory for a project file.
</remarks>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreVSTest(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Test one or more projects specified by a path or glob pattern using the VS Test host runner.
</summary>
<param name="context">The context.</param>
<param name="testFile">A path to the test file or glob for one or more test files.</param>
<example>
<para>Specify the path to the .csproj file in the test project.</para>
<code>
DotNetCoreVSTest("./test/Project.Tests/bin/Release/netcoreapp2.1/Project.Tests.dll");
</code>
<para>You could also specify a glob pattern to run multiple test projects.</para>
<code>
DotNetCoreVSTest("./**/bin/Release/netcoreapp2.1/*.Tests.dll");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreVSTest(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTestSettings)">
<summary>
Test one or more projects specified by a path or glob pattern with settings using the VS Test host runner.
</summary>
<param name="context">The context.</param>
<param name="testFile">A path to the test file or glob for one or more test files.</param>
<param name="settings">The settings.</param>
<example>
<para>Specify the path to the .csproj file in the test project.</para>
<code>
var settings = new DotNetCoreVSTestSettings
{
Framework = "FrameworkCore10",
Platform = "x64"
};
DotNetCoreTest("./test/Project.Tests/bin/Release/netcoreapp2.1/Project.Tests.dll", settings);
</code>
<para>You could also specify a glob pattern to run multiple test projects.</para>
<code>
var settings = new DotNetCoreVSTestSettings
{
Framework = "FrameworkCore10",
Platform = "x64",
Parallel = true
};
DotNetCoreVSTest("./**/bin/Release/netcoreapp2.1/*.Tests.dll", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreVSTest(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTestSettings)">
<summary>
Test one or more specified projects with settings using the VS Test host runner.
</summary>
<param name="context">The context.</param>
<param name="testFiles">The project paths to test.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreVSTestSettings
{
Framework = "FrameworkCore10",
Platform = "x64"
};
DotNetCoreVSTest(new[] { (FilePath)"./test/Project.Tests/bin/Release/netcoreapp2.1/Project.Tests.dll" }, settings);
</code>
<para>You could also specify a task that runs multiple test projects.</para>
<para>Cake task:</para>
<code>
Task("Test")
.Does(() =>
{
var settings = new DotNetCoreVSTestSettings
{
Framework = "FrameworkCore10",
Platform = "x64",
Parallel = true
};
var testFiles = GetFiles("./test/**/bin/Release/netcoreapp2.1/*.Test.dll");
DotNetCoreVSTest(testFiles, settings);
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreTool(Cake.Core.ICakeContext,System.String)">
<summary>
Execute an .NET Core Extensibility Tool.
</summary>
<param name="context">The context.</param>
<param name="command">The command to execute.</param>
<example>
<code>
DotNetCoreTool("cake");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreTool(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNetCore.Tool.DotNetCoreToolSettings)">
<summary>
Execute an .NET Core Extensibility Tool.
</summary>
<param name="context">The context.</param>
<param name="command">The command to execute.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreToolSettings
{
DiagnosticOutput = true
};
DotNetCoreTool("cake", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreTool(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,System.String)">
<summary>
Execute an .NET Core Extensibility Tool.
</summary>
<param name="context">The context.</param>
<param name="projectPath">The project path.</param>
<param name="command">The command to execute.</param>
<example>
<code>
DotNetCoreTool("./src/project", "xunit", "-xml report.xml");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreTool(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,System.String,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Execute an .NET Core Extensibility Tool.
</summary>
<param name="context">The context.</param>
<param name="projectPath">The project path.</param>
<param name="command">The command to execute.</param>
<param name="arguments">The arguments.</param>
<example>
<code>
DotNetCoreTool("./src/project", "xunit", "-xml report.xml");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreTool(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,System.String,Cake.Core.IO.ProcessArgumentBuilder,Cake.Common.Tools.DotNetCore.Tool.DotNetCoreToolSettings)">
<summary>
Execute an .NET Core Extensibility Tool.
</summary>
<param name="context">The context.</param>
<param name="projectPath">The project path.</param>
<param name="command">The command to execute.</param>
<param name="arguments">The arguments.</param>
<param name="settings">The settings.</param>
<example>
<code>
DotNetCoreTool("./src/project", "xunit", "-xml report.xml");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreBuildServerShutdown(Cake.Core.ICakeContext)">
<summary>
Shuts down build servers that are started from dotnet.
</summary>
<param name="context">The context.</param>
<example>
<code>
DotNetCoreBuildServerShutdown();
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreAliases.DotNetCoreBuildServerShutdown(Cake.Core.ICakeContext,Cake.Common.Tools.DotNetCore.BuildServer.DotNetCoreBuildServerSettings)">
<summary>
Shuts down build servers that are started from dotnet.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCoreBuildServerSettings
{
MSBuild = true
};
DotNetCoreBuildServerShutdown(settings);
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.DotNetCoreRollForward">
<summary>
Contains the roll forward policy to be used.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.DotNetCoreRollForward.Minor">
<summary>
Roll forward to the lowest higher minor version, if requested minor version is missing.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.DotNetCoreRollForward.LatestPatch">
<summary>
Roll forward to the highest patch version. This disables minor version roll forward.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.DotNetCoreRollForward.Major">
<summary>
Roll forward to lowest higher major version, and lowest minor version, if requested major version is missing.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.DotNetCoreRollForward.LatestMinor">
<summary>
Roll forward to highest minor version, even if requested minor version is present.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.DotNetCoreRollForward.LatestMajor">
<summary>
Roll forward to highest major and highest minor version, even if requested major is present.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.DotNetCoreRollForward.Disable">
<summary>
Don't roll forward. Only bind to specified version.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.DotNetCoreSettings">
<summary>
Contains common settings used by <see cref="T:Cake.Common.Tools.DotNetCore.DotNetCoreTool`1" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.DotNetCoreSettings.Verbosity">
<summary>
Gets or sets the verbosity of logging to use.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.DotNetCoreSettings.DiagnosticOutput">
<summary>
Gets or sets a value indicating whether to not enable diagnostic output.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.DotNetCoreSettings.RollForward">
<summary>
Gets or sets the dotnet roll forward policy.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.DotNetCoreTool`1">
<summary>
Base class for all .NET Core related tools.
</summary>
<typeparam name="TSettings">The settings type.</typeparam>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreTool`1.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNetCore.DotNetCoreTool`1" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreTool`1.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreTool`1.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreTool`1.RunCommand(`0,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Runs the dotnet cli command using the specified settings and arguments.
</summary>
<param name="settings">The settings.</param>
<param name="arguments">The arguments.</param>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreTool`1.RunCommand(`0,Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.ProcessSettings)">
<summary>
Runs the dotnet cli command using the specified settings and arguments.
</summary>
<param name="settings">The settings.</param>
<param name="arguments">The arguments.</param>
<param name="processSettings">The processSettings.</param>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreTool`1.CreateArgumentBuilder(`0)">
<summary>
Creates a <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> and adds common commandline arguments.
</summary>
<param name="settings">The settings.</param>
<returns>Instance of <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.DotNetCoreTool`1.AppendCommonArguments(Cake.Core.IO.ProcessArgumentBuilder,`0)">
<summary>
Adds common commandline arguments.
</summary>
<param name="builder">Process argument builder to update.</param>
<param name="settings">The settings.</param>
<returns>Returns <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> updated with common commandline arguments.</returns>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.DotNetCoreVerbosity">
<summary>
Contains the verbosity of logging to use.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.DotNetCoreVerbosity.Quiet">
<summary>
Quiet level.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.DotNetCoreVerbosity.Minimal">
<summary>
Minimal level.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.DotNetCoreVerbosity.Normal">
<summary>
Normal level.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.DotNetCoreVerbosity.Detailed">
<summary>
Detailed level.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.DotNetCoreVerbosity.Diagnostic">
<summary>
Diagnostic level.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.Execute.DotNetCoreExecuteSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNetCore.Execute.DotNetCoreExecutor" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Execute.DotNetCoreExecuteSettings.FrameworkVersion">
<summary>
Gets or sets the version of the installed Shared Framework to use to run the application.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.Execute.DotNetCoreExecutor">
<summary>
.NET Core assembly executor.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.Execute.DotNetCoreExecutor.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNetCore.Execute.DotNetCoreExecutor" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.Execute.DotNetCoreExecutor.Execute(Cake.Core.IO.FilePath,Cake.Core.IO.ProcessArgumentBuilder,Cake.Common.Tools.DotNetCore.Execute.DotNetCoreExecuteSettings)">
<summary>
Execute an assembly using arguments and settings.
</summary>
<param name="assemblyPath">The assembly path.</param>
<param name="arguments">The arguments.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildBuilder">
<summary>
.NET Core project builder.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildBuilder.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildBuilder" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildBuilder.Build(System.String,Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings)">
<summary>
Build the project using the specified path and settings.
</summary>
<param name="projectOrDirectory">The target project path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildBuilder" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.DetailedSummary">
<summary>
Gets or sets a value indicating whether to show detailed information at the end of the build log about the configurations that were built and how they were scheduled to nodes.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.IgnoreProjectExtensions">
<summary>
Gets or sets extensions to ignore when determining which project file to build.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.MaxCpuCount">
<summary>
Gets or sets the maximum number of concurrent processes to use when building.
</summary>
<remarks>
If you don't include this switch, the default value is 1. If you specifying a value that is zero or less, MSBuild will use up to the number of processors in the computer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.ExcludeAutoResponseFiles">
<summary>
Gets or sets a value indicating whether to exclude any MSBuild.rsp files automatically.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.NoLogo">
<summary>
Gets or sets a value indicating whether to display the startup banner and the copyright message.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.Version">
<summary>
Gets or sets the default value of all the version numbers embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.VersionPrefix">
<summary>
Gets or sets the base version number embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.VersionSuffix">
<summary>
Gets or sets the pre-release label of the version number embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.FileVersion">
<summary>
Gets or sets the file version number embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.AssemblyVersion">
<summary>
Gets or sets the assembly version number embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.InformationalVersion">
<summary>
Gets or sets the assembly informational version number embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.PackageVersion">
<summary>
Gets or sets the version number of the NuGet package generated.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.PackageReleaseNotes">
<summary>
Gets or sets the release notes of the NuGet package generated.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.ContinuousIntegrationBuild">
<summary>
Gets or sets a value indicating whether to normalize stored file paths used when producing deterministic builds.
</summary>
<remarks>
For more information see https://devblogs.microsoft.com/dotnet/producing-packages-with-source-link/#deterministic-builds.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.Properties">
<summary>
Gets the project-level properties to set or override.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.Targets">
<summary>
Gets the targets to build in the project.
</summary>
<remarks>
If you specify any targets, they are run instead of any targets in the DefaultTargets attribute in the project file.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.ToolVersion">
<summary>
Gets or sets the version of the Toolset to use to build the project.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.ValidateProjectFile">
<summary>
Gets or sets a value indicating whether to validate the project file and, if validation succeeds, build the project.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.ResponseFiles">
<summary>
Gets the response files to use.
</summary>
<remarks>
A response file is a text file that is used to insert command-line switches. For more information see https://docs.microsoft.com/en-gb/visualstudio/msbuild/msbuild-response-files.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.DistributedFileLogger">
<summary>
Gets or sets a value indicating whether to log the build output of each MSBuild node to its own file.
</summary>
<remarks>
The initial location for these files is the current directory. By default, the files are named "MSBuildNodeId.log". You can use the /fileLoggerParameters switch to specify the location of the files and other parameters for the fileLogger.
If you name a log file by using the /fileLoggerParameters switch, the distributed logger will use that name as a template and append the node ID to that name when creating a log file for each node.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.DistributedLoggers">
<summary>
Gets the distributed loggers to use.
</summary>
<remarks>
A distributed logger consists of a central and forwarding logger. MSBuild will attach an instance of the forwarding logger to each secondary node.
For more information see https://msdn.microsoft.com/en-us/library/bb383987.aspx.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.ConsoleLoggerSettings">
<summary>
Gets or sets the parameters for the console logger.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.FileLoggers">
<summary>
Gets the file loggers to use.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.BinaryLogger">
<summary>
Gets or sets the binary logging options.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.Loggers">
<summary>
Gets the loggers to use to log events from MSBuild.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.DisableConsoleLogger">
<summary>
Gets or sets a value indicating whether to disable the default console logger, and not log events to the console.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.WarningCodesAsError">
<summary>
Gets the warning codes to treats as errors.
</summary>
<remarks>
When a warning is treated as an error the target will continue to execute as if it was a warning but the overall build will fail.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.TreatAllWarningsAs">
<summary>
Gets or sets a value indicating how all warnings should be treated.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.WarningCodesAsMessage">
<summary>
Gets the warning codes to treats as low importance messages.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions">
<summary>
Contains functionality related to .NET Core MSBuild settings.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.WithTarget(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,System.String)">
<summary>
Adds a MSBuild target to the configuration.
</summary>
<param name="settings">The settings.</param>
<param name="target">The MSBuild target.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
<remarks>Ignores a target if already added.</remarks>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.WithProperty(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,System.String,System.String[])">
<summary>
Adds a property to the configuration.
</summary>
<param name="settings">The settings.</param>
<param name="name">The property name.</param>
<param name="values">The property values.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.ShowDetailedSummary(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings)">
<summary>
Shows detailed information at the end of the build log about the configurations that were built and how they were scheduled to nodes.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.WithIgnoredProjectExtension(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,System.String)">
<summary>
Adds a extension to ignore when determining which project file to build.
</summary>
<param name="settings">The settings.</param>
<param name="extension">The extension to ignore.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.SetMaxCpuCount(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,System.Nullable{System.Int32})">
<summary>
Sets the maximum CPU count. Without this set MSBuild will compile projects in this solution one at a time.
</summary>
<param name="settings">The settings.</param>
<param name="maxCpuCount">The maximum CPU count. Set this value to zero to use as many MSBuild processes as available CPUs.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.ExcludeAutoResponseFiles(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings)">
<summary>
Exclude any MSBuild.rsp files automatically.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.HideLogo(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings)">
<summary>
Hide the startup banner and the copyright message.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.SetContinuousIntegrationBuild(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,System.Nullable{System.Boolean})">
<summary>
Sets a value indicating whether to normalize stored file paths used when producing deterministic builds.
</summary>
<remarks>
For more information see https://devblogs.microsoft.com/dotnet/producing-packages-with-source-link/#deterministic-builds.
</remarks>
<param name="settings">The settings.</param>
<param name="continuousIntegrationBuild">A value indicating whether to normalize stored file paths used when producing deterministic builds.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.UseToolVersion(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,Cake.Common.Tools.MSBuild.MSBuildVersion)">
<summary>
Sets the version of the Toolset to use to build the project.
</summary>
<param name="settings">The settings.</param>
<param name="version">The version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.ValidateProjectFile(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings)">
<summary>
Validate the project file and, if validation succeeds, build the project.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.WithResponseFile(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,Cake.Core.IO.FilePath)">
<summary>
Adds a response file to use.
</summary>
<param name="settings">The settings.</param>
<param name="responseFile">The response file to add.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
<remarks>
A response file is a text file that is used to insert command-line switches. For more information see https://docs.microsoft.com/en-gb/visualstudio/msbuild/msbuild-response-files.
</remarks>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.UseDistributedFileLogger(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings)">
<summary>
Log the build output of each MSBuild node to its own file.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.WithDistributedLogger(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,Cake.Common.Tools.DotNetCore.MSBuild.MSBuildDistributedLogger)">
<summary>
Adds a distributed loggers to use.
</summary>
<param name="settings">The settings.</param>
<param name="logger">The response file to add.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
<remarks>
A distributed logger consists of a central and forwarding logger. MSBuild will attach an instance of the forwarding logger to each secondary node.
For more information see https://msdn.microsoft.com/en-us/library/bb383987.aspx.
</remarks>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.SetConsoleLoggerSettings(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,Cake.Common.Tools.DotNetCore.MSBuild.MSBuildLoggerSettings)">
<summary>
Sets the parameters for the console logger.
</summary>
<param name="settings">The settings.</param>
<param name="consoleLoggerParameters">The console logger parameters to set.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.AddFileLogger(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings)">
<summary>
Adds a file logger with all the default settings.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
<remarks>
Each file logger will be declared in the order added.
The first file logger will match up to the /fl parameter.
The next nine (max) file loggers will match up to the /fl1 through /fl9 respectively.
</remarks>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.AddFileLogger(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,Cake.Common.Tools.DotNetCore.MSBuild.MSBuildFileLoggerSettings)">
<summary>
Adds a file logger.
</summary>
<param name="settings">The settings.</param>
<param name="fileLoggerParameters">Parameters to be passed to the logger.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
<remarks>
Each file logger will be declared in the order added.
The first file logger will match up to the /fl parameter.
The next nine (max) file loggers will match up to the /fl1 through /fl9 respectively.
</remarks>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.EnableBinaryLogger(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings)">
<summary>
Enables the binary logger with all the default settings.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.EnableBinaryLogger(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,Cake.Common.Tools.DotNetCore.MSBuild.MSBuildBinaryLoggerImports)">
<summary>
Enables the binary logger with the specified imports and default file name.
</summary>
<param name="settings">The settings.</param>
<param name="imports">The imports.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.EnableBinaryLogger(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,System.String)">
<summary>
Enables the binary logger with the specified log file name and no imports.
</summary>
<param name="settings">The settings.</param>
<param name="fileName">The log file name.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.EnableBinaryLogger(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,System.String,Cake.Common.Tools.DotNetCore.MSBuild.MSBuildBinaryLoggerImports)">
<summary>
Enables the binary logger with the specified log file name and imports.
</summary>
<param name="settings">The settings.</param>
<param name="fileName">The log file name.</param>
<param name="imports">The imports.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.WithLogger(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,System.String,System.String,System.String)">
<summary>
Adds a custom logger.
</summary>
<param name="settings">The settings.</param>
<param name="loggerAssembly">The assembly containing the logger. Should match the format {AssemblyName[,StrongName] | AssemblyFile}.</param>
<param name="loggerClass">The class implementing the logger. Should match the format [PartialOrFullNamespace.]LoggerClassName. If the assembly contains only one logger, class does not need to be specified.</param>
<param name="loggerParameters">Parameters to be passed to the logger.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.DisableConsoleLogger(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings)">
<summary>
Disables the default console logger, and not log events to the console.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.SetWarningCodeAsError(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,System.String)">
<summary>
Sets the warning code to treats as an error.
</summary>
<param name="settings">The settings.</param>
<param name="warningCode">The warning code to treat as an error.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
<remarks>
When a warning is treated as an error the target will continue to execute as if it was a warning but the overall build will fail.
</remarks>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.SetWarningCodeAsMessage(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,System.String)">
<summary>
Sets the warning code to treats as a message.
</summary>
<param name="settings">The settings.</param>
<param name="warningCode">The warning code to treat as a message.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.TreatAllWarningsAs(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,Cake.Common.Tools.DotNetCore.MSBuild.MSBuildTreatAllWarningsAs)">
<summary>
Sets how all warnings should be treated.
</summary>
<param name="settings">The settings.</param>
<param name="behaviour">How all warning should be treated.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.SetConfiguration(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,System.String)">
<summary>
Sets the configuration.
</summary>
<param name="settings">The settings.</param>
<param name="configuration">The configuration.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.SetVersion(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,System.String)">
<summary>
Sets the version.
</summary>
<param name="settings">The settings.</param>
<param name="version">The version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
<remarks>
Version will override VersionPrefix and VersionSuffix if set.
This may also override version settings during packaging.
</remarks>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.SetFileVersion(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,System.String)">
<summary>
Sets the file version.
</summary>
<param name="settings">The settings.</param>
<param name="fileVersion">The file version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.SetAssemblyVersion(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,System.String)">
<summary>
Sets the assembly version.
</summary>
<param name="settings">The settings.</param>
<param name="assemblyVersion">The assembly version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.SetInformationalVersion(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,System.String)">
<summary>
Sets the informational version.
</summary>
<param name="settings">The settings.</param>
<param name="informationalVersion">The informational version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.SetPackageVersion(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,System.String)">
<summary>
Sets the package version.
</summary>
<param name="settings">The settings.</param>
<param name="packageVersion">The package version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.SetPackageReleaseNotes(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,System.String)">
<summary>
Sets the package release notes.
</summary>
<param name="settings">The settings.</param>
<param name="packageReleaseNotes">The package release notes.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.SuppressVersionRecommendedFormatWarning(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings)">
<summary>
Suppress warning CS7035.
This is useful when using semantic versioning and either the file or informational version
doesn't match the recommended format.
The recommended format is: major.minor.build.revision where
each is an integer between 0 and 65534 (inclusive).
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.SetVersionPrefix(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,System.String)">
<summary>
Sets the version prefix.
</summary>
<param name="settings">The settings.</param>
<param name="versionPrefix">The version prefix.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.SetVersionSuffix(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,System.String)">
<summary>
Sets the version Suffix.
</summary>
<param name="settings">The settings.</param>
<param name="versionSuffix">The version prefix.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.SetTargetFramework(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,System.String)">
<summary>
Adds a framework to target.
</summary>
<param name="settings">The settings.</param>
<param name="targetFramework">The framework to target.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
<remarks>
For list of target frameworks see https://docs.microsoft.com/en-us/dotnet/standard/frameworks.
</remarks>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettingsExtensions.SetRuntime(Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,System.String)">
<summary>
Sets a target operating systems where the application or assembly will run.
</summary>
<param name="settings">The settings.</param>
<param name="runtimeId">The runtime id of the operating system.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
<remarks>
For list of runtime ids see https://docs.microsoft.com/en-us/dotnet/core/rid-catalog.
</remarks>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildArgumentBuilderExtensions">
<summary>
Contains functionality related to MSBuild arguments.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildArgumentBuilderExtensions.AppendMSBuildSettings(Cake.Core.IO.ProcessArgumentBuilder,Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings,Cake.Core.ICakeEnvironment)">
<summary>
Adds MSBuild arguments.
</summary>
<param name="builder">Argument builder.</param>
<param name="settings">MSBuild settings to add.</param>
<param name="environment">The environment.</param>
<exception cref="T:System.InvalidOperationException">Throws if 10 or more file loggers specified.</exception>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildBinaryLoggerImports">
<summary>
What files to include in the binary log.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildBinaryLoggerImports.Unspecified">
<summary>Don't specify imports</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildBinaryLoggerImports.None">
<summary>Do not collect project and imports files</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildBinaryLoggerImports.Embed">
<summary>Embed in the binlog file</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildBinaryLoggerImports.ZipFile">
<summary>Produce a separate .ProjectImports.zip</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildBinaryLoggerSettings">
<summary>
MSBuild binary logger settings used by <see cref="T:Cake.Common.Tools.DotNetCore.MSBuild.DotNetCoreMSBuildSettings"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildBinaryLoggerSettings.Enabled">
<summary>
Gets or sets a value indicating whether binary logging should be enabled.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildBinaryLoggerSettings.FileName">
<summary>
Gets or sets the output filename.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildBinaryLoggerSettings.Imports">
<summary>
Gets or sets what source files should be included in the log.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildConsoleColorType">
<summary>
Represents how the console color should behave in a console.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildConsoleColorType.Normal">
<summary>
Use the normal console color behaviour.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildConsoleColorType.Disabled">
<summary>
Use the default console color for all logging messages.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildConsoleColorType.ForceAnsi">
<summary>
Use ANSI console colors even if console does not support it
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildDistributedLogger">
<summary>
Represents the Distributed Logging Model with a central logger and forwarding logger.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildDistributedLogger.CentralLogger">
<summary>
Gets or sets the logger to use as the central logger.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildDistributedLogger.ForwardingLogger">
<summary>
Gets or sets the logger to use as the forwarding logger.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildFileLoggerSettings">
<summary>
Represents the settings for a file logger.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildFileLoggerSettings.LogFile">
<summary>
Gets or sets the path to the log file into which the build log is written.
</summary>
<remarks>
An empty string will use msbuild.log, in the current directory.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildFileLoggerSettings.AppendToLogFile">
<summary>
Gets or sets a value indicating whether the build log is appended to the log file or overwrites it.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildFileLoggerSettings.FileEncoding">
<summary>
Gets or sets the encoding for the file (for example, UTF-8, Unicode, or ASCII).
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildLoggerOutputLevel">
<summary>
Represents the logging output level for a MSBuild logger.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildLoggerOutputLevel.Default">
<summary>
Show the error and warning summary at the end.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildLoggerOutputLevel.WarningsOnly">
<summary>
Show only warnings summary at the end.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildLoggerOutputLevel.ErrorsOnly">
<summary>
Show only errors summary at the end.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildLoggerSettings">
<summary>
Represents the common settings for a logger.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildLoggerSettings.PerformanceSummary">
<summary>
Gets or sets a value indicating whether to show the time that’s spent in tasks, targets, and projects.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildLoggerSettings.NoSummary">
<summary>
Gets or sets a value indicating whether to hide the error and warning summary at the end.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildLoggerSettings.SummaryOutputLevel">
<summary>
Gets or sets value that indicates the level of summary output at the end for the logger.
</summary>
<remarks>Default is to show errors and summary.</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildLoggerSettings.HideItemAndPropertyList">
<summary>
Gets or sets a value indicating whether to hide the list of items and properties that would appear at the start of each project build if the verbosity level is set to diagnostic.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildLoggerSettings.ShowCommandLine">
<summary>
Gets or sets a value indicating whether to show TaskCommandLineEvent messages.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildLoggerSettings.ShowTimestamp">
<summary>
Gets or sets a value indicating whether to show the timestamp as a prefix to any message.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildLoggerSettings.ShowEventId">
<summary>
Gets or sets a value indicating whether to show the event Id for each started event, finished event, and message.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildLoggerSettings.ForceNoAlign">
<summary>
Gets or sets a value indicating whether to not align the text to the size of the console buffer.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildLoggerSettings.ConsoleColorType">
<summary>
Gets or sets value that indicates the type of console color to use for all logging messages.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildLoggerSettings.DisableMultiprocessorLogging">
<summary>
Gets or sets a value indicating whether to disable the multiprocessor logging style of output when running in non-multiprocessor mode.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildLoggerSettings.Verbosity">
<summary>
Gets or sets a value that overrides the /verbosity setting for this logger.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildTreatAllWarningsAs">
<summary>
Represents how all warnings should be treated as by MSBuild.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildTreatAllWarningsAs.Default">
<summary>
Use the default MSBuild behaviour.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildTreatAllWarningsAs.Message">
<summary>
Treat all warnings as low importance messages.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNetCore.MSBuild.MSBuildTreatAllWarningsAs.Error">
<summary>
Treat all warnings as errors.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.NuGet.Delete.DotNetCoreNuGetDeleter">
<summary>
.NET Core NuGet deleter. Deletes or unlists a package from the server.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.NuGet.Delete.DotNetCoreNuGetDeleter.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNetCore.NuGet.Delete.DotNetCoreNuGetDeleter" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.NuGet.Delete.DotNetCoreNuGetDeleter.Delete(System.String,System.String,Cake.Common.Tools.DotNetCore.NuGet.Delete.DotNetCoreNuGetDeleteSettings)">
<summary>
Delete the NuGet package using the specified name, version and settings.
</summary>
<param name="packageName">The name of the target package.</param>
<param name="version">Version of the package.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.NuGet.Delete.DotNetCoreNuGetDeleteSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNetCore.NuGet.Delete.DotNetCoreNuGetDeleter" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Delete.DotNetCoreNuGetDeleteSettings.Source">
<summary>
Gets or sets a value indicating the server URL.
</summary>
<remarks>
Supported URLs for nuget.org include http://www.nuget.org, http://www.nuget.org/api/v3,
and http://www.nuget.org/api/v2/package. For private feeds, substitute the host name
(for example, %hostname%/api/v3).
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Delete.DotNetCoreNuGetDeleteSettings.NoServiceEndpoint">
<summary>
Gets or sets a value indicating whether to append "api/v2/package" to the source URL.
</summary>
<remarks>
Available since .NET Core 2.1 SDK.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Delete.DotNetCoreNuGetDeleteSettings.Interactive">
<summary>
Gets or sets a value indicating whether to block and require manual action for operations like authentication.
</summary>
<remarks>
Available since .NET Core 2.2 SDK.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Delete.DotNetCoreNuGetDeleteSettings.NonInteractive">
<summary>
Gets or sets a value indicating whether to prompt for user input or confirmations.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Delete.DotNetCoreNuGetDeleteSettings.ApiKey">
<summary>
Gets or sets a value indicating the API key for the server.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Delete.DotNetCoreNuGetDeleteSettings.ForceEnglishOutput">
<summary>
Gets or sets a value indicating whether to force command-line output in English.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.NuGet.Push.DotNetCoreNuGetPusher">
<summary>
.NET Core nuget pusher. Pushes a package and its symbols to the server.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.NuGet.Push.DotNetCoreNuGetPusher.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNetCore.NuGet.Push.DotNetCoreNuGetPusher" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.NuGet.Push.DotNetCoreNuGetPusher.Push(System.String,Cake.Common.Tools.DotNetCore.NuGet.Push.DotNetCoreNuGetPushSettings)">
<summary>
Push one or more NuGet package using the specified name, version and settings.
</summary>
<param name="packageName">The name of the target package.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.NuGet.Push.DotNetCoreNuGetPushSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNetCore.NuGet.Push.DotNetCoreNuGetPusher" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Push.DotNetCoreNuGetPushSettings.Source">
<summary>
Gets or sets a value indicating the server URL.
</summary>
<remarks>
This option is required unless DefaultPushSource config value is set in the NuGet config file.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Push.DotNetCoreNuGetPushSettings.SymbolSource">
<summary>
Gets or sets a value indicating the symbol server URL.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Push.DotNetCoreNuGetPushSettings.NoServiceEndpoint">
<summary>
Gets or sets a value indicating whether to append "api/v2/package" to the source URL.
</summary>
<remarks>
Available since .NET Core 2.1 SDK.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Push.DotNetCoreNuGetPushSettings.Interactive">
<summary>
Gets or sets a value indicating whether to block and require manual action for operations like authentication.
</summary>
<remarks>
Available since .NET Core 2.2 SDK.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Push.DotNetCoreNuGetPushSettings.Timeout">
<summary>
Gets or sets a value indicating timeout for pushing to a server in seconds.
<remarks>
Defaults to 300 seconds (5 minutes). Specifying 0 (zero seconds) applies the default value.
</remarks>
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Push.DotNetCoreNuGetPushSettings.ApiKey">
<summary>
Gets or sets a value indicating the API key for the server.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Push.DotNetCoreNuGetPushSettings.SymbolApiKey">
<summary>
Gets or sets a value indicating the API key for the symbol server.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Push.DotNetCoreNuGetPushSettings.DisableBuffering">
<summary>
Gets or sets a value indicating whether buffering is disabled when pushing to an HTTP(S) server.
</summary>
<remarks>
This decreases memory usage.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Push.DotNetCoreNuGetPushSettings.IgnoreSymbols">
<summary>
Gets or sets a value indicating whether symbols should be not be pushed if present.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Push.DotNetCoreNuGetPushSettings.SkipDuplicate">
<summary>
Gets or sets a value indicating whether, when pushing multiple packages to an HTTP(S) server,
to treat any 409 Conflict response as a warning so that the push can continue.
</summary>
<remarks>
Available since .NET Core 3.1 SDK.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Push.DotNetCoreNuGetPushSettings.ForceEnglishOutput">
<summary>
Gets or sets a value indicating whether to force command-line output in English.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourcer">
<summary>
.NET Core NuGet sourcer.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourcer.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourcer" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourcer.AddSource(System.String,Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourceSettings)">
<summary>
Add the specified NuGet source.
</summary>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourcer.DisableSource(System.String,Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourceSettings)">
<summary>
Disable the specified NuGet source.
</summary>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourcer.EnableSource(System.String,Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourceSettings)">
<summary>
Enable the specified NuGet source.
</summary>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourcer.HasSource(System.String,Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourceSettings)">
<summary>
Determines whether the specified NuGet source exists.
</summary>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
<returns>Whether the specified NuGet source exists.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourcer.ListSource(System.String,Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourceSettings)">
<summary>
Lists the NuGet sources.
</summary>
<param name="format">The output format. Accepts two values: detailed (the default) and short.</param>
<param name="settings">The settings.</param>
<returns>The NuGet sources.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourcer.RemoveSource(System.String,Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourceSettings)">
<summary>
Remove the specified NuGet source.
</summary>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourcer.UpdateSource(System.String,Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourceSettings)">
<summary>
Update the specified NuGet source.
</summary>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourceSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourcer" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourceSettings.Source">
<summary>
Gets or sets the path to the package(s) source.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourceSettings.IsSensitiveSource">
<summary>
Gets or sets a value indicating whether this source contains sensitive data, i.e. authentication token in url.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourceSettings.UserName">
<summary>
Gets or sets the user name to be used when connecting to an authenticated source.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourceSettings.Password">
<summary>
Gets or sets the password to be used when connecting to an authenticated source.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourceSettings.StorePasswordInClearText">
<summary>
Gets or sets a value indicating whether to enable storing portable package source credentials by disabling password encryption.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourceSettings.ValidAuthenticationTypes">
<summary>
Gets or sets the comma-separated list of valid authentication types for this source.
</summary>
<remarks>
By default, all authentication types are valid. Example: basic,negotiate.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.NuGet.Source.DotNetCoreNuGetSourceSettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.Pack.DotNetCorePacker">
<summary>
.NET Core project packer.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.Pack.DotNetCorePacker.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNetCore.Pack.DotNetCorePacker" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.Pack.DotNetCorePacker.Pack(System.String,Cake.Common.Tools.DotNetCore.Pack.DotNetCorePackSettings)">
<summary>
Pack the project using the specified path and settings.
</summary>
<param name="project">The target file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.Pack.DotNetCorePackSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNetCore.Pack.DotNetCorePacker" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Pack.DotNetCorePackSettings.OutputDirectory">
<summary>
Gets or sets the output directory.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Pack.DotNetCorePackSettings.Configuration">
<summary>
Gets or sets the configuration under which to build.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Pack.DotNetCorePackSettings.VersionSuffix">
<summary>
Gets or sets the value that defines what `*` should be replaced with in version field in project.json.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Pack.DotNetCorePackSettings.NoBuild">
<summary>
Gets or sets a value indicating whether to not build project before packing.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Pack.DotNetCorePackSettings.NoDependencies">
<summary>
Gets or sets a value indicating whether to ignore project to project references and only build the root project.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Pack.DotNetCorePackSettings.NoRestore">
<summary>
Gets or sets a value indicating whether to not do implicit NuGet package restore.
This makes build faster, but requires restore to be done before build is executed.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Pack.DotNetCorePackSettings.NoLogo">
<summary>
Gets or sets a value indicating whether to display the startup banner or the copyright message.
</summary>
<remarks>
Available since .NET Core 3.0 SDK.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Pack.DotNetCorePackSettings.IncludeSymbols">
<summary>
Gets or sets a value indicating whether to generate the symbols package.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Pack.DotNetCorePackSettings.SymbolPackageFormat">
<summary>
Gets or sets the symbol package format.
</summary>
<value>The symbol package format.</value>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Pack.DotNetCorePackSettings.IncludeSource">
<summary>
Gets or sets a value indicating whether to includes the source files in the NuGet package.
The sources files are included in the src folder within the nupkg.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Pack.DotNetCorePackSettings.Serviceable">
<summary>
Gets or sets a value indicating whether to set the serviceable flag in the package.
</summary>
<remarks>
For more information, see https://aka.ms/nupkgservicing.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Pack.DotNetCorePackSettings.Runtime">
<summary>
Gets or sets the target runtime.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Pack.DotNetCorePackSettings.Sources">
<summary>
Gets or sets the specified NuGet package sources to use during the packing.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Pack.DotNetCorePackSettings.MSBuildSettings">
<summary>
Gets or sets additional arguments to be passed to MSBuild.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublisher">
<summary>
.NET Core project runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublisher.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublisher" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublisher.Publish(System.String,Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings)">
<summary>
Publish the project using the specified path and settings.
</summary>
<param name="path">The target file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublisher" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings.OutputDirectory">
<summary>
Gets or sets the output directory.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings.Runtime">
<summary>
Gets or sets the target runtime.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings.Framework">
<summary>
Gets or sets a specific framework to compile.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings.Configuration">
<summary>
Gets or sets the configuration under which to build.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings.VersionSuffix">
<summary>
Gets or sets the value that defines what `*` should be replaced with in version field in project.json.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings.NoBuild">
<summary>
Gets or sets a value indicating whether to not to build the project before publishing.
This makes build faster, but requires build to be done before publish is executed.
</summary>
<remarks>
Requires .NET Core 2.1 or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings.NoDependencies">
<summary>
Gets or sets a value indicating whether to ignore project to project references and only build the root project.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings.NoRestore">
<summary>
Gets or sets a value indicating whether to not do implicit NuGet package restore.
This makes build faster, but requires restore to be done before build is executed.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings.NoLogo">
<summary>
Gets or sets a value indicating whether to display the startup banner or the copyright message.
</summary>
<remarks>
Available since .NET Core 3.0 SDK.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings.Force">
<summary>
Gets or sets a value indicating whether to force all dependencies to be resolved even if the last restore was successful. This is equivalent to deleting project.assets.json.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings.SelfContained">
<summary>
Gets or sets a value indicating whether Publish the .NET Core runtime with your application so the runtime doesn't need to be installed on the target machine. Defaults to 'true' if a runtime identifier is specified.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings.PublishSingleFile">
<summary>
Gets or sets a value indicating whether to package your app into a platform-specific single-file executable.
</summary>
<remarks>
Requires .NET Core 3.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings.PublishTrimmed">
<summary>
Gets or sets a value indicating whether to reduce the size of apps by analyzing IL and trimming unused assemblies.
</summary>
<remarks>
Requires .NET Core 3.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings.TieredCompilationQuickJit">
<summary>
Gets or sets a value as to whether tiered compilation quick JIT is enabled.
</summary>
<remarks>
Requires .NET Core 3.x or newer. Tiered compilation is enabled by default in .NET Core 3.
<para>Code generated by Quick JIT may run slower, allocate more memory, or use more stack space.</para>
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings.TieredCompilation">
<summary>
Gets or sets a value indicating whether tiered compilation is enabled.
</summary>
<remarks>
Requires .NET Core 3.x or newer. Tiered compilation is enabled by default in .NET Core 3.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings.PublishReadyToRun">
<summary>
Gets or sets a value indicating whether to compile your application assemblies as ReadyToRun (R2R) format.
</summary>
<remarks>
Requires .NET Core 3.x or newer. Tiered compilation is enabled by default in .NET Core 3.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings.PublishReadyToRunShowWarnings">
<summary>
Gets or sets a value indicating whether to show warnings emitted by ReadyToRun (R2R) compilation.
</summary>
<remarks>
Requires .NET Core 3.x or newer. Tiered compilation is enabled by default in .NET Core 3.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings.IncludeNativeLibrariesForSelfExtract">
<summary>
Gets or sets a value indicating whether to bundle native libraries when publishing a platform-specific single-file executable.
</summary>
<remarks>
Requires .NET 5 or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings.IncludeAllContentForSelfExtract">
<summary>
Gets or sets a value indicating whether to bundle all content when publishing a platform-specific single-file executable.
This will extract all files before running the executable and preserves the original .NET Core single-file deployment behavior.
</summary>
<remarks>
Requires .NET 5 or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings.Sources">
<summary>
Gets or sets the specified NuGet package sources to use during the restore.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Publish.DotNetCorePublishSettings.MSBuildSettings">
<summary>
Gets or sets additional arguments to be passed to MSBuild.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestorer">
<summary>
.NET Core project restorer.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestorer.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestorer" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="log">The cake log.</param>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestorer.Restore(System.String,Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestoreSettings)">
<summary>
Restore the project using the specified path and settings.
</summary>
<param name="root">List of projects and project folders to restore. Each value can be: a path to a project.json or global.json file, or a folder to recursively search for project.json files.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestoreSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestoreSettings" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestoreSettings.Sources">
<summary>
Gets or sets the specified NuGet package sources to use during the restore.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestoreSettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file to use.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestoreSettings.PackagesDirectory">
<summary>
Gets or sets the directory to install packages in.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestoreSettings.NoCache">
<summary>
Gets or sets a value indicating whether to do not cache packages and http requests.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestoreSettings.DisableParallel">
<summary>
Gets or sets a value indicating whether to disable restoring multiple projects in parallel.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestoreSettings.IgnoreFailedSources">
<summary>
Gets or sets a value indicating whether to only warning failed sources if there are packages meeting version requirement.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestoreSettings.Runtime">
<summary>
Gets or sets the target runtime to restore packages for.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestoreSettings.NoDependencies">
<summary>
Gets or sets a value indicating whether to ignore project to project references and restore only the root project.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestoreSettings.Force">
<summary>
Gets or sets a value indicating whether to force all dependencies to be resolved even if the last restore was successful.
This is equivalent to deleting the project.assets.json file.
Note: This flag was introduced with the .NET Core 2.x release.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestoreSettings.Interactive">
<summary>
Gets or sets a value indicating whether to stop and wait for user input or action (for example to complete authentication).
</summary>
<remarks>
Supported by .NET SDK version 2.1.400 and above.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestoreSettings.UseLockFile">
<summary>
Gets or sets a value indicating whether to enable project lock file to be generated and used with restore.
</summary>
<remarks>
Supported by .NET SDK version 2.1.500 and above.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestoreSettings.LockedMode">
<summary>
Gets or sets a value indicating whether to not allow updating project lock file.
</summary>
<remarks>
When set to true, restore will fail if the lock file is out of sync.
Useful for CI builds when you do not want the build to continue if the package closure has changed than what is present in the lock file.
<para>
Supported by .NET SDK version 2.1.500 and above.
</para>
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestoreSettings.LockFilePath">
<summary>
Gets or sets a value indicating output location where project lock file is written.
</summary>
<remarks>
If not set, 'dotnet restore' defaults to 'PROJECT_ROOT\packages.lock.json'.
<para>
Supported by .NET SDK version 2.1.500 and above.
</para>
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestoreSettings.ForceEvaluate">
<summary>
Gets or sets a value indicating whether to force restore to reevaluate all dependencies even if a lock file already exists.
</summary>
<remarks>
Supported by .NET SDK version 2.1.500 and above.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Restore.DotNetCoreRestoreSettings.MSBuildSettings">
<summary>
Gets or sets additional arguments to be passed to MSBuild.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.Run.DotNetCoreRunner">
<summary>
.NET Core project runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.Run.DotNetCoreRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNetCore.Run.DotNetCoreRunner" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.Run.DotNetCoreRunner.Run(System.String,Cake.Core.IO.ProcessArgumentBuilder,Cake.Common.Tools.DotNetCore.Run.DotNetCoreRunSettings)">
<summary>
Runs the project using the specified path with arguments and settings.
</summary>
<param name="project">The target project path.</param>
<param name="arguments">The arguments.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.Run.DotNetCoreRunSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNetCore.Run.DotNetCoreRunner" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Run.DotNetCoreRunSettings.Framework">
<summary>
Gets or sets a specific framework to compile.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Run.DotNetCoreRunSettings.Configuration">
<summary>
Gets or sets the configuration under which to build.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Run.DotNetCoreRunSettings.NoRestore">
<summary>
Gets or sets a value indicating whether to not do implicit NuGet package restore.
This makes run faster, but requires restore to be done before run is executed.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Run.DotNetCoreRunSettings.NoBuild">
<summary>
Gets or sets a value indicating whether to not do implicit build.
This makes run faster, but requires build to be done before run is executed.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Run.DotNetCoreRunSettings.Sources">
<summary>
Gets or sets the specified NuGet package sources to use during the run is executed.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Run.DotNetCoreRunSettings.Runtime">
<summary>
Gets or sets the target runtime.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTester">
<summary>
.NET Core project tester.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTester.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTester" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTester.Test(System.String,Cake.Core.IO.ProcessArgumentBuilder,Cake.Common.Tools.DotNetCore.Test.DotNetCoreTestSettings)">
<summary>
Tests the project using the specified path with arguments and settings.
</summary>
<param name="project">The target project path.</param>
<param name="arguments">The arguments.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTestSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTester" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTestSettings.Settings">
<summary>
Gets or sets the settings file to use when running tests.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTestSettings.Filter">
<summary>
Gets or sets the filter expression to filter out tests in the current project.
</summary>
<remarks>
For more information on filtering support, see https://aka.ms/vstest-filtering.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTestSettings.TestAdapterPath">
<summary>
Gets or sets the path to use for the custom test adapter in the test run.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTestSettings.Logger">
<summary>
Gets or sets a logger for test results.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTestSettings.Loggers">
<summary>
Gets or sets the loggers for test results.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTestSettings.OutputDirectory">
<summary>
Gets or sets the output directory.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTestSettings.Configuration">
<summary>
Gets or sets the configuration under which to build.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTestSettings.Collectors">
<summary>
Gets or sets the data collectors for the test run.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTestSettings.Framework">
<summary>
Gets or sets specific framework to compile.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTestSettings.NoBuild">
<summary>
Gets or sets a value indicating whether to not build the project before testing.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTestSettings.NoRestore">
<summary>
Gets or sets a value indicating whether to not do implicit NuGet package restore.
This makes build faster, but requires restore to be done before build is executed.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTestSettings.NoLogo">
<summary>
Gets or sets a value indicating whether to run tests without displaying the Microsoft TestPlatform banner.
</summary>
<remarks>
Available since .NET Core 3.0 SDK.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTestSettings.DiagnosticFile">
<summary>
Gets or sets a file to write diagnostic messages to.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTestSettings.ResultsDirectory">
<summary>
Gets or sets the results directory. This setting is only available from 2.0.0 upward.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTestSettings.VSTestReportPath">
<summary>
Gets or sets the file path to write VSTest reports to.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTestSettings.Runtime">
<summary>
Gets or sets the target runtime to test for. This setting is only available from .NET Core 3.x upward.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTestSettings.Blame">
<summary>
Gets or sets a value indicating whether to run the tests in blame mode. This option is helpful in isolating a problematic test causing the test host to crash.
Outputs a 'Sequence.xml' file in the current directory that captures the order of execution of test before the crash.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.Test.DotNetCoreTestSettings.Sources">
<summary>
Gets or sets the specified NuGet package sources to use during testing.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.Tool.DotNetCoreToolRunner">
<summary>
.NET Core Extensibility Commands Runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.Tool.DotNetCoreToolRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNetCore.Tool.DotNetCoreToolRunner" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.Tool.DotNetCoreToolRunner.Execute(Cake.Core.IO.FilePath,System.String,Cake.Core.IO.ProcessArgumentBuilder,Cake.Common.Tools.DotNetCore.Tool.DotNetCoreToolSettings)">
<summary>
Execute an assembly using arguments and settings.
</summary>
<param name="projectPath">The target project path.</param>
<param name="command">The command to execute.</param>
<param name="arguments">The arguments.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.Tool.DotNetCoreToolSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNetCore.Tool.DotNetCoreToolRunner" />.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTester">
<summary>
.NET Core VSTest tester.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTester.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTester" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTester.Test(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTestSettings)">
<summary>
Tests the project using the specified path with arguments and settings.
</summary>
<param name="testFiles">A list of test files to run.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTestSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTester" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTestSettings.Settings">
<summary>
Gets or sets the settings file to use when running tests.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTestSettings.TestsToRun">
<summary>
Gets or sets the a list tests to run.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTestSettings.TestAdapterPath">
<summary>
Gets or sets the path to use for the custom test adapter in the test run.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTestSettings.Platform">
<summary>
Gets or sets the target platform architecture to be used for test execution.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTestSettings.Framework">
<summary>
Gets or sets specific .Net Framework version to be used for test execution.
</summary>
<remarks>
Valid values are ".NETFramework,Version=v4.6", ".NETCoreApp,Version=v1.0" etc.
Other supported values are Framework35, Framework40, Framework45 and FrameworkCore10.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTestSettings.Parallel">
<summary>
Gets or sets a value indicating whether the tests should be executed in parallel.
</summary>
<remarks>
By default up to all available cores on the machine may be used. The number of cores to use may be configured using a settings file.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTestSettings.TestCaseFilter">
<summary>
Gets or sets the filter expression to run test that match.
</summary>
<remarks>
For more information on filtering support, see https://aka.ms/vstest-filtering.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTestSettings.Logger">
<summary>
Gets or sets a logger for test results.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTestSettings.ParentProcessId">
<summary>
Gets or sets the Process Id of the Parent Process responsible for launching current process.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTestSettings.Port">
<summary>
Gets or sets the Port for socket connection and receiving the event messages.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTestSettings.DiagnosticFile">
<summary>
Gets or sets a file to write diagnostic messages to.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTestSettings.ResultsDirectory">
<summary>
Gets or sets the path to put the test results in.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTestSettings.Arguments">
<summary>
Gets or sets a list of extra arguments that should be passed to adapter.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTestSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNetCore.VSTest.DotNetCoreVSTestSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.DupFinder.DupFinderAliases">
<summary>
<para>Contains functionality related to ReSharper's <see href="https://www.jetbrains.com/help/resharper/2016.1/dupFinder.html">dupFinder</see> tool.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.DupFinder.DupFinderSettings" /> class:
<code>
#tool "nuget:?package=JetBrains.ReSharper.CommandLineTools"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderAliases.DupFinder(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Analyses the specified file with ReSharper's DupFinder.
The file can either be a solution/project or a source file.
</summary>
<param name="context">The context.</param>
<param name="file">The file to analyze.</param>
<example>
<code>
DupFinder("./src/MySolution.sln");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderAliases.DupFinder(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.DupFinder.DupFinderSettings)">
<summary>
Analyses the specified file with ReSharper's DupFinder using the specified settings.
The file can either be a solution/project or a source file.
</summary>
<param name="context">The context.</param>
<param name="file">The file to analyze.</param>
<param name="settings">The settings.</param>
<example>
<code>
var buildOutputDirectory = Directory("./.build");
var resharperReportsDirectory = buildOutputDirectory + Directory("_ReSharperReports");
var rootDirectoryPath = MakeAbsolute(Context.Environment.WorkingDirectory);
DupFinder("./src/MySolution.sln", new DupFinderSettings {
ShowStats = true,
ShowText = true,
ExcludePattern = new String[]
{
rootDirectoryPath + "/**/*Designer.cs",
},
OutputFile = resharperReportsDirectory + File("dupfinder-output.xml"),
ThrowExceptionOnFindingDuplicates = true
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderAliases.DupFinder(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Analyses the specified projects with ReSharper's DupFinder.
The files can either be solutions and projects or a source files.
</summary>
<param name="context">The context.</param>
<param name="files">The files to analyze.</param>
<example>
<code>
var projects = GetFiles("./src/**/*.csproj");
DupFinder(projects);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderAliases.DupFinder(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.DupFinder.DupFinderSettings)">
<summary>
Analyses the specified projects with ReSharper's DupFinder using the specified settings.
The files can either be solutions and projects or a source files.
</summary>
<param name="context">The context.</param>
<param name="files">The files to analyze.</param>
<param name="settings">The settings.</param>
<example>
<code>
var buildOutputDirectory = Directory("./.build");
var resharperReportsDirectory = buildOutputDirectory + Directory("_ReSharperReports");
var rootDirectoryPath = MakeAbsolute(Context.Environment.WorkingDirectory);
var projects = GetFiles("./src/**/*.csproj");
DupFinder(projects, new DupFinderSettings {
ShowStats = true,
ShowText = true,
ExcludePattern = new String[]
{
rootDirectoryPath + "/**/*Designer.cs",
},
OutputFile = resharperReportsDirectory + File("dupfinder-output.xml"),
ThrowExceptionOnFindingDuplicates = true
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderAliases.DupFinder(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Analyses all files matching the specified pattern with ReSharper's DupFinder.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<example>
<code>
DupFinder("*.cs");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderAliases.DupFinder(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.DupFinder.DupFinderSettings)">
<summary>
Analyses all files matching the specified pattern with ReSharper's DupFinder,
using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="settings">The settings.</param>
<example>
<code>
var buildOutputDirectory = Directory("./.build");
var resharperReportsDirectory = buildOutputDirectory + Directory("_ReSharperReports");
DupFinder("*.cs", new DupFinderSettings {
OutputFile = resharperReportsDirectory + File("dupfinder-output.xml"),
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderAliases.DupFinderFromConfig(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Runs ReSharper's DupFinder using the provided config file.
</summary>
<param name="context">The context.</param>
<param name="configFile">The config file.</param>
<example>
<code>
DupFinderFromConfig("./src/dupfinder.config");
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.DupFinder.DupFinderRunner">
<summary>
DupFinder runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DupFinder.DupFinderRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="log">The logger.</param>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderRunner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.DupFinder.DupFinderSettings)">
<summary>
Analyses the specified files using the specified settings.
</summary>
<param name="filePaths">The file paths.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderRunner.RunFromConfig(Cake.Core.IO.FilePath)">
<summary>
Runs ReSharper's DupFinder using the provided config file.
</summary>
<param name="configFile">The config file.</param>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.DupFinder.DupFinderSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DupFinder.DupFinderRunner"/> .
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.Debug">
<summary>
Gets or sets a value indicating whether the debug output should be enabled.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.DiscardCost">
<summary>
Gets or sets the complexity threshold for duplicate fragments.
Code fragment with lower complexity are discarded.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.DiscardFieldsName">
<summary>
Gets or sets a value indicating whether to discard similar fields with different names.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.DiscardLiterals">
<summary>
Gets or sets a value indicating whether to discard similar lines of code with different literals.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.DiscardLocalVariablesName">
<summary>
Gets or sets a value indicating whether to discard similar local variables with different names.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.DiscardTypes">
<summary>
Gets or sets a value indicating whether to discard similar types with different names.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.IdlePriority">
<summary>
Gets or sets a value indicating whether the process priority should be set to idle.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.ExcludeFilesByStartingCommentSubstring">
<summary>
Gets or sets a list of keywords to exclude files that contain one of the keywords in their opening comments.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.ExcludeCodeRegionsByNameSubstring">
<summary>
Gets or sets a list of keywords to exclude regions that contain one of the keywords in their message.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.ExcludePattern">
<summary>
Gets or sets a lift of patterns which will be excluded from the analysis.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.MsBuildProperties">
<summary>
Gets or sets MsBuild properties.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.NormalizeTypes">
<summary>
Gets or sets a value indicating whether to normalize type names to the last subtype.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.CachesHome">
<summary>
Gets or sets the directory where caches will be stored.
The default is %TEMP%.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.OutputFile">
<summary>
Gets or sets the location DupFinder should write its output.
</summary>
<value>The location DupFinder should write its output.</value>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.ShowStats">
<summary>
Gets or sets a value indicating whether to show CPU and memory usage statistics.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.ShowText">
<summary>
Gets or sets a value indicating whether to show duplicates text in the report.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.ThrowExceptionOnFindingDuplicates">
<summary>
Gets or sets a value indicating whether to throw an exception on finding duplicates.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.SkipOutputAnalysis">
<summary>
Gets or sets a value indicating whether to skip analysis of the file
that was output by the command line tool or not.
</summary>
</member>
<member name="T:Cake.Common.Tools.Fixie.FixieAliases">
<summary>
<para>Contains functionality related to running <see href="https://github.com/fixie/fixie">Fixie</see> tests.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.Fixie.FixieSettings" /> class:
<code>
#tool "nuget:?package=Fixie"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.Fixie.FixieAliases.Fixie(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Runs all Fixie tests in the assemblies matching the specified pattern.
</summary>
<example>
<code>
Fixie("./src/UnitTests/*.dll");
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
</member>
<member name="M:Cake.Common.Tools.Fixie.FixieAliases.Fixie(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.Fixie.FixieSettings)">
<summary>
Runs all Fixie tests in the assemblies matching the specified pattern,
using the specified settings.
</summary>
<example>
<code>
Fixie("./src/UnitTests/*.dll", new FixieSettings {
NUnitXml = TestResult.xml
});
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.Fixie.FixieAliases.Fixie(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Runs all Fixie tests in the specified assemblies.
</summary>
<example>
<code>
var assemblies = new [] {
"UnitTests1.dll",
"UnitTests2.dll"
};
Fixie(assemblies);
</code>
</example>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
</member>
<member name="M:Cake.Common.Tools.Fixie.FixieAliases.Fixie(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Runs all Fixie tests in the specified assemblies.
</summary>
<example>
<code>
var assemblies = GetFiles("./src/UnitTests/*.dll");
Fixie(assemblies);
</code>
</example>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
</member>
<member name="M:Cake.Common.Tools.Fixie.FixieAliases.Fixie(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Tools.Fixie.FixieSettings)">
<summary>
Runs all Fixie tests in the specified assemblies,
using the specified settings.
</summary>
<example>
<code>
var assemblies = new [] {
"UnitTests1.dll",
"UnitTests2.dll"
};
Fixie(assemblies, new FixieSettings {
NUnitXml = TestResult.xml
});
</code>
</example>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.Fixie.FixieAliases.Fixie(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.Fixie.FixieSettings)">
<summary>
Runs all Fixie tests in the specified assemblies,
using the specified settings.
</summary>
<example>
<code>
var assemblies = GetFiles("./src/UnitTests/*.dll");
Fixie(assemblies, new FixieSettings {
NUnitXml = TestResult.xml
});
</code>
</example>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Fixie.FixieRunner">
<summary>
The Fixie test runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.Fixie.FixieRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Fixie.FixieRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The globber.</param>
</member>
<member name="M:Cake.Common.Tools.Fixie.FixieRunner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.Fixie.FixieSettings)">
<summary>
Runs the tests in the specified assemblies, using the specified settings.
</summary>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.Fixie.FixieRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.Fixie.FixieRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.Fixie.FixieSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Fixie.FixieRunner" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.Fixie.FixieSettings.NUnitXml">
<summary>
Gets or sets the file to be used to output NUnit style of XML results.
</summary>
<value>
The name of the file to write NUnit style of results.
</value>
</member>
<member name="P:Cake.Common.Tools.Fixie.FixieSettings.XUnitXml">
<summary>
Gets or sets the file to be used to output xUnit style of XML results.
</summary>
<value>
The name of the file to write xUnit style of results.
</value>
</member>
<member name="P:Cake.Common.Tools.Fixie.FixieSettings.TeamCity">
<summary>
Gets or sets the the option to force TeamCity-formatted output on or off.
</summary>
<value>
The value of TeamCity-formatted output. Either "on" or "off".
</value>
</member>
<member name="P:Cake.Common.Tools.Fixie.FixieSettings.Options">
<summary>
Gets the collection of Options as KeyValuePairs.
</summary>
<value>
The collection of keys and values.
</value>
</member>
<member name="T:Cake.Common.Tools.Fixie.FixieSettingsExtensions">
<summary>
Contains functionality related to Fixie settings.
</summary>
</member>
<member name="M:Cake.Common.Tools.Fixie.FixieSettingsExtensions.WithOption(Cake.Common.Tools.Fixie.FixieSettings,System.String,System.String[])">
<summary>
Adds an option to the settings.
</summary>
<param name="settings">The settings.</param>
<param name="name">The option name.</param>
<param name="values">The option values.</param>
<returns>The same <see cref="T:Cake.Common.Tools.Fixie.FixieSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Common.Tools.GitLink.GitLink3Aliases">
<summary>
<para>Contains functionality related to <see href="https://github.com/gittools/gitlink">GitLink</see> version 3.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.GitLink.GitLink3Settings" /> class:
<code>
#tool "nuget:?package=gitlink"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLink3Aliases.GitLink3(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Update the pdb file to link all sources.
This will allow anyone to step through the source code while debugging without a symbol source server.
</summary>
<param name="context">The context.</param>
<param name="pdbFilePath">The PDB File to analyze.</param>
<example>
<code>
GitLink3("C:/temp/solution/bin/my.pdb");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLink3Aliases.GitLink3(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.GitLink.GitLink3Settings)">
<summary>
Update the pdb file to link all sources.
This will allow anyone to step through the source code while debugging without a symbol source server.
</summary>
<param name="context">The context.</param>
<param name="pdbFilePath">The PDB File to analyze.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitLink3("C:/temp/solution/bin/my.pdb", new GitLink3Settings {
RepositoryUrl = "http://mydomain.com",
ShaHash = "abcdef"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLink3Aliases.GitLink3(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Update the pdb files to link all sources.
This will allow anyone to step through the source code while debugging without a symbol source server.
</summary>
<param name="context">The context.</param>
<param name="pdbFiles">The PDB File collection to analyze.</param>
<example>
<code>
GitLink3("C:/temp/solution/bin/**/*.pdb");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLink3Aliases.GitLink3(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.GitLink.GitLink3Settings)">
<summary>
Update the pdb files to link all sources.
This will allow anyone to step through the source code while debugging without a symbol source server.
</summary>
<param name="context">The context.</param>
<param name="pdbFiles">The PDB File collection to analyze.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitLink3("C:/temp/solution/bin/**/*.pdb", new GitLink3Settings {
RepositoryUrl = "http://mydomain.com",
ShaHash = "abcdef"
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.GitLink.GitLink3Runner">
<summary>
GitLink runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLink3Runner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitLink.GitLink3Runner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLink3Runner.Run(Cake.Core.IO.FilePath,Cake.Common.Tools.GitLink.GitLink3Settings)">
<summary>
Update pdb file to link all sources.
</summary>
<param name="pdbFile">The path to the pdb file to link.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLink3Runner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.GitLink.GitLink3Settings)">
<summary>
Update pdb files to link all sources.
</summary>
<param name="pdbFiles">The file path collection for the pdb files to link.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLink3Runner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLink3Runner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.GitLink.GitLink3Settings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitLink.GitLink3Runner"/> .
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLink3Settings.RepositoryUrl">
<summary>
Gets or sets the Url to remote Git repository.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLink3Settings.ShaHash">
<summary>
Gets or sets the SHA-1 hash of the Git commit to be used.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLink3Settings.BaseDir">
<summary>
Gets or sets the path to the root of the Git repository.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLink3Settings.UsePowerShell">
<summary>
Gets or sets a value indicating whether the Use PowerShell Command option should be enabled.
This option will use PowerShell instead of HTTP in SRCSRV to retrieve the source code.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLink3Settings.SkipVerify">
<summary>
Gets or sets a value indicating whether the Skip Verify option should be enabled.
This option indicates whether verification of all source files are available in source control.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitLink.GitLinkAliases">
<summary>
<para>Contains functionality related to <see href="https://github.com/gittools/gitlink">GitLink</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.GitLink.GitLinkSettings" /> class:
<code>
#tool "nuget:?package=gitlink&version=2.4.0"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLinkAliases.GitLink(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath)">
<summary>
Update pdb files to link all sources.
This will allow anyone to step through the source code while debugging without a symbol source server.
</summary>
<param name="context">The context.</param>
<param name="repositoryRootPath">The Solution File to analyze.</param>
<example>
<code>
GitLink("C:/temp/solution");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLinkAliases.GitLink(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Common.Tools.GitLink.GitLinkSettings)">
<summary>
Update pdb files to link all sources, using specified settings.
This will allow anyone to step through the source code while debugging without a symbol source server.
</summary>
<param name="context">The context.</param>
<param name="repositoryRootPath">The path to the Root of the Repository to analyze.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitLink("C:/temp/solution", new GitLinkSettings {
RepositoryUrl = "http://mydomain.com",
Branch = "master",
ShaHash = "abcdef",
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.GitLink.GitLinkRunner">
<summary>
GitLink runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLinkRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitLink.GitLinkRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLinkRunner.Run(Cake.Core.IO.DirectoryPath,Cake.Common.Tools.GitLink.GitLinkSettings)">
<summary>
Update pdb files to link all sources.
</summary>
<param name="repositoryRootPath">The path to the Root of the Repository to analyze.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLinkRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLinkRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.GitLink.GitLinkSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitLink.GitLinkRunner"/> .
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.RepositoryUrl">
<summary>
Gets or sets the Url to remote Git repository.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.SolutionFileName">
<summary>
Gets or sets the Solution file name.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.Configuration">
<summary>
Gets or sets the name of the configuration.
</summary>
<remarks>Default is Release.</remarks>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.Platform">
<summary>
Gets or sets the name of the platform.
</summary>
<remarks>Default is AnyCPU.</remarks>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.Branch">
<summary>
Gets or sets the name of the branch to use on the remote repository.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.LogFilePath">
<summary>
Gets or sets the path to the GitLink log file.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.ShaHash">
<summary>
Gets or sets the SHA-1 hash of the Git commit to be used.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.PdbDirectoryPath">
<summary>
Gets or sets the directory where the PDB files are located.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.UsePowerShell">
<summary>
Gets or sets a value indicating whether the Use PowerShell Command option should be enabled.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.ErrorsAsWarnings">
<summary>
Gets or sets a value indicating whether the ErrorsAsWarnings option should be enabled.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.SkipVerify">
<summary>
Gets or sets a value indicating whether the Skip Verify option should be enabled.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.IsDebug">
<summary>
Gets or sets a value indicating whether the debug output should be enabled.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.AddAssets.GitReleaseManagerAddAssetsSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitReleaseManager.AddAssets.GitReleaseManagerAssetsAdder"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.AddAssets.GitReleaseManagerAssetsAdder">
<summary>
The GitReleaseManager Asset Adder used to add assets to a release.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.AddAssets.GitReleaseManagerAssetsAdder.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitReleaseManager.AddAssets.GitReleaseManagerAssetsAdder"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.AddAssets.GitReleaseManagerAssetsAdder.AddAssets(System.String,System.String,System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.AddAssets.GitReleaseManagerAddAssetsSettings)">
<summary>
Creates a Release using the specified and settings.
</summary>
<param name="userName">The user name.</param>
<param name="password">The password.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="tagName">The tag name.</param>
<param name="assets">The assets to upload.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.AddAssets.GitReleaseManagerAssetsAdder.AddAssets(System.String,System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.AddAssets.GitReleaseManagerAddAssetsSettings)">
<summary>
Creates a Release using the specified and settings.
</summary>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="tagName">The tag name.</param>
<param name="assets">The assets to upload.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Close.GitReleaseManagerCloseMilestoneSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitReleaseManager.Close.GitReleaseManagerMilestoneCloser"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Close.GitReleaseManagerMilestoneCloser">
<summary>
The GitReleaseManager Milestone Closer used to close milestones.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Close.GitReleaseManagerMilestoneCloser.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitReleaseManager.Close.GitReleaseManagerMilestoneCloser"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Close.GitReleaseManagerMilestoneCloser.Close(System.String,System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Close.GitReleaseManagerCloseMilestoneSettings)">
<summary>
Closes a milestone using the specified settings.
</summary>
<param name="userName">The user name.</param>
<param name="password">The password.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="milestone">The milestone.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Close.GitReleaseManagerMilestoneCloser.Close(System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Close.GitReleaseManagerCloseMilestoneSettings)">
<summary>
Closes a milestone using the specified settings.
</summary>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="milestone">The milestone.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreateSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreator"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreateSettings.Milestone">
<summary>
Gets or sets the milestone to be used when creating the release.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreateSettings.Name">
<summary>
Gets or sets the name to be used when creating the release.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreateSettings.InputFilePath">
<summary>
Gets or sets the location of a set of Release Notes to be used when creating the release.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreateSettings.Prerelease">
<summary>
Gets or sets a value indicating whether or not to create the release as a pre-release.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreateSettings.Assets">
<summary>
Gets or sets the Path(s) to the file(s) to include in the release.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreateSettings.TargetCommitish">
<summary>
Gets or sets the commit to tag. Can be a branch or SHA. Defaults to repository's default branch.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreator">
<summary>
The GitReleaseManager Release Creator used to create releases.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreator.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreator"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreator.Create(System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreateSettings)">
<summary>
Creates a Release using the specified settings.
</summary>
<param name="userName">The user name.</param>
<param name="password">The password.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreator.Create(System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreateSettings)">
<summary>
Creates a Release using the specified settings.
</summary>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Discard.GitReleaseManagerDiscarder">
<summary>
The GitReleaseManager Release Discarder used to discard releases.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Discard.GitReleaseManagerDiscarder.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitReleaseManager.Discard.GitReleaseManagerDiscarder"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Discard.GitReleaseManagerDiscarder.Discard(System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Discard.GitReleaseManagerDiscardSettings)">
<summary>
Discards a Release using the specified settings.
</summary>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="milestone">The milestone.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Discard.GitReleaseManagerDiscardSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitReleaseManager.Discard.GitReleaseManagerDiscarder"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Export.GitReleaseManagerExporter">
<summary>
The GitReleaseManager Release Publisher used to publish releases.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Export.GitReleaseManagerExporter.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitReleaseManager.Export.GitReleaseManagerExporter"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Export.GitReleaseManagerExporter.Export(System.String,System.String,System.String,System.String,Cake.Core.IO.FilePath,Cake.Common.Tools.GitReleaseManager.Export.GitReleaseManagerExportSettings)">
<summary>
Creates a Release using the specified and settings.
</summary>
<param name="userName">The user name.</param>
<param name="password">The password.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="fileOutputPath">The output path.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Export.GitReleaseManagerExporter.Export(System.String,System.String,System.String,Cake.Core.IO.FilePath,Cake.Common.Tools.GitReleaseManager.Export.GitReleaseManagerExportSettings)">
<summary>
Creates a Release using the specified and settings.
</summary>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="fileOutputPath">The output path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Export.GitReleaseManagerExportSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitReleaseManager.Export.GitReleaseManagerExporter"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.Export.GitReleaseManagerExportSettings.TagName">
<summary>
Gets or sets the tag name to be used when exporting the release notes.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases">
<summary>
<para>Contains functionality related to <see href="https://github.com/gittools/gitreleasemanager">GitReleaseManager</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the appropriate settings class:
<code>
#tool "nuget:?package=gitreleasemanager"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerCreate(Cake.Core.ICakeContext,System.String,System.String,System.String)">
<summary>
Creates a Package Release.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<example>
<code>
GitReleaseManagerCreate("token", "owner", "repo");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerCreate(Cake.Core.ICakeContext,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreateSettings)">
<summary>
Creates a Package Release using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitReleaseManagerCreate("token", "owner", "repo", new GitReleaseManagerCreateSettings {
Milestone = "0.1.0",
Prerelease = false,
Assets = "c:/temp/asset1.txt,c:/temp/asset2.txt",
TargetCommitish = "master",
TargetDirectory = "c:/repo",
LogFilePath = "c:/temp/grm.log"
});
</code>
</example>
<example>
<code>
GitReleaseManagerCreate("token", "owner", "repo", new GitReleaseManagerCreateSettings {
Name = "0.1.0",
InputFilePath = "c:/repo/releasenotes.md",
Prerelease = false,
Assets = "c:/temp/asset1.txt,c:/temp/asset2.txt",
TargetCommitish = "master",
TargetDirectory = "c:/repo",
LogFilePath = "c:/temp/grm.log"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerAddAssets(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String,System.String)">
<summary>
Add Assets to an existing release.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="tagName">The tag name.</param>
<param name="assets">The assets.</param>
<example>
<code>
GitReleaseManagerAddAssets("token", "owner", "repo", "0.1.0", "c:/temp/asset1.txt,c:/temp/asset2.txt");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerAddAssets(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.AddAssets.GitReleaseManagerAddAssetsSettings)">
<summary>
Add Assets to an existing release using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="tagName">The tag name.</param>
<param name="assets">The assets.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitReleaseManagerAddAssets("token", "owner", "repo", "0.1.0", "c:/temp/asset1.txt,c:/temp/asset2.txt", new GitReleaseManagerAddAssetsSettings {
TargetDirectory = "c:/repo",
LogFilePath = "c:/temp/grm.log"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerClose(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String)">
<summary>
Closes the milestone associated with a release.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="milestone">The milestone.</param>
<example>
<code>
GitReleaseManagerClose("token", "owner", "repo", "0.1.0");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerClose(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Close.GitReleaseManagerCloseMilestoneSettings)">
<summary>
Closes the milestone associated with a release using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="milestone">The milestone.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitReleaseManagerClose("token", "owner", "repo", "0.1.0", new GitReleaseManagerCloseMilestoneSettings {
TargetDirectory = "c:/repo",
LogFilePath = "c:/temp/grm.log"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerPublish(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String)">
<summary>
Publishes the release.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="tagName">The tag name.</param>
<example>
<code>
GitReleaseManagerPublish("token", "owner", "repo", "0.1.0");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerPublish(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Publish.GitReleaseManagerPublishSettings)">
<summary>
Publishes the release using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="tagName">The tag name.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitReleaseManagerPublish("token", "owner", "repo", "0.1.0", new GitReleaseManagerPublishSettings {
TargetDirectory = "c:/repo",
LogFilePath = "c:/temp/grm.log"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerExport(Cake.Core.ICakeContext,System.String,System.String,System.String,Cake.Core.IO.FilePath)">
<summary>
Exports the release notes.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="fileOutputPath">The output file path.</param>
<example>
<code>
GitReleaseManagerExport("token", "owner", "repo", "c:/temp/releasenotes.md")
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerExport(Cake.Core.ICakeContext,System.String,System.String,System.String,Cake.Core.IO.FilePath,Cake.Common.Tools.GitReleaseManager.Export.GitReleaseManagerExportSettings)">
<summary>
Exports the release notes using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="fileOutputPath">The output file path.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitReleaseManagerExport("token", "owner", "repo", "c:/temp/releasenotes.md", new GitReleaseManagerExportSettings {
TagName = "0.1.0",
TargetDirectory = "c:/repo",
LogFilePath = "c:/temp/grm.log"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerLabel(Cake.Core.ICakeContext,System.String,System.String,System.String)">
<summary>
Deletes and creates labels.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<example>
<code>
GitReleaseManagerLabel("token", "owner", "repo");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerLabel(Cake.Core.ICakeContext,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Label.GitReleaseManagerLabelSettings)">
<summary>
Deletes and creates labels using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitReleaseManagerLabel("token", "owner", "repo", new GitReleaseManagerLabelSettings {
LogFilePath = "c:/temp/grm.log"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerOpen(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String)">
<summary>
Opens the milestone associated with a release.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="milestone">The milestone.</param>
<example>
<code>
GitReleaseManagerOpen("token", "owner", "repo", "0.1.0");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerOpen(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Open.GitReleaseManagerOpenMilestoneSettings)">
<summary>
Opens the milestone associated with a release using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="milestone">The milestone.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitReleaseManagerOpen("token", "owner", "repo", "0.1.0", new GitReleaseManagerOpenMilestoneSettings {
TargetDirectory = "c:/repo",
LogFilePath = "c:/temp/grm.log"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerDiscard(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String)">
<summary>
Discards a Release.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="milestone">The milestone.</param>
<example>
<code>
GitReleaseManagerDiscard("token", "owner", "repo", "0.1.0");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerDiscard(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Discard.GitReleaseManagerDiscardSettings)">
<summary>
Discards a Release using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="milestone">The milestone.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitReleaseManagerDiscard("token", "owner", "repo", "0.1.0", new GitReleaseManagerDiscardSettings {
TargetDirectory = "c:/repo",
LogFilePath = "c:/temp/grm.log"
});
</code>
</example>
<example>
<code>
GitReleaseManagerDiscard("token", "owner", "repo", "0.1.0", new GitReleaseManagerDiscardSettings {
TargetDirectory = "c:/repo",
LogFilePath = "c:/temp/grm.log"
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerSettings"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerSettings.TargetDirectory">
<summary>
Gets or sets the path on which GitReleaseManager should be executed.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerSettings.LogFilePath">
<summary>
Gets or sets the path to the GitReleaseManager log file.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerSettings.Debug">
<summary>
Gets or sets a value indicating whether or not to use debug level logging.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerSettings.Verbose">
<summary>
Gets or sets a value indicating whether or not to use verbose level logging.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerSettings.NoLogo">
<summary>
Gets or sets a value indicating whether or not to show the GitReleaseManager logo during execution.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerTool`1">
<summary>
Base class for all GitReleaseManager related tools.
</summary>
<typeparam name="TSettings">The settings type.</typeparam>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerTool`1.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerTool`1"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerTool`1.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerTool`1.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerTool`1.AddBaseArguments(Cake.Common.Tools.GitReleaseManager.GitReleaseManagerSettings,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Adds common arguments to the process builder.
</summary>
<param name="settings">The settings.</param>
<param name="builder">The process argument builder.</param>
<returns>The process argument builder.</returns>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Label.GitReleaseManagerLabeller">
<summary>
The GitReleaseManager Label Creator used to delete and create labels.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Label.GitReleaseManagerLabeller.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitReleaseManager.Label.GitReleaseManagerLabeller"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Label.GitReleaseManagerLabeller.Label(System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Label.GitReleaseManagerLabelSettings)">
<summary>
Deletes and creates labels using the specified and settings.
</summary>
<param name="userName">The user name.</param>
<param name="password">The password.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Label.GitReleaseManagerLabeller.Label(System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Label.GitReleaseManagerLabelSettings)">
<summary>
Deletes and creates labels using the specified and settings.
</summary>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Label.GitReleaseManagerLabelSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitReleaseManager.Label.GitReleaseManagerLabeller"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Open.GitReleaseManagerMilestoneOpener">
<summary>
The GitReleaseManager Milestone Opener used to open milestones.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Open.GitReleaseManagerMilestoneOpener.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitReleaseManager.Open.GitReleaseManagerMilestoneOpener"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Open.GitReleaseManagerMilestoneOpener.Open(System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Open.GitReleaseManagerOpenMilestoneSettings)">
<summary>
Creates a Release using the specified settings.
</summary>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="milestone">The milestone.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Open.GitReleaseManagerOpenMilestoneSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitReleaseManager.Open.GitReleaseManagerMilestoneOpener"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Publish.GitReleaseManagerPublisher">
<summary>
The GitReleaseManager Release Publisher used to publish releases.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Publish.GitReleaseManagerPublisher.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitReleaseManager.Publish.GitReleaseManagerPublisher"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Publish.GitReleaseManagerPublisher.Publish(System.String,System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Publish.GitReleaseManagerPublishSettings)">
<summary>
Creates a Release using the specified and settings.
</summary>
<param name="userName">The user name.</param>
<param name="password">The password.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="tagName">The tag name.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Publish.GitReleaseManagerPublisher.Publish(System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Publish.GitReleaseManagerPublishSettings)">
<summary>
Creates a Release using the specified and settings.
</summary>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="tagName">The tag name.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Publish.GitReleaseManagerPublishSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitReleaseManager.Publish.GitReleaseManagerPublisher"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesAliases">
<summary>
<para>Contains functionality related to <see href="https://github.com/gittools/gitreleasenotes">GitReleaseNotes</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings" /> class:
<code>
#tool "nuget:?package=GitReleaseNotes"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesAliases.GitReleaseNotes(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings)">
<summary>
Generates a set of release notes based on the commit history of the repository and specified settings.
</summary>
<param name="context">The context.</param>
<param name="outputFile">The output file.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitReleaseNotes("c:/temp/releasenotes.md", new GitReleaseNotesSettings {
WorkingDirectory = "c:/temp",
Verbose = true,
IssueTracker = IssueTracker.GitHub,
AllTags = true,
RepoUserName = "bob",
RepoPassword = "password",
RepoUrl = "http://myrepo.co.uk",
RepoBranch = "master",
IssueTrackerUrl = "http://myissuetracker.co.uk",
IssueTrackerUserName = "bob",
IssueTrackerPassword = "password",
IssueTrackerProjectId = "1234",
Categories = "Category1",
Version = "1.2.3.4",
AllLabels = true
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesIssueTracker">
<summary>
The IssueTracker to be used.
</summary>
</member>
<member name="F:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesIssueTracker.BitBucket">
<summary>
Uses BitBucket as Issue Tracker.
</summary>
</member>
<member name="F:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesIssueTracker.GitHub">
<summary>
Uses GitHub as Issue Tracker.
</summary>
</member>
<member name="F:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesIssueTracker.Jira">
<summary>
Uses Jira as Issue Tracker.
</summary>
</member>
<member name="F:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesIssueTracker.YouTrack">
<summary>
Uses YouTrack as Issue Tracker.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesRunner">
<summary>
The GitReleaseNotes runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesRunner.Run(Cake.Core.IO.FilePath,Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings)">
<summary>
Runs GitVersion and processes the results.
</summary>
<param name="outputFile">The output file.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesRunner" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.Verbose">
<summary>
Gets or sets a value indicating whether verbose logging is used.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.IssueTracker">
<summary>
Gets or sets the IssueTracker to use.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.AllTags">
<summary>
Gets or sets a value indicating whether all tags should be included in the releasenotes.
</summary>
<remarks>If not specified then only the issues since that last tag are included.</remarks>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.RepoUserName">
<summary>
Gets or sets the username to use when accessing repository.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.RepoPassword">
<summary>
Gets or sets the password to use when accessing repository.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.RepoToken">
<summary>
Gets or sets the token to use when accessing repository.
</summary>
<remarks>To be used instead of username/password.</remarks>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.RepoUrl">
<summary>
Gets or sets the Url to use when accessing repository.
</summary>
<remarks>To be used instead of username/password.</remarks>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.RepoBranch">
<summary>
Gets or sets the branch name to checkout any existing release notes file.
</summary>
<remarks>To be used instead of username/password.</remarks>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.IssueTrackerUrl">
<summary>
Gets or sets the Url to the Issue Tracker.
</summary>
<remarks>To be used instead of username/password.</remarks>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.IssueTrackerUserName">
<summary>
Gets or sets the username to use when accessing issue tracker.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.IssueTrackerPassword">
<summary>
Gets or sets the password to use when accessing issue tracker.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.IssueTrackerToken">
<summary>
Gets or sets the token to use when accessing issue tracker.
</summary>
<remarks>To be used instead of username/password.</remarks>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.IssueTrackerProjectId">
<summary>
Gets or sets the Project Id to use when accessing issue tracker.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.IssueTrackerFilter">
<summary>
Gets or sets the Jql query for closed issues you would like included if mentioned.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.Categories">
<summary>
Gets or sets a value which allows additional labels to be treated as categories.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.Version">
<summary>
Gets or sets a value which specifies the version to publish.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.AllLabels">
<summary>
Gets or sets a value indicating whether all labels should be included in the releasenotes.
</summary>
<remarks>If not specified then only the defaults (bug, enhancement, feature) are included.</remarks>
</member>
<member name="T:Cake.Common.Tools.GitVersion.GitVersion">
<summary>
GitVersion information.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.Major">
<summary>
Gets or sets the major version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.Minor">
<summary>
Gets or sets the minor version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.Patch">
<summary>
Gets or sets the patch version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.PreReleaseTag">
<summary>
Gets or sets the pre-release tag.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.PreReleaseTagWithDash">
<summary>
Gets or sets the pre-release tag with dash.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.PreReleaseLabel">
<summary>
Gets or sets the pre-release label.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.PreReleaseNumber">
<summary>
Gets or sets the pre-release number.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.BuildMetaData">
<summary>
Gets or sets the build metadata.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.BuildMetaDataPadded">
<summary>
Gets or sets the build metadata padded.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.FullBuildMetaData">
<summary>
Gets or sets the major version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.MajorMinorPatch">
<summary>
Gets or sets the major, minor, and path.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.SemVer">
<summary>
Gets or sets the Semantic Version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.LegacySemVer">
<summary>
Gets or sets the legacy Semantic Version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.LegacySemVerPadded">
<summary>
Gets or sets the padded legacy Semantic Version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.AssemblySemVer">
<summary>
Gets or sets the assembly Semantic Version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.AssemblySemFileVer">
<summary>
Gets or sets the assembly semantic file version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.FullSemVer">
<summary>
Gets or sets the full Semantic Version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.InformationalVersion">
<summary>
Gets or sets the informational version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.BranchName">
<summary>
Gets or sets the branch name.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.Sha">
<summary>
Gets or sets the Git SHA.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.NuGetVersionV2">
<summary>
Gets or sets the NuGet version for v2.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.NuGetVersion">
<summary>
Gets or sets the NuGet version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.CommitsSinceVersionSource">
<summary>
Gets or sets the commits since version source.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.CommitsSinceVersionSourcePadded">
<summary>
Gets or sets the commits since version source padded.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.CommitDate">
<summary>
Gets or sets the commit date.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitVersion.GitVersionAliases">
<summary>
<para>Contains functionality related to <see href="https://github.com/gittools/gitversion">GitVersion</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.GitVersion.GitVersionSettings" /> class:
<code>
#tool "dotnet:?package=GitVersion.Tool"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.GitVersion.GitVersionAliases.GitVersion(Cake.Core.ICakeContext)">
<summary>
Retrieves the GitVersion output.
</summary>
<param name="context">The context.</param>
<returns>The Git version info.</returns>
<example>
<para>Update the assembly info files for the project.</para>
<para>Cake task:</para>
<code>
<![CDATA[
Task("UpdateAssemblyInfo")
.Does(() =>
{
GitVersion(new GitVersionSettings {
UpdateAssemblyInfo = true
});
});
]]>
</code>
<para>Get the Git version info for the project using a dynamic repository.</para>
<para>Cake task:</para>
<code>
<![CDATA[
Task("GetVersionInfo")
.Does(() =>
{
var result = GitVersion(new GitVersionSettings {
UserName = "MyUser",
Password = "MyPassword,
Url = "http://git.myhost.com/myproject.git"
Branch = "develop"
Commit = EnvironmentVariable("MY_COMMIT")
});
// Use result for building NuGet packages, setting build server version, etc...
});
]]>
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitVersion.GitVersionAliases.GitVersion(Cake.Core.ICakeContext,Cake.Common.Tools.GitVersion.GitVersionSettings)">
<summary>
Retrieves the GitVersion output.
</summary>
<param name="context">The context.</param>
<param name="settings">The GitVersion settings.</param>
<returns>The Git version info.</returns>
<example>
<para>Update the assembly info files for the project.</para>
<para>Cake task:</para>
<code>
<![CDATA[
Task("UpdateAssemblyInfo")
.Does(() =>
{
GitVersion(new GitVersionSettings {
UpdateAssemblyInfo = true
});
});
]]>
</code>
<para>Get the Git version info for the project using a dynamic repository.</para>
<para>Cake task:</para>
<code>
<![CDATA[
Task("GetVersionInfo")
.Does(() =>
{
var result = GitVersion(new GitVersionSettings {
UserName = "MyUser",
Password = "MyPassword,
Url = "http://git.myhost.com/myproject.git"
Branch = "develop"
Commit = EnvironmentVariable("MY_COMMIT")
});
// Use result for building NuGet packages, setting build server version, etc...
});
]]>
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.GitVersion.GitVersionOutput">
<summary>
The Git version output type.
</summary>
</member>
<member name="F:Cake.Common.Tools.GitVersion.GitVersionOutput.Json">
<summary>
Outputs to the stdout using json.
</summary>
</member>
<member name="F:Cake.Common.Tools.GitVersion.GitVersionOutput.BuildServer">
<summary>
Outputs to the stdout in a way usable by a detected build server.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitVersion.GitVersionRunner">
<summary>
The GitVersion runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitVersion.GitVersionRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitVersion.GitVersionRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="log">The log.</param>
</member>
<member name="M:Cake.Common.Tools.GitVersion.GitVersionRunner.Run(Cake.Common.Tools.GitVersion.GitVersionSettings)">
<summary>
Runs GitVersion and processes the results.
</summary>
<param name="settings">The settings.</param>
<returns>A task with the GitVersion results.</returns>
</member>
<member name="M:Cake.Common.Tools.GitVersion.GitVersionRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.GitVersion.GitVersionRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.GitVersion.GitVersionSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitVersion.GitVersionRunner" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.RepositoryPath">
<summary>
Gets or sets the path for the Git repository to use.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.OutputType">
<summary>
Gets or sets the output type.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.UpdateAssemblyInfo">
<summary>
Gets or sets a value indicating whether to update all the AssemblyInfo files.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.UpdateAssemblyInfoFilePath">
<summary>
Gets or sets whether to update all the AssemblyInfo files.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.ShowVariable">
<summary>
Gets or sets whether to only show a specific variable.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.UserName">
<summary>
Gets or sets the username for the target repository.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.Password">
<summary>
Gets or sets the password for the target repository.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.Url">
<summary>
Gets or sets the Git URL to use if using dynamic repositories.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.Branch">
<summary>
Gets or sets the branch to use if using dynamic repositories.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.Commit">
<summary>
Gets or sets the branch to use if using dynamic repositories.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.NoFetch">
<summary>
Gets or sets a value indicating whether to fetch repository information from remote when calculating version.
</summary>
<remarks>If your CI server clones the entire repository you can set this to 'true' to prevent GitVersion attempting any remote repository fetching.</remarks>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.DynamicRepositoryPath">
<summary>
Gets or sets the dynamic repository path. Defaults to %TEMP%.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.LogFilePath">
<summary>
Gets or sets the path to the log file.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.Verbosity">
<summary>
Gets or sets the logging verbosity.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitVersion.GitVersionVerbosity">
<summary>
The GitVersion verbosity.
</summary>
</member>
<member name="F:Cake.Common.Tools.GitVersion.GitVersionVerbosity.None">
<summary>
No messages will be logged.
</summary>
</member>
<member name="F:Cake.Common.Tools.GitVersion.GitVersionVerbosity.Error">
<summary>
Log error messages.
</summary>
</member>
<member name="F:Cake.Common.Tools.GitVersion.GitVersionVerbosity.Warn">
<summary>
Log error and warning messages.
</summary>
</member>
<member name="F:Cake.Common.Tools.GitVersion.GitVersionVerbosity.Info">
<summary>
Log error, warning and info messages.
</summary>
</member>
<member name="F:Cake.Common.Tools.GitVersion.GitVersionVerbosity.Debug">
<summary>
Log error, warning, info and debug messages (log all).
</summary>
</member>
<member name="T:Cake.Common.Tools.ILRepack.ILRepackAliases">
<summary>
<para>Contains functionality related to <see href="https://github.com/gluck/il-repack">ILRepack</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.ILRepack.ILRepackSettings" /> class:
<code>
#tool "nuget:?package=ILRepack"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.ILRepack.ILRepackAliases.ILRepack(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Merges the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="outputFile">The output file.</param>
<param name="primaryAssembly">The primary assembly.</param>
<param name="assemblyPaths">The assembly paths.</param>
<example>
<code>
var assemblyPaths = GetFiles("./**/Cake.*.dll");
ILRepack("./MergedCake.exe", "./Cake.exe", assemblyPaths);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.ILRepack.ILRepackAliases.ILRepack(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.ILRepack.ILRepackSettings)">
<summary>
Merges the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="outputFile">The output file.</param>
<param name="primaryAssembly">The primary assembly.</param>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
<example>
<code>
var assemblyPaths = GetFiles("./**/Cake.*.dll");
ILRepack(
"./MergedCake.exe",
"./Cake.exe",
assemblyPaths,
new ILRepackSettings { Internalize = true });
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.ILRepack.ILRepackRunner">
<summary>
The ILMerge runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.ILRepack.ILRepackRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.ILRepack.ILRepackRunner" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.ILRepack.ILRepackRunner.Merge(Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.ILRepack.ILRepackSettings)">
<summary>
Merges the specified assemblies.
</summary>
<param name="outputAssemblyPath">The output assembly path.</param>
<param name="primaryAssemblyPath">The primary assembly path.</param>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.ILRepack.ILRepackRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.ILRepack.ILRepackRunner.GetToolExecutableNames">
<summary>
Gets the name of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.ILRepack.ILRepackSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.ILRepack.ILRepackRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.Keyfile">
<summary>
Gets or sets a keyfile to sign the output assembly.
</summary>
<value>The keyfile.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.Log">
<summary>
Gets or sets a file to enable logging to (no logging if null or empty).
</summary>
<value>The log file.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.Version">
<summary>
Gets or sets the target assembly version.
</summary>
<value>The version.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.Union">
<summary>
Gets or sets a value indicating whether to merge types with identical names into one.
</summary>
<value><c>true</c> if types with identical names should be merged into one; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.NDebug">
<summary>
Gets or sets a value indicating whether to disable symbol file generation.
</summary>
<value><c>true</c> if debug symbols should be disabled; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.CopyAttrs">
<summary>
Gets or sets a value indicating whether to copy assembly attributes (by default only the primary assembly attributes are copied).
</summary>
<value><c>true</c> if assembly attributes should be copied; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.Attr">
<summary>
Gets or sets the assembly file to take attributes from.
</summary>
<value>The assembly file to take attributes from.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.AllowMultiple">
<summary>
Gets or sets a value indicating whether to allow multiple attributes (if type allows).
</summary>
<value><c>true</c> if multiple attributes should be allowed; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.TargetKind">
<summary>
Gets or sets the specify target assembly kind (library, exe, winexe supported, default is same as first assembly).
</summary>
<value>The kind of the target assembly to create.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.TargetPlatform">
<summary>
Gets or sets the target platform (v1, v1.1, v2, v4 supported).
</summary>
<value>The target platform.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.XmlDocs">
<summary>
Gets or sets a value indicating whether to merge XML documentation as well.
</summary>
<value><c>true</c> if xml documents should be merged; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.Libs">
<summary>
Gets or sets the paths to search directories for referenced assemblies (can be specified multiple times).
</summary>
<value>The libs.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.Internalize">
<summary>
Gets or sets a value indicating whether to set all types but the ones from the first assembly 'internal'.
</summary>
<value>
<c>true</c> if types in assemblies other than the primary assembly should
have their visibility modified to internal; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.DelaySign">
<summary>
Gets or sets a value indicating whether to set the key, but don't sign the assembly.
</summary>
<value><c>true</c> if assembly should be delay signed; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.AllowDup">
<summary>
Gets or sets the specified type for being duplicated in input assemblies.
</summary>
<value>The type to allow duplication of.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.AllowDuplicateResources">
<summary>
Gets or sets a value indicating whether to duplicate resources in output assembly (by default they're ignored).
</summary>
<value><c>true</c> if duplicate resources should be allowed in the output assembly; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.ZeroPeKind">
<summary>
Gets or sets a value indicating whether to allow assemblies with Zero PeKind (but obviously only IL will get merged).
</summary>
<value><c>true</c> if assemblies with Zero PeKind should be allowed; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.Wildcards">
<summary>
Gets or sets a value indicating whether to allow (and resolve) file wildcards (e.g. `*`.dll) in input assemblies.
</summary>
<value><c>true</c> if file wildcards should be allowed in input assembly paths; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.Parallel">
<summary>
Gets or sets a value indicating whether to use as many CPUs as possible to merge the assemblies.
</summary>
<value><c>true</c> if merging should use as many CPUs as possible in parallel; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.Pause">
<summary>
Gets or sets a value indicating whether to pause execution once completed (good for debugging).
</summary>
<value><c>true</c> if execution should pause once completed; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.Verbose">
<summary>
Gets or sets a value indicating whether to show more logs.
</summary>
<value><c>true</c> if more logs should be output during execution; otherwise, <c>false</c>.</value>
</member>
<member name="T:Cake.Common.Tools.InnoSetup.InnoSetupAliases">
<summary>
<para>Contains functionality related to <see href="http://www.jrsoftware.org/isinfo.php">Inno Setup</see>.</para>
<para>
In order to use the commands for this alias, Inno Setup will need to be installed on the machine where
the Cake script is being executed. See this <see href="http://www.jrsoftware.org/isdl.php">page</see> for information
on how to download/install.
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.InnoSetup.InnoSetupAliases.InnoSetup(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Compiles the given Inno Setup script using the default settings.
</summary>
<param name="context">The context.</param>
<param name="scriptFile">The path to the <c>.iss</c> script file to compile.</param>
<example>
<code>
InnoSetup("./src/Cake.iss");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.InnoSetup.InnoSetupAliases.InnoSetup(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.InnoSetup.InnoSetupSettings)">
<summary>
Compiles the given Inno Setup script using the given <paramref name="settings"/>.
</summary>
<param name="context">The context.</param>
<param name="scriptFile">The path to the <c>.iss</c> script file to compile.</param>
<param name="settings">The <see cref="T:Cake.Common.Tools.InnoSetup.InnoSetupSettings"/> to use.</param>
<example>
<code>
InnoSetup("./src/Cake.iss", new InnoSetupSettings {
OutputDirectory = outputDirectory
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.InnoSetup.InnoSetupQuietMode">
<summary>
Represents the possible quiet modes when compiling an Inno Setup script.
</summary>
</member>
<member name="F:Cake.Common.Tools.InnoSetup.InnoSetupQuietMode.Off">
<summary>
Quiet mode disabled. This is the default value.
</summary>
</member>
<member name="F:Cake.Common.Tools.InnoSetup.InnoSetupQuietMode.Quiet">
<summary>
Quiet mode. Only error messages are printed.
</summary>
</member>
<member name="F:Cake.Common.Tools.InnoSetup.InnoSetupQuietMode.QuietWithProgress">
<summary>
Quiet mode with progress. Same as quiet mode, but also displays progress.
</summary>
</member>
<member name="T:Cake.Common.Tools.InnoSetup.InnoSetupRunner">
<summary>
The runner which executes Inno Setup.
</summary>
</member>
<member name="M:Cake.Common.Tools.InnoSetup.InnoSetupRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.IO.IRegistry,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.InnoSetup.InnoSetupRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="registry">The registry.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.InnoSetup.InnoSetupRunner.Run(Cake.Core.IO.FilePath,Cake.Common.Tools.InnoSetup.InnoSetupSettings)">
<summary>
Runs <c>iscc.exe</c> with the specified script files and settings.
</summary>
<param name="scriptFile">The script file (<c>.iss</c>) to compile.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.InnoSetup.InnoSetupRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.InnoSetup.InnoSetupRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.InnoSetup.InnoSetupRunner.GetAlternativeToolPaths(Cake.Common.Tools.InnoSetup.InnoSetupSettings)">
<summary>
Gets alternative file paths which the tool may exist in.
</summary>
<param name="settings">The settings.</param>
<returns>The default tool path.</returns>
</member>
<member name="T:Cake.Common.Tools.InnoSetup.InnoSetupSettings">
<summary>
Contains settings used by the <see cref="T:Cake.Common.Tools.InnoSetup.InnoSetupRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.InnoSetup.InnoSetupSettings.Defines">
<summary>
Gets or sets the script compiler defines. Emulates <c>#define public</c> preprocessor directive.
</summary>
</member>
<member name="P:Cake.Common.Tools.InnoSetup.InnoSetupSettings.EnableOutput">
<summary>
Gets or sets whether or not the compiler should generate output (<c>/O+</c> and <c>/O-</c> command line options,
overrides the script's <c>Output</c> attribute).
</summary>
</member>
<member name="P:Cake.Common.Tools.InnoSetup.InnoSetupSettings.OutputDirectory">
<summary>
Gets or sets the output directory (<c>/O<path></c> command line option, overrides the script's <c>OutputDir</c>
attribute).
</summary>
</member>
<member name="P:Cake.Common.Tools.InnoSetup.InnoSetupSettings.OutputBaseFilename">
<summary>
Gets or sets the output base file name (<c>/F<filename></c> command line option, overrides the script's
<c>OutputBaseFilename</c> attribute).
</summary>
</member>
<member name="P:Cake.Common.Tools.InnoSetup.InnoSetupSettings.QuietMode">
<summary>
Gets or sets the script compiler's quiet mode (<c>/Q</c> and <c>/Qp</c> command line options).
</summary>
</member>
<member name="P:Cake.Common.Tools.InnoSetup.InnoSetupSettings.Version">
<summary>
Gets or sets the version of Inno Setup to be used with this command. By default the highest installed version of Inno Setup is used.
</summary>
</member>
<member name="M:Cake.Common.Tools.InnoSetup.InnoSetupSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.InnoSetup.InnoSetupSettings"/> class with the default settings.
</summary>
</member>
<member name="T:Cake.Common.Tools.InnoSetup.InnoSetupVersion">
<summary>
Represents the supported major versions of Inno Setup.
</summary>
</member>
<member name="F:Cake.Common.Tools.InnoSetup.InnoSetupVersion.InnoSetup5">
<summary>Version 5.x</summary>
</member>
<member name="F:Cake.Common.Tools.InnoSetup.InnoSetupVersion.InnoSetup6">
<summary>Version 6.x</summary>
</member>
<member name="T:Cake.Common.Tools.InspectCode.InspectCodeAliases">
<summary>
<para>Contains functionality related to ReSharper's <see href="https://www.jetbrains.com/help/resharper/2016.1/InspectCode.html">InspectCode</see> tool.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.InspectCode.InspectCodeSettings" /> class:
<code>
#tool "nuget:?package=JetBrains.ReSharper.CommandLineTools"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.InspectCode.InspectCodeAliases.InspectCode(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Analyses the specified solution with ReSharper's InspectCode.
</summary>
<param name="context">The context.</param>
<param name="solution">The solution.</param>
<example>
<code>
InspectCode("./src/MySolution.sln");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.InspectCode.InspectCodeAliases.InspectCode(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.InspectCode.InspectCodeSettings)">
<summary>
Analyses the specified solution with ReSharper's InspectCode,
using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="solution">The solution.</param>
<param name="settings">The settings.</param>
<example>
<code>
var buildOutputDirectory = Directory("./.build");
var resharperReportsDirectory = buildOutputDirectory + Directory("_ReSharperReports");
var msBuildProperties = new Dictionary<string, string>();
msBuildProperties.Add("configuration", configuration);
msBuildProperties.Add("platform", "AnyCPU");
InspectCode("./MySolution.sln", new InspectCodeSettings {
SolutionWideAnalysis = true,
Profile = "./MySolution.sln.DotSettings",
MsBuildProperties = msBuildProperties,
OutputFile = resharperReportsDirectory + File("inspectcode-output.xml"),
ThrowExceptionOnFindingViolations = true
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.InspectCode.InspectCodeAliases.InspectCodeFromConfig(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Runs ReSharper's InspectCode using the specified config file.
</summary>
<param name="context">The context.</param>
<param name="configFile">The config file.</param>
<example>
<code>
InspectCodeFromConfig("./src/inspectcode.config");
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.InspectCode.InspectCodeRunner">
<summary>
InspectCode runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.InspectCode.InspectCodeRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.InspectCode.InspectCodeRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="log">The logger.</param>
</member>
<member name="M:Cake.Common.Tools.InspectCode.InspectCodeRunner.Run(Cake.Core.IO.FilePath,Cake.Common.Tools.InspectCode.InspectCodeSettings)">
<summary>
Analyses the specified solution, using the specified settings.
</summary>
<param name="solution">The solution.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.InspectCode.InspectCodeRunner.RunFromConfig(Cake.Core.IO.FilePath)">
<summary>
Runs ReSharper's InspectCode using the provided config file.
</summary>
<param name="configFile">The config file.</param>
</member>
<member name="M:Cake.Common.Tools.InspectCode.InspectCodeRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.InspectCode.InspectCodeRunner.GetToolExecutableNames(Cake.Common.Tools.InspectCode.InspectCodeSettings)">
<summary>
Gets the possible names of the tool executable.
</summary>
<param name="settings">The settings.</param>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.InspectCode.InspectCodeRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.InspectCode.InspectCodeSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.InspectCode.InspectCodeRunner" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.OutputFile">
<summary>
Gets or sets the location InspectCode should write its output.
</summary>
<value>The location that InspectCode should write its output.</value>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.SolutionWideAnalysis">
<summary>
Gets or sets a value indicating whether enable solution-wide analysis should be forced.
Default value is <c>false</c>.
</summary>
<value>
<c>true</c> if solution-wide analysis should be enabled by force; otherwise, <c>fault</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.NoSolutionWideAnalysis">
<summary>
Gets or sets a value indicating whether disable solution-wide analysis should be forced.
Default value is <c>false</c>.
</summary>
<value>
<c>true</c> if solution-wide analysis should be disabled by force; otherwise, <c>fault</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.ProjectFilter">
<summary>
Gets or sets a filter to analyze only particular project(s) instead of the whole solution.
Supports wildcards.
</summary>
<value>The filter to analyze only particular projects(s).</value>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.MsBuildProperties">
<summary>
Gets or sets MSBuild properties.
</summary>
<value>The MSBuild properties to override.</value>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.Extensions">
<summary>
Gets or sets a list of ReSharper extensions which will be used.
</summary>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.CachesHome">
<summary>
Gets or sets the directory where caches will be stored.
The default is %TEMP%.
</summary>
<value>The directory where caches will be stored.</value>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.Debug">
<summary>
Gets or sets a value indicating whether the debug output should be enabled.
</summary>
<value>
<c>true</c> if the debug output should be enabled; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.NoBuildinSettings">
<summary>
Gets or sets a value indicating whether all global, solution and project settings should be ignored.
Alias for disabling the settings layers GlobalAll, GlobalPerProduct, SolutionShared, SolutionPersonal, ProjectShared and ProjectPersonal.
</summary>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.DisabledSettingsLayers">
<summary>
Gets or sets a list of <c>InspectCodeSettings</c> which will be disabled.
</summary>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.Profile">
<summary>
Gets or sets the path to the file to use custom settings from.
</summary>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.ThrowExceptionOnFindingViolations">
<summary>
Gets or sets a value indicating whether to throw an exception on finding violations.
</summary>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.UseX86Tool">
<summary>
Gets or sets a value indicating whether to use x86 tool.
</summary>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.Verbosity">
<summary>
Gets or sets the verbosity level of the log messages.
</summary>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.Severity">
<summary>
Gets or sets the minimal severity of issues to report.
</summary>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.SkipOutputAnalysis">
<summary>
Gets or sets a value indicating whether to skip analysis of the file
that was output by the command line tool or not.
</summary>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.Build">
<summary>
Gets or sets a value indicating whether to build or not-build the
sources before running the tool. Setting this value is only valid
for InspectCode version 2021.2.0 and later.
<para>
<list type="bullet">
<item><description>
Setting this property to <c>true</c> will result in passing the '--build' option.
</description></item>
<item><description>
Setting this property to <c>false</c> will result in passing the '--no-build' option.
</description></item>
<item><description>
Setting this property to <c>null</c> will result in no changes to the options. This is the default
and the only valid setting for versions before 2021.2.
</description></item>
</list>
</para>
</summary>
<remarks>
Starting from version 2021.2, InspectCode builds the target solution before starting the analysis
to make sure it only finds relevant code issues.
To explicitly accept the new behavior and suppress this warning, use the '--build' option.
To match the behavior in previous versions and skip the build, use '--no-build'.
</remarks>
</member>
<member name="T:Cake.Common.Tools.InspectCode.InspectCodeSeverity">
<summary>
Represents InspectCode's minimal severity report.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeSeverity.Info">
<summary>
Severity: INFO.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeSeverity.Hint">
<summary>
Severity: HINT.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeSeverity.Suggestion">
<summary>
Severity: SUGGESTION.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeSeverity.Warning">
<summary>
Severity: WARNING.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeSeverity.Error">
<summary>
Severity: ERROR.
</summary>
</member>
<member name="T:Cake.Common.Tools.InspectCode.InspectCodeVerbosity">
<summary>
Represents InspectCode's logging verbosity.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeVerbosity.Off">
<summary>
Verbosity: OFF.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeVerbosity.Fatal">
<summary>
Verbosity: FATAL.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeVerbosity.Error">
<summary>
Verbosity: ERROR.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeVerbosity.Warn">
<summary>
Verbosity: WARN.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeVerbosity.Info">
<summary>
Verbosity: INFO.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeVerbosity.Verbose">
<summary>
Verbosity: VERBOSE.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeVerbosity.Trace">
<summary>
Verbosity: TRACE.
</summary>
</member>
<member name="T:Cake.Common.Tools.InspectCode.SettingsLayer">
<summary>
Represents ReSharper's settings layers.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.SettingsLayer.GlobalAll">
<summary>
SettingsLayer: <c>GlobalAll</c>.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.SettingsLayer.GlobalPerProduct">
<summary>
SettingsLayer: <c>GlobalPerProduct</c>.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.SettingsLayer.SolutionShared">
<summary>
SettingsLayer: <c>SolutionShared</c>. This layer is saved in <c>%SolutionName%.sln.DotSettings</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.SettingsLayer.SolutionPersonal">
<summary>
SettingsLayer: <c>SolutionPersonal</c>. This layer is saved in <c>%SolutionName%.sln.DotSettings.user</c>.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.SettingsLayer.ProjectShared">
<summary>
SettingsLayer: <c>ProjectShared</c>. This layer is saved in <c>%ProjectName%.csproj.DotSettings</c>.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.SettingsLayer.ProjectPersonal">
<summary>
SettingsLayer: <c>ProjectPersonal</c>. This layer is saved in <c>%ProjectName%.csproj.DotSettings.user</c>.
</summary>
</member>
<member name="T:Cake.Common.Tools.MSpec.MSpecAliases">
<summary>
<para>Contains functionality related to running <see href="https://github.com/machine/machine.specifications">Machine.Specifications</see> tests.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.MSpec.MSpecSettings" /> class:
<code>
#tool "nuget:?package=Machine.Specifications.Runner.Console"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.MSpec.MSpecAliases.MSpec(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Runs all MSpec tests in the assemblies matching the specified pattern.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<example>
<code>
MSpec("./src/**/bin/Release/*.Tests.dll");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.MSpec.MSpecAliases.MSpec(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.MSpec.MSpecSettings)">
<summary>
Runs all MSpec tests in the assemblies matching the specified pattern.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="settings">The settings.</param>
<example>
<code>
MSpec("./src/**/bin/Release/*.Tests.dll",
new MSpecSettings {
Parallelism = ParallelismOption.All,
HtmlReport = true,
NoAppDomain = true,
OutputDirectory = "./build"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.MSpec.MSpecAliases.MSpec(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Runs all MSpec tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<example>
<code>
MSpec(new []{
"./src/Cake.Common.Tests/bin/Release/Cake.Common.Tests.dll",
"./src/Cake.Core.Tests/bin/Release/Cake.Core.Tests.dll",
"./src/Cake.NuGet.Tests/bin/Release/Cake.NuGet.Tests.dll",
"./src/Cake.Tests/bin/Release/Cake.Tests.dll"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.MSpec.MSpecAliases.MSpec(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Runs all MSpec tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<example>
<code>
var testAssemblies = GetFiles("./src/**/bin/Release/*.Tests.dll");
MSpec(testAssemblies);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.MSpec.MSpecAliases.MSpec(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Tools.MSpec.MSpecSettings)">
<summary>
Runs all MSpec tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
<example>
<code>
MSpec(new []{
"./src/Cake.Common.Tests/bin/Release/Cake.Common.Tests.dll",
"./src/Cake.Core.Tests/bin/Release/Cake.Core.Tests.dll",
"./src/Cake.NuGet.Tests/bin/Release/Cake.NuGet.Tests.dll",
"./src/Cake.Tests/bin/Release/Cake.Tests.dll"
},
new MSpecSettings {
Parallelism = ParallelismOption.All,
HtmlReport = true,
NoAppDomain = true,
OutputDirectory = "./build"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.MSpec.MSpecAliases.MSpec(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.MSpec.MSpecSettings)">
<summary>
Runs all MSpec tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
<example>
<code>
var testAssemblies = GetFiles("./src/**/bin/Release/*.Tests.dll");
MSpec(testAssemblies,
new MSpecSettings {
Parallelism = ParallelismOption.All,
HtmlReport = true,
NoAppDomain = true,
OutputDirectory = "./build"
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.MSpec.MSpecRunner">
<summary>
The MSpec unit test runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.MSpec.MSpecRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.MSpec.MSpecRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.MSpec.MSpecRunner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.MSpec.MSpecSettings)">
<summary>
Runs the tests in the specified assemblies, using the specified settings.
</summary>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.MSpec.MSpecRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.MSpec.MSpecRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.MSpec.MSpecSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.MSpec.MSpecRunner" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.Filters">
<summary>
Gets or sets the path to the filter file specifying contexts to execute(full type name, one per line). Takes precedence over
tags.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.TeamCity">
<summary>
Gets or sets a value indicating whether reporting for TeamCity CI integration(also auto - detected).
</summary>
<value>
<c>true</c> to turn on TeamCity service messages; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.NoColor">
<summary>
Gets or sets a value indicating whether to suppress colored console output.
</summary>
<value>
<c>true</c> disable color output; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.XmlReport">
<summary>
Gets or sets a value indicating whether an XML report should be generated.
</summary>
<value>
<c>true</c> if an XML report should be generated; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.HtmlReport">
<summary>
Gets or sets a value indicating whether an HTML report should be generated.
</summary>
<value>
<c>true</c> if an HTML report should be generated; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.ReportName">
<summary>
Gets or sets the name that should be used for the HTML and XML reports.
</summary>
<value>The custom report name.</value>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.Include">
<summary>
Gets or sets Executes all specifications in contexts with these comma delimited tags. Ex. - i "foo,bar,foo_bar".
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.Exclude">
<summary>
Gets or sets Exclude specifications in contexts with these comma delimited tags. Ex. - x "foo,bar,foo_bar".
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.TimeInfo">
<summary>
Gets or sets a value indicating whether to show time-related information in HTML output.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.Silent">
<summary>
Gets or sets a value indicating whether to suppress progress output(print fatal errors, failures and summary).
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.Progress">
<summary>
Gets or sets a value indicating whether to print dotted progress output.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.Wait">
<summary>
Gets or sets a value indicating whether to wait 15 seconds for debugger to be attached.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.NoTeamCity">
<summary>
Gets or sets a value indicating whether to disable TeamCity autodetection.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.AppVeyor">
<summary>
Gets or sets a value indicating whether to enable reporting for AppVeyor CI integration (also auto-detected).
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.NoAppVeyor">
<summary>
Gets or sets a value indicating whether to disable AppVeyor autodetection.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.OutputDirectory">
<summary>
Gets or sets output directory for reports.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.UseX86">
<summary>
Gets or sets a value indicating whether to use X86.
</summary>
</member>
<member name="T:Cake.Common.Tools.NSIS.MakeNSISRunner">
<summary>
The runner which executes NSIS.
</summary>
</member>
<member name="M:Cake.Common.Tools.NSIS.MakeNSISRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NSIS.MakeNSISRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.NSIS.MakeNSISRunner.Run(Cake.Core.IO.FilePath,Cake.Common.Tools.NSIS.MakeNSISSettings)">
<summary>
Runs <c>makensis.exe</c> with the specified script files and settings.
</summary>
<param name="scriptFile">The script file (<c>.nsi</c>) to compile.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.NSIS.MakeNSISRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.NSIS.MakeNSISRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.NSIS.MakeNSISSettings">
<summary>
Contains settings used by the <see cref="T:Cake.Common.Tools.NSIS.MakeNSISRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NSIS.MakeNSISSettings.Defines">
<summary>
Gets or sets the script compiler defines.
</summary>
</member>
<member name="P:Cake.Common.Tools.NSIS.MakeNSISSettings.NoChangeDirectory">
<summary>
Gets or sets a value indicating whether to disable current directory change to that of the script file.
</summary>
</member>
<member name="P:Cake.Common.Tools.NSIS.MakeNSISSettings.NoConfig">
<summary>
Gets or sets a value indicating whether to disable inclusion of the <c>nsisconf.nsh</c> file.
</summary>
</member>
<member name="T:Cake.Common.Tools.NSIS.NSISAliases">
<summary>
<para>Contains functionality related to <see href="http://nsis.sourceforge.net/Main_Page">NSIS</see>.</para>
<para>
In order to use the commands for this alias, NSIS will need to be installed on the machine where
the Cake script is being executed. See this <see href="http://nsis.sourceforge.net/Download">page</see> for information
on how to download/install.
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.NSIS.NSISAliases.MakeNSIS(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Compiles the given NSIS script using the default settings.
</summary>
<param name="context">The context.</param>
<param name="scriptFile">The path to the <c>.nsi</c> script file to compile.</param>
<example>
<code>
MakeNSIS("./src/Cake.nsi");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NSIS.NSISAliases.MakeNSIS(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.NSIS.MakeNSISSettings)">
<summary>
Compiles the given NSIS script using the given <paramref name="settings"/>.
</summary>
<param name="context">The context.</param>
<param name="scriptFile">The path to the <c>.nsi</c> script file to compile.</param>
<param name="settings">The <see cref="T:Cake.Common.Tools.NSIS.MakeNSISSettings"/> to use.</param>
<example>
<code>
MakeNSIS("./src/Cake.nsi", new MakeNSISSettings {
NoConfig = true
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.OpenCover.OpenCoverAliases">
<summary>
<para>Contains functionality related to <see href="https://github.com/opencover/opencover">OpenCover</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverSettings" /> class:
<code>
#tool "nuget:?package=OpenCover"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverAliases.OpenCover(Cake.Core.ICakeContext,System.Action{Cake.Core.ICakeContext},Cake.Core.IO.FilePath,Cake.Common.Tools.OpenCover.OpenCoverSettings)">
<summary>
Runs <see href="https://github.com/OpenCover/opencover">OpenCover</see>
for the specified action and settings.
</summary>
<param name="context">The context.</param>
<param name="action">The action to run OpenCover for.</param>
<param name="outputFile">The OpenCover output file.</param>
<param name="settings">The settings.</param>
<example>
<code>
OpenCover(tool => {
tool.XUnit2("./**/App.Tests.dll",
new XUnit2Settings {
ShadowCopy = false
});
},
new FilePath("./result.xml"),
new OpenCoverSettings()
.WithFilter("+[App]*")
.WithFilter("-[App.Tests]*"));
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.OpenCover.OpenCoverHideSkippedOption">
<summary>
Represents the hide skipped option for OpenCover.
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverHideSkippedOption.None">
<summary>
Removes no information from output file.
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverHideSkippedOption.File">
<summary>
Removes information from output files that relates to classes/modules that have been skipped (filtered) due to use of the -excludebyfile -switch.
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverHideSkippedOption.Filter">
<summary>
Removes information from output files that relates to classes/modules that have been skipped (filtered) due to use of the -filter -switch.
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverHideSkippedOption.Attribute">
<summary>
Removes information from output files that relates to classes/modules that have been skipped (filtered) due to use of the -excludebyattribute -switch.
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverHideSkippedOption.MissingPdb">
<summary>
Removes missing Pdb information from output file.
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverHideSkippedOption.All">
<summary>
Removes all information from output file.
</summary>
</member>
<member name="T:Cake.Common.Tools.OpenCover.OpenCoverHideSkippedOptionExtensions">
<summary>
Extensions class for <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverHideSkippedOption"/>.
</summary>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverHideSkippedOptionExtensions.GetFlags(Cake.Common.Tools.OpenCover.OpenCoverHideSkippedOption)">
<summary>
Get flags.
</summary>
<param name="openCoverHideSkippedOption">
The input.
</param>
<returns>
The <see cref="T:System.Collections.IEnumerable"/>.
</returns>
</member>
<member name="T:Cake.Common.Tools.OpenCover.OpenCoverLogLevel">
<summary>
Represents the logging output level for OpenCover.
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverLogLevel.Info">
<summary>
Logs info messages and above (default)
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverLogLevel.Off">
<summary>
This log level disables logging
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverLogLevel.Fatal">
<summary>
Logs fatal messages
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverLogLevel.Error">
<summary>
Logs error messages and above
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverLogLevel.Warn">
<summary>
Logs warn messages and above
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverLogLevel.Debug">
<summary>
Logs debug messages and above
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverLogLevel.Verbose">
<summary>
Logs verbose messages and above
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverLogLevel.All">
<summary>
Logs all messages
</summary>
</member>
<member name="T:Cake.Common.Tools.OpenCover.OpenCoverRunner">
<summary>
The OpenCover runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverRunner.Run(Cake.Core.ICakeContext,System.Action{Cake.Core.ICakeContext},Cake.Core.IO.FilePath,Cake.Common.Tools.OpenCover.OpenCoverSettings)">
<summary>
Runs OpenCover with the specified settings.
</summary>
<param name="context">The context.</param>
<param name="action">The action.</param>
<param name="outputPath">The output file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.OpenCover.OpenCoverSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.Filters">
<summary>
Gets the filters.
This represents the <c>-filter</c> option.
</summary>
<value>The filters.</value>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.ExcludedAttributeFilters">
<summary>
Gets attribute filters used to exclude classes or methods.
This represents the <c>-excludebyattribute</c> option.
</summary>
<value>The excluded attributes.</value>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.ExcludedFileFilters">
<summary>
Gets file filters used to excluded classes or methods.
This represents the <c>-excludebyfile</c> option.
</summary>
<value>The excluded file filters.</value>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.SkipAutoProps">
<summary>
Gets or sets a value indicating whether or not auto-implemented properties should be skipped.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.Register">
<summary>
Gets or sets the register option.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.ReturnTargetCodeOffset">
<summary>
Gets or sets the Return target code offset to be used.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.OldStyle">
<summary>
Gets or sets a value indicating whether the OldStyle option for OpenCover should be used.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.MergeOutput">
<summary>
Gets or sets a value indicating whether to merge the results with an existing file.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.ExcludeDirectories">
<summary>
Gets a list of directories where assemblies being loaded from will be ignored.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.LogLevel">
<summary>
Gets or sets the log level of OpenCover.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.HideSkippedOption">
<summary>
Gets or sets the hide skipped option of OpenCover.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.MergeByHash">
<summary>
Gets or sets a value indicating whether to merge the coverage results for an assembly
regardless of where it was loaded assuming it has the same file-hash in each location.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.NoDefaultFilters">
<summary>
Gets or sets a value indicating whether the default filters should be applied or not.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.SearchDirectories">
<summary>
Gets a list of directories with alternative locations to look for PDBs.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.IsService">
<summary>
Gets or sets a value indicating whether if the value provided in the target parameter
is the name of a service rather than a name of a process.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.TargetDirectory">
<summary>
Gets or sets a value indicating the path to the target directory.
If the target already contains a path, this parameter can be used
as additional path where PDBs may be found.
</summary>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.OpenCover.OpenCoverSettingsExtensions">
<summary>
Contains extensions for <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverSettings"/>.
</summary>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverSettingsExtensions.WithFilter(Cake.Common.Tools.OpenCover.OpenCoverSettings,System.String)">
<summary>
Adds the filter.
</summary>
<param name="settings">The settings.</param>
<param name="filter">The filter.</param>
<returns>The same <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverSettingsExtensions.ExcludeByAttribute(Cake.Common.Tools.OpenCover.OpenCoverSettings,System.String)">
<summary>
Exclude a class or method by filter
that match attributes that have been applied.
</summary>
<param name="settings">The settings.</param>
<param name="filter">The filter.</param>
<returns>The same <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverSettingsExtensions.ExcludeByFile(Cake.Common.Tools.OpenCover.OpenCoverSettings,System.String)">
<summary>
Exclude a class (or methods) by filter that match the filenames.
</summary>
<param name="settings">The settings.</param>
<param name="filter">The filter.</param>
<returns>The same <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Common.Tools.ReportGenerator.ReportGeneratorAliases">
<summary>
<para>Contains functionality related to <see href="https://github.com/danielpalme/ReportGenerator">ReportGenerator</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings" /> class:
<code>
#tool "nuget:?package=ReportGenerator"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.ReportGenerator.ReportGeneratorAliases.ReportGenerator(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Core.IO.DirectoryPath)">
<summary>
Converts the coverage report specified by the glob pattern into human readable form.
</summary>
<param name="context">The context.</param>
<param name="pattern">The glob pattern.</param>
<param name="targetDir">The output directory.</param>
<example>
<code>
ReportGenerator("c:/temp/coverage/*.xml", "c:/temp/output");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.ReportGenerator.ReportGeneratorAliases.ReportGenerator(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Core.IO.DirectoryPath,Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings)">
<summary>
Converts the coverage report specified by the glob pattern into human readable form using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="pattern">The glob pattern.</param>
<param name="targetDir">The output directory.</param>
<param name="settings">The settings.</param>
<example>
<code>
ReportGenerator("c:/temp/coverage/*.xml", "c:/temp/output", new ReportGeneratorSettings(){
ToolPath = "c:/tools/reportgenerator.exe"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.ReportGenerator.ReportGeneratorAliases.ReportGenerator(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.DirectoryPath)">
<summary>
Converts the specified coverage report into human readable form.
</summary>
<param name="context">The context.</param>
<param name="report">The coverage report.</param>
<param name="targetDir">The output directory.</param>
<example>
<code>
ReportGenerator("c:/temp/coverage/report.xml", "c:/temp/output");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.ReportGenerator.ReportGeneratorAliases.ReportGenerator(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.DirectoryPath,Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings)">
<summary>
Converts the specified coverage report into human readable form using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="report">The coverage report.</param>
<param name="targetDir">The output directory.</param>
<param name="settings">The settings.</param>
<example>
<code>
ReportGenerator("c:/temp/coverage.xml", "c:/temp/output", new ReportGeneratorSettings(){
ToolPath = "c:/tools/reportgenerator.exe"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.ReportGenerator.ReportGeneratorAliases.ReportGenerator(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Core.IO.DirectoryPath)">
<summary>
Converts the specified coverage reports into human readable form.
</summary>
<param name="context">The context.</param>
<param name="reports">The coverage reports.</param>
<param name="targetDir">The output directory.</param>
<example>
<code>
ReportGenerator(new[] { "c:/temp/coverage1.xml", "c:/temp/coverage2.xml" }, "c:/temp/output");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.ReportGenerator.ReportGeneratorAliases.ReportGenerator(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Core.IO.DirectoryPath,Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings)">
<summary>
Converts the specified coverage reports into human readable form using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="reports">The coverage reports.</param>
<param name="targetDir">The output directory.</param>
<param name="settings">The settings.</param>>
<example>
<code>
ReportGenerator(new[] { "c:/temp/coverage1.xml", "c:/temp/coverage2.xml" }, "c:/temp/output", new ReportGeneratorSettings(){
ToolPath = "c:/tools/reportgenerator.exe"
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType">
<summary>
Represents ReportGenerator's output formats.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.Badges">
<summary>
Badge report.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.Html">
<summary>
Html report.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.HtmlSummary">
<summary>
Html summary report.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.Latex">
<summary>
Latex report.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.LatexSummary">
<summary>
Latex summary report.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.TextSummary">
<summary>
Text summary report.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.Xml">
<summary>
Xml report.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.XmlSummary">
<summary>
Xml summary report.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.Cobertura">
<summary>
Cobertura report
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.CsvSummary">
<summary>
CSV summary report
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.HtmlChart">
<summary>
HTML Chart report
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.HtmlInline">
<summary>
Html report with inline CSS and JavaScript
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.HtmlInline_AzurePipelines">
<summary>
Same as HTMLInline but with modified CSS that matches the look and feel of Azure Pipelines.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.PngChart">
<summary>
A single PNG file containing a chart with historic coverage information.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.MHtml">
<summary>
Same as HTML but packaged into a single MHTML file.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.SonarQube">
<summary>
Creates xml report in SonarQube 'Generic Test Data' format.
</summary>
<remarks>
Requires ReportGenerator 4.0.6+
</remarks>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.HtmlInline_AzurePipelines_Dark">
<summary>
Same as HTMLInline but with modified CSS that matches the dark look and feel of Azure Pipelines.
</summary>
<remarks>
Requires ReportGenerator 4.0.10+
</remarks>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.Clover">
<summary>
Creates xml report in Clover format.
</summary>
<remarks>
Requires ReportGenerator 4.0.6+
</remarks>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.JsonSummary">
<summary>
Creates summary report in JSON format.
</summary>
<remarks>
Requires ReportGenerator 4.5.2+
</remarks>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.lcov">
<summary>
Creates summary report in lcov format.
</summary>
<remarks>
Requires ReportGenerator 4.3.0+
</remarks>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.TeamCitySummary">
<summary>
Outputs summary report as TeamCity statistics messages.
</summary>
<remarks>
Requires ReportGenerator 4.1.3+
</remarks>
</member>
<member name="T:Cake.Common.Tools.ReportGenerator.ReportGeneratorRunner">
<summary>
ReportGenerator runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.ReportGenerator.ReportGeneratorRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.ReportGenerator.ReportGeneratorRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.ReportGenerator.ReportGeneratorRunner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Core.IO.DirectoryPath,Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings)">
<summary>
Converts the specified coverage reports into human readable form according to the specified settings.
</summary>
<param name="reports">The coverage reports.</param>
<param name="targetDir">The output directory.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.ReportGenerator.ReportGeneratorRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.ReportGenerator.ReportGeneratorRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.ReportGenerator.ReportGeneratorRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings.ReportTypes">
<summary>
Gets or sets the list of coverage reports that should be parsed.
</summary>
</member>
<member name="P:Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings.SourceDirectories">
<summary>
Gets or sets the directories which contain the corresponding source code.
The source files are used if coverage report contains classes without path information.
</summary>
</member>
<member name="P:Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings.HistoryDirectory">
<summary>
Gets or sets the directory for storing persistent coverage information.
Can be used in future reports to show coverage evolution.
</summary>
</member>
<member name="P:Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings.AssemblyFilters">
<summary>
Gets or sets the list of assemblies that should be included or excluded in the report.
Exclusion filters take precedence over inclusion filters.
Wildcards are allowed.
</summary>
</member>
<member name="P:Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings.ClassFilters">
<summary>
Gets or sets the list of classes that should be included or excluded in the report.
Exclusion filters take precedence over inclusion filters.
Wildcards are allowed.
</summary>
</member>
<member name="P:Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings.Verbosity">
<summary>
Gets or sets the verbosity level of the log messages.
</summary>
</member>
<member name="T:Cake.Common.Tools.ReportGenerator.ReportGeneratorVerbosity">
<summary>
Represents ReportGenerator's logging verbosity.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorVerbosity.Verbose">
<summary>
Verbosity: Verbose.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorVerbosity.Info">
<summary>
Verbosity: Info.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorVerbosity.Error">
<summary>
Verbosity: Error.
</summary>
</member>
<member name="T:Cake.Common.Tools.ReportUnit.ReportUnitAliases">
<summary>
<para>Contains functionality related to <see href="http://reportunit.relevantcodes.com/">ReportUnit</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.ReportUnit.ReportUnitSettings" /> class:
<code>
#tool "nuget:?package=ReportUnit"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.ReportUnit.ReportUnitAliases.ReportUnit(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath)">
<summary>
Converts the reports in the specified directory into human readable form.
</summary>
<param name="context">The context.</param>
<param name="inputFolder">The input folder.</param>
<example>
<para>Provide only an input folder, which will causes ReportUnit to search entire directory for report files.</para>
<para>Cake task:</para>
<code>
ReportUnit("c:/temp");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.ReportUnit.ReportUnitAliases.ReportUnit(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Common.Tools.ReportUnit.ReportUnitSettings)">
<summary>
Converts the reports in the specified directory into human readable form.
</summary>
<param name="context">The context.</param>
<param name="inputFolder">The input folder.</param>
<param name="settings">The ReportUnit settings.</param>
<example>
<para>Provide an input folder and custom ToolPath, which will causes ReportUnit to search entire directory for report files.</para>
<para>Cake task:</para>
<code>
ReportUnit("c:/temp", new ReportUnitSettings(){
ToolPath = "c:/tools/reportunit.exe"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.ReportUnit.ReportUnitAliases.ReportUnit(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Core.IO.DirectoryPath,Cake.Common.Tools.ReportUnit.ReportUnitSettings)">
<summary>
Converts the reports in the specified directory into human readable form and outputs to specified folder.
</summary>
<param name="context">The context.</param>
<param name="inputFolder">The input folder.</param>
<param name="outputFolder">The output folder.</param>
<param name="settings">The ReportUnit settings.</param>
<example>
<para>Provide both input and output folder, which will causes ReportUnit to search entire directory for report files, and output the results to specified location.</para>
<para>Cake task:</para>
<code>
ReportUnit("c:/temp/input", "c:/temp/output");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.ReportUnit.ReportUnitAliases.ReportUnit(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath)">
<summary>
Converts the single specified report into human readable form and outputs to specified file.
</summary>
<param name="context">The context.</param>
<param name="inputFile">The input file.</param>
<param name="outputFile">The output file.</param>
<example>
<para>Provide both input and output file, which will causes ReportUnit to transform only the specific file, and output to the specified location.</para>
<para>Cake task:</para>
<code>
ReportUnit("c:/temp/input", "c:/temp/output");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.ReportUnit.ReportUnitAliases.ReportUnit(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Common.Tools.ReportUnit.ReportUnitSettings)">
<summary>
Converts the single specified report into human readable form and outputs to specified file.
</summary>
<param name="context">The context.</param>
<param name="inputFile">The input file.</param>
<param name="outputFile">The output file.</param>
<param name="settings">The ReportUnit settings.</param>
<example>
<para>Provide both input and output file, which will causes ReportUnit to transform only the specific file, and output to the specified location. Also use a custom path for the reportunit.exe.</para>
<para>Cake task:</para>
<code>
ReportUnit("c:/temp/input", "c:/temp/output", new ReportUnitSettings(){
ToolPath = "c:/tools/reportunit.exe"
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.ReportUnit.ReportUnitRunner">
<summary>
ReportUnit runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.ReportUnit.ReportUnitRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.ReportUnit.ReportUnitRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.ReportUnit.ReportUnitRunner.Run(Cake.Core.IO.DirectoryPath,Cake.Core.IO.DirectoryPath,Cake.Common.Tools.ReportUnit.ReportUnitSettings)">
<summary>
Converts the reports from specified folder into human readable form according to the specified settings.
</summary>
<param name="inputFolder">The input folder.</param>
<param name="outputFolder">The output folder.</param>
<param name="settings">The ReportUnit settings.</param>
</member>
<member name="M:Cake.Common.Tools.ReportUnit.ReportUnitRunner.Run(Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Common.Tools.ReportUnit.ReportUnitSettings)">
<summary>
Converts the specified report into human readable form according to the specified settings.
</summary>
<param name="inputFile">The input file.</param>
<param name="outputFile">The output file.</param>
<param name="settings">The ReportUnit settings.</param>
</member>
<member name="M:Cake.Common.Tools.ReportUnit.ReportUnitRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.ReportUnit.ReportUnitRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.ReportUnit.ReportUnitSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.ReportUnit.ReportUnitRunner"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.SpecFlow.SpecFlowAliases">
<summary>
<para>Contains functionality related to <see href="http://www.specflow.org/">SpecFlow</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the appropriate settings class:
<code>
#tool "nuget:?package=SpecFlow"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.SpecFlowAliases.SpecFlowStepDefinitionReport(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Creates a report that shows the usage and binding status of the steps for the entire project.
You can use this report to find both unused code in the automation layer and scenario steps that have no definition yet.
See <see href="https://github.com/techtalk/SpecFlow/wiki/Reporting#step-definition-report">SpecFlow Documentation</see> for more information.
</summary>
<param name="context">The context.</param>
<param name="projectFile">The path of the project file containing the feature files.</param>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.SpecFlowAliases.SpecFlowStepDefinitionReport(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.SpecFlow.StepDefinitionReport.SpecFlowStepDefinitionReportSettings)">
<summary>
Creates a report that shows the usage and binding status of the steps for the entire project.
You can use this report to find both unused code in the automation layer and scenario steps that have no definition yet.
See <see href="https://github.com/techtalk/SpecFlow/wiki/Reporting#step-definition-report">SpecFlow Documentation</see> for more information.
</summary>
<param name="context">The context.</param>
<param name="projectFile">The path of the project file containing the feature files.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.SpecFlowAliases.SpecFlowTestExecutionReport(Cake.Core.ICakeContext,System.Action{Cake.Core.ICakeContext},Cake.Core.IO.FilePath)">
<summary>
Creates a formatted HTML report of a test execution.
The report contains a summary about the executed tests and the result and also a detailed report for the individual scenario executions.
See <see href="https://github.com/techtalk/SpecFlow/wiki/Reporting#test-execution-report">SpecFlow Documentation</see> for more information.
</summary>
<param name="context">The context.</param>
<param name="action">The action to run SpecFlow for. Supported actions are: MSTest, NUnit3 and XUnit2.</param>
<param name="projectFile">The path of the project file containing the feature files.</param>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.SpecFlowAliases.SpecFlowTestExecutionReport(Cake.Core.ICakeContext,System.Action{Cake.Core.ICakeContext},Cake.Core.IO.FilePath,Cake.Common.Tools.SpecFlow.TestExecutionReport.SpecFlowTestExecutionReportSettings)">
<summary>
Creates a formatted HTML report of a test execution.
The report contains a summary about the executed tests and the result and also a detailed report for the individual scenario executions.
See <see href="https://github.com/techtalk/SpecFlow/wiki/Reporting#test-execution-report">SpecFlow Documentation</see> for more information.
</summary>
<param name="context">The context.</param>
<param name="action">The action to run SpecFlow for. Supported actions are: MSTest, NUnit, NUnit3, XUnit and XUnit2.</param>
<param name="projectFile">The path of the project file containing the feature files.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.SpecFlow.SpecFlowSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.SpecFlow.SpecFlowTool`1"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.SpecFlow.SpecFlowSettings.Out">
<summary>
Gets or sets the generated Output File. Optional.
Default: TestResult.html.
</summary>
</member>
<member name="P:Cake.Common.Tools.SpecFlow.SpecFlowSettings.XsltFile">
<summary>
Gets or sets the custom XSLT file to use, defaults to built-in stylesheet if not provided. Optional.
Default: not specified.
</summary>
</member>
<member name="T:Cake.Common.Tools.SpecFlow.SpecFlowTool`1">
<summary>
Base class for all SpecFlow related tools.
</summary>
<typeparam name="TSettings">The settings type.</typeparam>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.SpecFlowTool`1.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.SpecFlow.SpecFlowTool`1" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.SpecFlowTool`1.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.SpecFlowTool`1.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.SpecFlowTool`1.AppendArguments(Cake.Common.Tools.SpecFlow.SpecFlowSettings,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Appends the SpecFlowSettings arguments to builder.
</summary>
<param name="settings">The settings.</param>
<param name="builder">The argument builder.</param>
</member>
<member name="T:Cake.Common.Tools.SpecFlow.StepDefinitionReport.SpecFlowStepDefinitionReporter">
<summary>
SpecFlow StepDefinition execution report runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.StepDefinitionReport.SpecFlowStepDefinitionReporter.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.SpecFlow.StepDefinitionReport.SpecFlowStepDefinitionReporter" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.StepDefinitionReport.SpecFlowStepDefinitionReporter.Run(Cake.Core.IO.FilePath,Cake.Common.Tools.SpecFlow.StepDefinitionReport.SpecFlowStepDefinitionReportSettings)">
<summary>
Runs SpecFlow StepDefinitionReport with the specified settings.
</summary>
<param name="projectFile">The project file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.SpecFlow.StepDefinitionReport.SpecFlowStepDefinitionReportSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.SpecFlow.StepDefinitionReport.SpecFlowStepDefinitionReporter"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.SpecFlow.StepDefinitionReport.SpecFlowStepDefinitionReportSettings.BinFolder">
<summary>
Gets or sets the path for the compiled SpecFlow project. Optional.
Default: bin\Debug.
</summary>
</member>
<member name="T:Cake.Common.Tools.SpecFlow.TestExecutionReport.SpecFlowTestExecutionReporter">
<summary>
SpecFlow MSTest execution report runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.TestExecutionReport.SpecFlowTestExecutionReporter.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.SpecFlow.TestExecutionReport.SpecFlowTestExecutionReporter" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.TestExecutionReport.SpecFlowTestExecutionReporter.Run(Cake.Core.ICakeContext,System.Action{Cake.Core.ICakeContext},Cake.Core.IO.FilePath,Cake.Common.Tools.SpecFlow.TestExecutionReport.SpecFlowTestExecutionReportSettings)">
<summary>
Runs SpecFlow Test Execution Report with the specified settings.
</summary>
<param name="context">The context.</param>
<param name="action">The action.</param>
<param name="projectFile">The project file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.SpecFlow.TestExecutionReport.SpecFlowTestExecutionReportSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.SpecFlow.TestExecutionReport.SpecFlowTestExecutionReporter"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.SpecFlow.TestExecutionReport.SpecFlowTestExecutionReportSettings.ThrowOnTestFailure">
<summary>
Gets or sets a value indicating whether exceptions from the
intercepted action should be rethrown after report generation.
</summary>
</member>
<member name="T:Cake.Common.Tools.TextTransform.TextTransformAliases">
<summary>
<para>Contains functionality related to <see href="https://github.com/mono/monodevelop/tree/master/main/src/addins/TextTemplating/TextTransform">TextTransform</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.TextTransform.TextTransformSettings" /> class:
<code>
#tool "nuget:?package=Mono.TextTransform"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.TextTransform.TextTransformAliases.TransformTemplate(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Transform a text template.
</summary>
<example>
<code>
// Transform a .tt template.
var transform = File("./src/Cake/Transform.tt");
TransformTemplate(transform);
</code>
</example>
<param name="context">The context.</param>
<param name="sourceFile">The source file.</param>
</member>
<member name="M:Cake.Common.Tools.TextTransform.TextTransformAliases.TransformTemplate(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.TextTransform.TextTransformSettings)">
<summary>
Transform a text template.
</summary>
<example>
<code>
// Transform a .tt template.
var transform = File("./src/Cake/Transform.tt");
TransformTemplate(transform, new TextTransformSettings { OutputFile="./src/Cake/Transform.cs" });
</code>
</example>
<param name="context">The context.</param>
<param name="sourceFile">The source file.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.TextTransform.TextTransformRunner">
<summary>
The Text Transform runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.TextTransform.TextTransformRunner.Run(Cake.Core.IO.FilePath,Cake.Common.Tools.TextTransform.TextTransformSettings)">
<summary>
Runs Text Transform with the specified files and settings.
</summary>
<param name="sourceFile">The source file.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.TextTransform.TextTransformRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.TextTransform.TextTransformRunner" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.TextTransform.TextTransformRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.TextTransform.TextTransformRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.TextTransform.TextTransformSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.TextTransform.TextTransformRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.TextTransform.TextTransformSettings.Assembly">
<summary>
Gets or sets the assembly used for compiling and running the text template.
</summary>
<value>
The assembly.
</value>
</member>
<member name="P:Cake.Common.Tools.TextTransform.TextTransformSettings.OutputFile">
<summary>
Gets or sets the output file for the transform.
</summary>
<value>
The output file.
</value>
</member>
<member name="P:Cake.Common.Tools.TextTransform.TextTransformSettings.Namespace">
<summary>
Gets or sets the namespace that is used for compiling the text template.
</summary>
<value>
The namespace.
</value>
</member>
<member name="P:Cake.Common.Tools.TextTransform.TextTransformSettings.IncludeDirectory">
<summary>
Gets or sets a directory that contains the text templates sourced in the specified text template.
</summary>
</member>
<member name="P:Cake.Common.Tools.TextTransform.TextTransformSettings.ReferencePath">
<summary>
Gets or sets a directory to search for assemblies specified within the text template.
</summary>
<value>
The reference path.
</value>
</member>
<member name="P:Cake.Common.Tools.TextTransform.TextTransformSettings.Class">
<summary>
Gets or sets the class name used for converting T4 template into a C# class that can be compiled into your app and executed at runtime.
</summary>
<value>
The class name.
</value>
<remarks>
Requires T4 text template processor version 2 or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.TextTransform.TextTransformSettings.Properties">
<summary>
Gets or sets properties passes to the template's Session dictionary.
</summary>
<value>
The properties dictionary.
</value>
<remarks>
Requires T4 text template processor version 2 or newer.
These can also be accessed using strongly typed properties
(declared with <#@ parameter name="<name>" type="<type>" #> directives.)
</remarks>
</member>
<member name="T:Cake.Common.Tools.VSTest.VSTestAliases">
<summary>
Contains functionality related to running VSTest unit tests.
</summary>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestAliases.VSTest(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Runs all VSTest unit tests in the assemblies matching the specified pattern.
</summary>
<example>
<code>
VSTest("./Tests/*.UnitTests.dll");
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestAliases.VSTest(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.VSTest.VSTestSettings)">
<summary>
Runs all VSTest unit tests in the assemblies matching the specified pattern.
</summary>
<example>
<code>
VSTest("./Tests/*.UnitTests.dll", new VSTestSettings() { Logger = "trx" });
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestAliases.VSTest(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Runs all VSTest unit tests in the specified assemblies.
</summary>
<example>
<code>
var paths = new List<FilePath>() { "./assemblydir1", "./assemblydir2" };
VSTest(paths);
</code>
</example>
<param name="context">The context.</param>
<param name="assemblyPaths">The assembly paths.</param>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestAliases.VSTest(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.VSTest.VSTestSettings)">
<summary>
Runs all VSTest unit tests in the specified assemblies.
</summary>
<example>
<code>
var paths = new List<FilePath>() { "./assemblydir1", "./assemblydir2" };
VSTest(paths, new VSTestSettings() { InIsolation = true });
</code>
</example>
<param name="context">The context.</param>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.VSTest.VSTestFrameworkVersion">
<summary>
Target .NET Framework version to be used for test execution.
</summary>
</member>
<member name="F:Cake.Common.Tools.VSTest.VSTestFrameworkVersion.Default">
<summary>
Use default .NET Framework version.
</summary>
</member>
<member name="F:Cake.Common.Tools.VSTest.VSTestFrameworkVersion.NET35">
<summary>
.NET Framework version: <c>3.5</c>.
</summary>
</member>
<member name="F:Cake.Common.Tools.VSTest.VSTestFrameworkVersion.NET40">
<summary>
.NET Framework version: <c>4.0</c>.
</summary>
</member>
<member name="F:Cake.Common.Tools.VSTest.VSTestFrameworkVersion.NET45">
<summary>
.NET Framework version: <c>4.5</c>.
</summary>
</member>
<member name="T:Cake.Common.Tools.VSTest.VSTestPlatform">
<summary>
Target platform architecture to be used for test execution.
</summary>
</member>
<member name="F:Cake.Common.Tools.VSTest.VSTestPlatform.Default">
<summary>
Use default platform architecture.
</summary>
</member>
<member name="F:Cake.Common.Tools.VSTest.VSTestPlatform.x86">
<summary>
Platform architecture: <c>x86</c>.
</summary>
</member>
<member name="F:Cake.Common.Tools.VSTest.VSTestPlatform.x64">
<summary>
Platform architecture: <c>x64</c>.
</summary>
</member>
<member name="F:Cake.Common.Tools.VSTest.VSTestPlatform.ARM">
<summary>
Platform architecture: <c>ARM</c>.
</summary>
</member>
<member name="T:Cake.Common.Tools.VSTest.VSTestRunner">
<summary>
The VSTest unit test runner.
Used by Visual Studio 2012 and newer.
</summary>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.VSTest.VSTestRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="toolLocator">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestRunner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.VSTest.VSTestSettings)">
<summary>
Runs the tests in the specified assembly.
</summary>
<param name="assemblyPaths">The assembly path.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The tool name.</returns>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestRunner.GetAlternativeToolPaths(Cake.Common.Tools.VSTest.VSTestSettings)">
<summary>
Gets alternative file paths which the tool may exist in.
</summary>
<param name="settings">The settings.</param>
<returns>The default tool path.</returns>
</member>
<member name="T:Cake.Common.Tools.VSTest.VSTestSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.VSTest.VSTestRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.SettingsFile">
<summary>
Gets or sets the settings filename to be used to control additional settings such as data collectors.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.Parallel">
<summary>
Gets or sets a value indicating whether the tests are executed in parallel. By default up to all available cores on the machine may be used. The number of cores to use may be configured using a settings file.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.EnableCodeCoverage">
<summary>
Gets or sets a value indicating whether to enable data diagnostic adapter 'CodeCoverage' in the test run. Default settings are used if not specified using settings file.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.InIsolation">
<summary>
Gets or sets a value indicating whether to run tests within the vstest.console.exe process.
This makes vstest.console.exe process less likely to be stopped on an error in the tests, but tests might run slower.
Defaults to <c>false</c>.
</summary>
<value>
<c>true</c> if running in isolation; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.UseVsixExtensions">
<summary>
Gets or sets a value overriding whether VSTest will use or skip the VSIX extensions installed (if any) in the test run.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.TestAdapterPath">
<summary>
Gets or sets a value that makes VSTest use custom test adapters from a given path (if any) in the test run.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.PlatformArchitecture">
<summary>
Gets or sets the target platform architecture to be used for test execution.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.FrameworkVersion">
<summary>
Gets or sets the target .NET Framework version to be used for test execution.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.TestCaseFilter">
<summary>
Gets or sets an expression to run only tests that match, of the format <property>Operator<value>[|&<Expression>]
where Operator is one of =, != or ~ (Operator ~ has 'contains'
semantics and is applicable for string properties like DisplayName).
Parenthesis () can be used to group sub-expressions.
Examples: Priority=1
(FullyQualifiedName~Nightly|Name=MyTestMethod).
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.Diag">
<summary>
Gets or sets a path which makes VSTest write diagnosis trace logs to specified file.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.ResultsDirectory">
<summary>
Gets or sets the result directory.
Test results directory will be created in specified path if not exists.
VSTest.Console.exe flag <see href="https://docs.microsoft.com/en-us/visualstudio/test/vstest-console-options#ResultDirectory">/ResultsDirectory</see>.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.Logger">
<summary>
Gets or sets the name of your logger. Possible values:
- A blank string (or null): no logger
- "trx": Visual Studio's built-in logger
- "AppVeyor": AppVeyor's custom logger which is available only when building your solution on the AppVeyor platform
- any custom value: the name of your custom logger.
</summary>
</member>
<member name="T:Cake.Common.Tools.VSTest.VSTestSettingsExtensions">
<summary>
Contains functionality related to VSTest settings.
</summary>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestSettingsExtensions.WithoutAnyLogger(Cake.Common.Tools.VSTest.VSTestSettings)">
<summary>
Do not Log.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.VSTest.VSTestSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestSettingsExtensions.WithVisualStudioLogger(Cake.Common.Tools.VSTest.VSTestSettings)">
<summary>
Log to a trx file.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.VSTest.VSTestSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestSettingsExtensions.WithAppVeyorLogger(Cake.Common.Tools.VSTest.VSTestSettings)">
<summary>
Log to the AppVeyor logger (which is only available when building your solution on the AppVeyor platform).
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.VSTest.VSTestSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestSettingsExtensions.WithLogger(Cake.Common.Tools.VSTest.VSTestSettings,System.String)">
<summary>
Log to a custom logger.
</summary>
<param name="settings">The settings.</param>
<param name="loggerName">The name of the logger.</param>
<returns>The same <see cref="T:Cake.Common.Tools.VSTest.VSTestSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Common.Tools.VSWhere.All.VSWhereAll">
<summary>
The VSWhere tool that finds all instances regardless if they are complete.
</summary>
</member>
<member name="M:Cake.Common.Tools.VSWhere.All.VSWhereAll.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.VSWhere.All.VSWhereAll"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="toolLocator">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.VSWhere.All.VSWhereAll.All(Cake.Common.Tools.VSWhere.All.VSWhereAllSettings)">
<summary>
Finds all instances regardless if they are complete.
</summary>
<param name="settings">The settings.</param>
<returns>Installation paths for all instances.</returns>
</member>
<member name="T:Cake.Common.Tools.VSWhere.All.VSWhereAllSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.VSWhere.All.VSWhereAll"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.VSWhere.Latest.VSWhereLatest">
<summary>
The VSWhere tool that returns only the newest version and last installed.
</summary>
</member>
<member name="M:Cake.Common.Tools.VSWhere.Latest.VSWhereLatest.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.VSWhere.Latest.VSWhereLatest"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="toolLocator">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.VSWhere.Latest.VSWhereLatest.Latest(Cake.Common.Tools.VSWhere.Latest.VSWhereLatestSettings)">
<summary>
Returns only the newest version and last installed.
</summary>
<param name="settings">The settings.</param>
<returns>Installation path of the newest or last install.</returns>
</member>
<member name="T:Cake.Common.Tools.VSWhere.Latest.VSWhereLatestSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.VSWhere.Latest.VSWhereLatest"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSWhere.Latest.VSWhereLatestSettings.Products">
<summary>
Gets or sets the products to find. Defaults to Community, Professional, and Enterprise. Specify "*" by itself to search all product instances installed.
</summary>
</member>
<member name="T:Cake.Common.Tools.VSWhere.Legacy.VSWhereLegacy">
<summary>
The VSWhere tool that finds Visual Studio products.
</summary>
</member>
<member name="M:Cake.Common.Tools.VSWhere.Legacy.VSWhereLegacy.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.VSWhere.Legacy.VSWhereLegacy"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="toolLocator">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.VSWhere.Legacy.VSWhereLegacy.Legacy(Cake.Common.Tools.VSWhere.Legacy.VSWhereLegacySettings)">
<summary>
Also searches Visual Studio 2015 and older products. Information is limited.
</summary>
<param name="settings">The settings.</param>
<returns>Installation paths for all instances.</returns>
</member>
<member name="T:Cake.Common.Tools.VSWhere.Legacy.VSWhereLegacySettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.VSWhere.Legacy.VSWhereLegacy"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSWhere.Legacy.VSWhereLegacySettings.Latest">
<summary>
Gets or sets a value indicating whether to return only the newest version and last installed.
</summary>
<value><c>true</c> to find the newest version or last installed; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.VSWhere.Legacy.VSWhereLegacySettings.Requires">
<summary>
Gets the workload(s) or component(s) required when finding instances, immutable to always be empty per documentation.
</summary>
</member>
<member name="T:Cake.Common.Tools.VSWhere.Product.VSWhereProduct">
<summary>
The VSWhere tool that finds Visual Studio products.
</summary>
</member>
<member name="M:Cake.Common.Tools.VSWhere.Product.VSWhereProduct.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.VSWhere.Product.VSWhereProduct"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="toolLocator">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.VSWhere.Product.VSWhereProduct.Products(Cake.Common.Tools.VSWhere.Product.VSWhereProductSettings)">
<summary>
Finds one ore more products.
</summary>
<param name="settings">The settings.</param>
<returns>Installation paths for all instances.</returns>
</member>
<member name="T:Cake.Common.Tools.VSWhere.Product.VSWhereProductSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.VSWhere.Product.VSWhereProduct"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSWhere.Product.VSWhereProductSettings.Products">
<summary>
Gets or sets the products to find. Defaults to Community, Professional, and Enterprise. Specify "*" by itself to search all product instances installed.
</summary>
</member>
<member name="T:Cake.Common.Tools.VSWhere.VSWhereAliases">
<summary>
<para>Contains functionality related to running <see href="https://github.com/Microsoft/vswhere">VSWhere</see> tool.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the settings class:
<code>
#tool "nuget:?package=vswhere"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereAliases.VSWhereLegacy(Cake.Core.ICakeContext,System.Boolean)">
<summary>
Gets the legacy Visual Studio product installation paths.
</summary>
<param name="context">The context.</param>
<param name="latest">Get the latest version.</param>
<returns>The Visual Studio installation path.</returns>
<example>
<code>
var legacyInstallationPath = VSWhereLegacy(true);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereAliases.VSWhereLegacy(Cake.Core.ICakeContext,Cake.Common.Tools.VSWhere.Legacy.VSWhereLegacySettings)">
<summary>
Gets the legacy Visual Studio product installation paths.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<returns>The Visual Studio installation paths.</returns>
<example>
<code>
var legacyInstallationPaths = VSWhereLegacy(new VSWhereLegacySettings());
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereAliases.VSWhereLatest(Cake.Core.ICakeContext)">
<summary>
Gets the latest Visual Studio product installation path.
</summary>
<param name="context">The context.</param>
<returns>The Visual Studio installation path.</returns>
<example>
<code>
var latestInstallationPath = VSWhereLatest();
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereAliases.VSWhereLatest(Cake.Core.ICakeContext,Cake.Common.Tools.VSWhere.Latest.VSWhereLatestSettings)">
<summary>
Gets the latest Visual Studio product installation path.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<returns>The Visual Studio installation path.</returns>
<example>
<code>
var latestInstallationPath = VSWhereLatest(new VSWhereLatestSettings { Requires = "'Microsoft.Component.MSBuild" });
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereAliases.VSWhereAll(Cake.Core.ICakeContext)">
<summary>
Gets all Visual Studio product installation paths.
</summary>
<param name="context">The context.</param>
<returns>The Visual Studio installation paths.</returns>
<example>
<code>
var latestInstallationPaths = VSWhereAll();
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereAliases.VSWhereAll(Cake.Core.ICakeContext,Cake.Common.Tools.VSWhere.All.VSWhereAllSettings)">
<summary>
Gets all Visual Studio product installation paths.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<returns>The Visual Studio installation paths.</returns>
<example>
<code>
var latestInstallationPaths = VSWhereAll(new VSWhereAllSettings { Requires = "'Microsoft.Component.MSBuild" });
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereAliases.VSWhereProducts(Cake.Core.ICakeContext,System.String)">
<summary>
Gets Visual Studio product installation paths.
</summary>
<param name="context">The context.</param>
<param name="products">The products to find.</param>
<returns>The Visual Studio installation paths.</returns>
<example>
<code>
var latestInstallationPaths = VSWhereProducts("Microsoft.VisualStudio.Product.BuildTools");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereAliases.VSWhereProducts(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.VSWhere.Product.VSWhereProductSettings)">
<summary>
Gets Visual Studio product installation paths.
</summary>
<param name="context">The context.</param>
<param name="products">The products to find.</param>
<param name="settings">The settings.</param>
<returns>The Visual Studio installation paths.</returns>
<example>
<code>
var latestInstallationPaths = VSWhereProducts("Microsoft.VisualStudio.Product.BuildTools", new VSWhereProductSettings { Requires = "'Microsoft.Component.MSBuild" });
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.VSWhere.VSWhereSettings">
<summary>
Base class for all settings for VSWhere tools.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSWhere.VSWhereSettings.Requires">
<summary>
Gets or sets the workload(s) or component(s) required when finding instances.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSWhere.VSWhereSettings.Version">
<summary>
Gets or sets version range for instances to find. Example: ["15.0","16.0"] will find versions 15.*.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSWhere.VSWhereSettings.ReturnProperty">
<summary>
Gets or sets the name of the property to return. Defaults to "value" format.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSWhere.VSWhereSettings.IncludePrerelease">
<summary>
Gets or sets a value indicating whether VSWhere should include prerelease installations.
</summary>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.VSWhere.VSWhereSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.VSWhere.VSWhereTool`1">
<summary>
Base class for all VSWhere related tools.
Used to locate Visual Studio.
</summary>
<typeparam name="TSettings">The settings type.</typeparam>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereTool`1.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.VSWhere.VSWhereTool`1"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="toolLocator">The tool locator service.</param>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereTool`1.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The tool name.</returns>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereTool`1.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereTool`1.GetAlternativeToolPaths(`0)">
<summary>
Gets alternative file paths which the tool may exist in.
</summary>
<param name="settings">The settings.</param>
<returns>The default tool path.</returns>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereTool`1.RunVSWhere(`0,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Runs VSWhere with supplied arguments and parses installation paths.
</summary>
<param name="settings">The settings.</param>
<param name="builder">The process argument builder.</param>
<returns>The parsed file paths.</returns>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereTool`1.AddCommonArguments(Cake.Common.Tools.VSWhere.VSWhereSettings,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Adds common arguments to the process builder.
</summary>
<param name="settings">The settings.</param>
<param name="builder">The process argument builder.</param>
<returns>The process argument builder.</returns>
</member>
<member name="T:Cake.Common.ReleaseNotes">
<summary>
Represent release notes.
</summary>
</member>
<member name="P:Cake.Common.ReleaseNotes.Version">
<summary>
Gets the version.
</summary>
<value>The version.</value>
</member>
<member name="P:Cake.Common.ReleaseNotes.Notes">
<summary>
Gets the release notes.
</summary>
<value>The release notes.</value>
</member>
<member name="P:Cake.Common.ReleaseNotes.RawVersionLine">
<summary>
Gets the raw text of the line that <see cref="P:Cake.Common.ReleaseNotes.Version"/> was extracted from.
</summary>
<value>The raw text of the Version line.</value>
</member>
<member name="M:Cake.Common.ReleaseNotes.#ctor(System.Version,System.Collections.Generic.IEnumerable{System.String},System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.ReleaseNotes"/> class.
</summary>
<param name="version">The version.</param>
<param name="notes">The notes.</param>
<param name="rawVersionLine">The raw text of the version line.</param>
</member>
<member name="T:Cake.Common.ReleaseNotesAliases">
<summary>
Contains functionality related to release notes.
</summary>
</member>
<member name="M:Cake.Common.ReleaseNotesAliases.ParseAllReleaseNotes(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Parses all release notes.
</summary>
<param name="context">The context.</param>
<param name="filePath">The file path.</param>
<returns>All release notes.</returns>
<example>
<code>
var releaseNotes = ParseAllReleaseNotes("./ReleaseNotes.md");
foreach(var releaseNote in releaseNotes)
{
Information("Version: {0}", releaseNote.Version);
foreach(var note in releaseNote.Notes)
{
Information("\t{0}", note);
}
}
</code>
</example>
</member>
<member name="M:Cake.Common.ReleaseNotesAliases.ParseReleaseNotes(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Parses the latest release notes.
</summary>
<param name="context">The context.</param>
<param name="filePath">The file path.</param>
<returns>The latest release notes.</returns>
<example>
<code>
var releaseNote = ParseReleaseNotes("./ReleaseNotes.md");
Information("Version: {0}", releaseNote.Version);
foreach(var note in releaseNote.Notes)
{
Information("\t{0}", note);
}
</code>
</example>
</member>
<member name="T:Cake.Common.ReleaseNotesParser">
<summary>
The release notes parser.
</summary>
</member>
<member name="M:Cake.Common.ReleaseNotesParser.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.ReleaseNotesParser"/> class.
</summary>
</member>
<member name="M:Cake.Common.ReleaseNotesParser.Parse(System.String)">
<summary>
Parses all release notes.
</summary>
<param name="content">The content.</param>
<returns>All release notes.</returns>
</member>
<member name="T:Cake.Common.Security.DirectoryHash">
<summary>
Represents a calculated directory hash.
</summary>
</member>
<member name="M:Cake.Common.Security.DirectoryHash.#ctor(Cake.Core.IO.DirectoryPath,System.Byte[],Cake.Common.Security.HashAlgorithm,System.Collections.Generic.IEnumerable{Cake.Common.Security.FileHash})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Security.DirectoryHash"/> class.
</summary>
<param name="directoryPath">The directory path.</param>
<param name="hash">The computed hash.</param>
<param name="hashAlgorithm">The algorithm used.</param>
<param name="fileHashList">List of all computed <see cref="T:Cake.Common.Security.FileHash"/>.</param>
</member>
<member name="P:Cake.Common.Security.DirectoryHash.Algorithm">
<summary>
Gets the algorithm used for the hash computation.
</summary>
</member>
<member name="P:Cake.Common.Security.DirectoryHash.Path">
<summary>
Gets the <see cref="T:Cake.Core.IO.DirectoryPath"/> for the directory.
</summary>
</member>
<member name="P:Cake.Common.Security.DirectoryHash.FileHashList">
<summary>
Gets the list of <see cref="T:Cake.Common.Security.FileHash"/> for all files of the directory.
</summary>
</member>
<member name="P:Cake.Common.Security.DirectoryHash.ComputedHash">
<summary>
Gets the raw computed hash.
</summary>
</member>
<member name="M:Cake.Common.Security.DirectoryHash.ToHex">
<summary>
Convert the directory hash to a hexadecimal string.
</summary>
<returns>A hexadecimal string representing the computed hash.</returns>
</member>
<member name="T:Cake.Common.Security.DirectoryHashCalculator">
<summary>
Class for calculating a hash for a directory.
</summary>
</member>
<member name="M:Cake.Common.Security.DirectoryHashCalculator.#ctor(Cake.Core.ICakeContext,Cake.Common.Security.IHashAlgorithmBuilder)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Security.DirectoryHashCalculator"/> class.
</summary>
<param name="context">The cake context.</param>
<param name="hashAlgorithmBuilder">The hash algorithm builder.</param>
</member>
<member name="M:Cake.Common.Security.DirectoryHashCalculator.Calculate(Cake.Core.IO.DirectoryPath,System.Collections.Generic.IEnumerable{Cake.Core.IO.GlobPattern},Cake.Common.Security.HashAlgorithm)">
<summary>
Calculates the hash for a given directory.
</summary>
<param name="directoryPath">The directory path.</param>
<param name="pattern">The glob pattern to match.</param>
<param name="hashAlgorithm">The hash algorithm to use.</param>
<returns>A <see cref="T:Cake.Common.Security.DirectoryHash"/> instance representing the calculated hash.</returns>
<example>
<code>
Information(
"Cake It calculates the hashes from all cs files in all subdirectories using a MD5 hash: {0}",
CalculateDirectoryHash("C:\directoryToHash", "./**/*.cs", HashAlgorithm.MD5).ToHex());
</code>
</example>
</member>
<member name="M:Cake.Common.Security.DirectoryHashCalculator.Calculate(Cake.Core.IO.DirectoryPath,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Security.HashAlgorithm)">
<summary>
Calculates the hash for a given directory.
</summary>
<param name="directoryPath">The directory path.</param>
<param name="pattern">The glob pattern to match.</param>
<param name="hashAlgorithm">The hash algorithm to use.</param>
<returns>A <see cref="T:Cake.Common.Security.DirectoryHash"/> instance representing the calculated hash.</returns>
<example>
<code>
Information(
"Cake It calculates the hashes from all cs files in all subdirectories using a MD5 hash: {0}",
CalculateDirectoryHash("C:\directoryToHash", "./**/*.cs", HashAlgorithm.MD5).ToHex());
</code>
</example>
</member>
<member name="T:Cake.Common.Security.FileHash">
<summary>
Represents a calculated file hash.
</summary>
</member>
<member name="M:Cake.Common.Security.FileHash.#ctor(Cake.Core.IO.FilePath,System.Byte[],Cake.Common.Security.HashAlgorithm)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Security.FileHash"/> class.
</summary>
<param name="filePath">The file path.</param>
<param name="hash">The computed hash.</param>
<param name="hashAlgorithm">The algorithm used.</param>
</member>
<member name="P:Cake.Common.Security.FileHash.Algorithm">
<summary>
Gets the algorithm used for the hash computation.
</summary>
</member>
<member name="P:Cake.Common.Security.FileHash.Path">
<summary>
Gets the <see cref="T:Cake.Core.IO.FilePath"/> for the file.
</summary>
</member>
<member name="P:Cake.Common.Security.FileHash.ComputedHash">
<summary>
Gets the raw computed hash.
</summary>
</member>
<member name="M:Cake.Common.Security.FileHash.ToHex">
<summary>
Convert the file hash to a hexadecimal string.
</summary>
<returns>A hexadecimal string representing the computed hash.</returns>
</member>
<member name="T:Cake.Common.Security.FileHashCalculator">
<summary>
Represents a file hash operation.
</summary>
</member>
<member name="M:Cake.Common.Security.FileHashCalculator.#ctor(Cake.Core.IO.IFileSystem)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Security.FileHashCalculator"/> class.
</summary>
<param name="fileSystem">The file system.</param>
</member>
<member name="M:Cake.Common.Security.FileHashCalculator.#ctor(Cake.Core.IO.IFileSystem,Cake.Common.Security.IHashAlgorithmBuilder)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Security.FileHashCalculator"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="hashAlgorithmBuilder">The hash algorithm builder.</param>
</member>
<member name="M:Cake.Common.Security.FileHashCalculator.Calculate(Cake.Core.IO.FilePath,Cake.Common.Security.HashAlgorithm)">
<summary>
Calculates the hash for a file using the given algorithm.
</summary>
<param name="filePath">The file path.</param>
<param name="hashAlgorithm">The algorithm to use.</param>
<returns>A <see cref="T:Cake.Common.Security.FileHash"/> instance representing the calculated hash.</returns>
</member>
<member name="T:Cake.Common.Security.HashAlgorithm">
<summary>
The hash algorithm to use for a specific operation.
</summary>
</member>
<member name="F:Cake.Common.Security.HashAlgorithm.MD5">
<summary>
The MD5 hash algorithm.
</summary>
</member>
<member name="F:Cake.Common.Security.HashAlgorithm.SHA256">
<summary>
The SHA256 hash algorithm.
</summary>
</member>
<member name="F:Cake.Common.Security.HashAlgorithm.SHA512">
<summary>
The SHA512 hash algorithm.
</summary>
</member>
<member name="T:Cake.Common.Security.HashAlgorithmBuilder">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Security.HashAlgorithmBuilder.CreateHashAlgorithm(Cake.Common.Security.HashAlgorithm)">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Security.IHashAlgorithmBuilder">
<summary>
Creates a <see cref="T:System.Security.Cryptography.HashAlgorithm"/> instance by
<see cref="T:Cake.Common.Security.HashAlgorithm"/>.
</summary>
</member>
<member name="M:Cake.Common.Security.IHashAlgorithmBuilder.CreateHashAlgorithm(Cake.Common.Security.HashAlgorithm)">
<summary>
Return a instance of <see cref="T:System.Security.Cryptography.HashAlgorithm"/> by
<see cref="T:Cake.Common.Security.HashAlgorithm"/> enum value.
</summary>
<param name="hashAlgorithm">Algorithm enum value.</param>
<returns>A <see cref="T:System.Security.Cryptography.HashAlgorithm"/> instance.</returns>
</member>
<member name="T:Cake.Common.Security.SecurityAliases">
<summary>
Contains security related functionality, such as calculating file
hashes.
</summary>
</member>
<member name="M:Cake.Common.Security.SecurityAliases.CalculateFileHash(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Calculates the hash for a given file using the default (SHA256) algorithm.
</summary>
<param name="context">The context.</param>
<param name="filePath">The file path.</param>
<returns>A <see cref="T:Cake.Common.Security.FileHash"/> instance representing the calculated hash.</returns>
<example>
<code>
Information(
"Cake executable file SHA256 hash: {0}",
CalculateFileHash("Cake.exe").ToHex());
</code>
</example>
</member>
<member name="M:Cake.Common.Security.SecurityAliases.CalculateFileHash(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Security.HashAlgorithm)">
<summary>
Calculates the hash for a given file.
</summary>
<param name="context">The context.</param>
<param name="filePath">The file path.</param>
<param name="hashAlgorithm">The hash algorithm to use.</param>
<returns>A <see cref="T:Cake.Common.Security.FileHash"/> instance representing the calculated hash.</returns>
<example>
<code>
Information(
"Cake executable file MD5 hash: {0}",
CalculateFileHash("Cake.exe", HashAlgorithm.MD5).ToHex());
</code>
</example>
</member>
<member name="M:Cake.Common.Security.SecurityAliases.CalculateDirectoryHash(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.GlobPattern},Cake.Core.IO.DirectoryPath)">
<summary>
Calculates the hash for a given directory using the default (SHA256) algorithm.
</summary>
<param name="context">The context.</param>
<param name="directoryPath">The file path.</param>
<param name="globs">The glob pattern to match.</param>
<returns>A <see cref="T:Cake.Common.Security.DirectoryHash"/> instance representing the calculated hash.</returns>
<example>
<code>
Information(
"Cake It calculates the hashes from all cs files in all subdirectories using a SHA256 hash: {0}",
CalculateDirectoryHash("C:\directoryToHash", "./**/*.cs").ToHex());
</code>
</example>
</member>
<member name="M:Cake.Common.Security.SecurityAliases.CalculateDirectoryHash(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,System.Collections.Generic.IEnumerable{Cake.Core.IO.GlobPattern},Cake.Common.Security.HashAlgorithm)">
<summary>
Calculates the hash for a given directory.
</summary>
<param name="context">The context.</param>
<param name="directoryPath">The file path.</param>
<param name="globs">The glob pattern to match.</param>
<param name="hashAlgorithm">The hash algorithm to use.</param>
<returns>A <see cref="T:Cake.Common.Security.DirectoryHash"/> instance representing the calculated hash.</returns>
<example>
<code>
Information(
"Cake It calculates the hashes from all cs files in all subdirectories using a MD5 hash: {0}",
CalculateDirectoryHash("C:\directoryToHash", "./**/*.cs", HashAlgorithm.MD5).ToHex());
</code>
</example>
</member>
<member name="M:Cake.Common.Security.SecurityAliases.CalculateDirectoryHash(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Core.IO.DirectoryPath)">
<summary>
Calculates the hash for a given directory using the default (SHA256) algorithm.
</summary>
<param name="context">The context.</param>
<param name="directoryPath">The file path.</param>
<param name="globs">The glob pattern to match.</param>
<returns>A <see cref="T:Cake.Common.Security.DirectoryHash"/> instance representing the calculated hash.</returns>
<example>
<code>
Information(
"Cake It calculates the hashes from all cs files in all subdirectories using a SHA256 hash: {0}",
CalculateDirectoryHash("C:\directoryToHash", "./**/*.cs").ToHex());
</code>
</example>
</member>
<member name="M:Cake.Common.Security.SecurityAliases.CalculateDirectoryHash(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Security.HashAlgorithm)">
<summary>
Calculates the hash for a given directory.
</summary>
<param name="context">The context.</param>
<param name="directoryPath">The file path.</param>
<param name="globs">The glob pattern to match.</param>
<param name="hashAlgorithm">The hash algorithm to use.</param>
<returns>A <see cref="T:Cake.Common.Security.DirectoryHash"/> instance representing the calculated hash.</returns>
<example>
<code>
Information(
"Cake It calculates the hashes from all cs files in all subdirectories using a MD5 hash: {0}",
CalculateDirectoryHash("C:\directoryToHash", "./**/*.cs", HashAlgorithm.MD5).ToHex());
</code>
</example>
</member>
<member name="T:Cake.Common.Xml.XmlDtdProcessing">
<summary>
Specifies how will an XmlReader handle DTDs in the XML document.
</summary>
</member>
<member name="F:Cake.Common.Xml.XmlDtdProcessing.Prohibit">
<summary>
The XmlReader will throw an exception when it finds a 'DOCTYPE' markup.
</summary>
</member>
<member name="F:Cake.Common.Xml.XmlDtdProcessing.Ignore">
<summary>
The DTD will be ignored. Any reference to a general entity in the XML document
will cause an exception (except for the predefined entities < > & " and ').
The DocumentType node will not be reported.
</summary>
</member>
<member name="F:Cake.Common.Xml.XmlDtdProcessing.Parse">
<summary>
The DTD will be parsed and fully processed (entities expanded, default attributes added etc.)
</summary>
</member>
<member name="T:Cake.Common.Xml.XmlPeekAliases">
<summary>
Contains functionality related to XML XPath queries.
</summary>
</member>
<member name="M:Cake.Common.Xml.XmlPeekAliases.XmlPeek(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,System.String)">
<summary>
Gets the value of a target node.
</summary>
<returns>The value found at the given XPath query.</returns>
<param name="context">The context.</param>
<param name="filePath">The target file.</param>
<param name="xpath">The xpath of the node to get.</param>
<example>
<code>
string autoFacVersion = XmlPeek("./src/Cake/packages.config", "/packages/package[@id='Autofac']/@version");
</code>
</example>
</member>
<member name="M:Cake.Common.Xml.XmlPeekAliases.XmlPeek(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,System.String,Cake.Common.Xml.XmlPeekSettings)">
<summary>
Get the value of a target node.
</summary>
<returns>The value found at the given XPath query.</returns>
<param name="context">The context.</param>
<param name="filePath">The target file.</param>
<param name="xpath">The xpath of the nodes to set.</param>
<param name="settings">Additional settings to tweak Xml Peek behavior.</param>
<example>
<code>
<para>XML document:</para>
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<pastery xmlns = "https://cakebuild.net/pastery" >
<cake price="1.62" />
</pastery>
]]>
</code>
<para>XmlPeek usage:</para>
<code>
string version = XmlPeek("./pastry.xml", "/pastry:pastry/pastry:cake/@price",
new XmlPeekSettings {
Namespaces = new Dictionary<string, string> {{ "pastry", "https://cakebuild.net/pastry" }}
});
string unknown = XmlPeek("./pastry.xml", "/pastry:pastry/pastry:cake/@recipe",
new XmlPeekSettings {
Namespaces = new Dictionary<string, string> {{ "pastry", "https://cakebuild.net/pastry" }},
SuppressWarning = true
});
</code>
</example>
</member>
<member name="M:Cake.Common.Xml.XmlPeekAliases.XmlPeek(System.Xml.XmlReader,System.String,Cake.Common.Xml.XmlPeekSettings)">
<summary>
Gets the value of a target node.
</summary>
<returns>The value found at the given XPath query (or the first, if multiple eligible nodes are found).</returns>
<param name="source">The source xml to transform.</param>
<param name="xpath">The xpath of the nodes to set.</param>
<param name="settings">Additional settings to tweak Xml Peek behavior.</param>
</member>
<member name="M:Cake.Common.Xml.XmlPeekAliases.GetXmlReaderSettings(Cake.Common.Xml.XmlPeekSettings)">
<summary>
Gets a XmlReaderSettings from a XmlPeekSettings.
</summary>
<returns>The xml reader settings.</returns>
<param name="settings">Additional settings to tweak Xml Peek behavior.</param>
</member>
<member name="T:Cake.Common.Xml.XmlPeekSettings">
<summary>
Contains settings for <see cref="T:Cake.Common.Xml.XmlPeekAliases"/>.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlPeekSettings.Namespaces">
<summary>
Gets or sets namespaces to include for xpath recognition.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlPeekSettings.PreserveWhitespace">
<summary>
Gets or sets a value indicating whether to preserve white space.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlPeekSettings.SuppressWarning">
<summary>
Gets or sets a value indicating whether to suppress the xpath not found warning.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlPeekSettings.DtdProcessing">
<summary>
Gets or sets a value that determines the processing of DTDs.
</summary>
</member>
<member name="M:Cake.Common.Xml.XmlPeekSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Xml.XmlPeekSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Xml.XmlPokeAliases">
<summary>
Contains functionality related to XML XSL transformation.
</summary>
</member>
<member name="M:Cake.Common.Xml.XmlPokeAliases.XmlPoke(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,System.String,System.String)">
<summary>
Set the value of, or remove, target nodes.
</summary>
<param name="context">The context.</param>
<param name="filePath">The target file.</param>
<param name="xpath">The xpath of the nodes to set.</param>
<param name="value">The value to set too. Leave blank to remove the selected nodes.</param>
<example>
<para>
Change the <c>server</c> setting in the configuration from <c>testhost.somecompany.com</c>
to <c>productionhost.somecompany.com</c>.
</para>
<para>XML file:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="server" value="testhost.somecompany.com" />
</appSettings>
</configuration>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var file = File("test.xml");
XmlPoke(file, "/configuration/appSettings/add[@key = 'server']/@value", "productionhost.somecompany.com");
});
]]>
</code>
</example>
<example>
<para>
Modify the <c>noNamespaceSchemaLocation</c> in an XML file.
</para>
<para>XML file:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<Commands xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Path Value">
</Commands>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var file = File("test.xml");
XmlPoke(file, "/Commands/@xsi:noNamespaceSchemaLocation", "d:\\Commands.xsd", new XmlPokeSettings {
Namespaces = new Dictionary<string, string> {
{ /* Prefix */ "xsi", /* URI */ "http://www.w3.org/2001/XMLSchema-instance" }
}
});
});
]]>
</code>
</example>
<example>
<para>
Remove an app setting from a config file.
</para>
<para>XML file:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="server" value="testhost.somecompany.com" />
<add key="testing" value="true" />
</appSettings>
</configuration>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var file = File("test.xml");
XmlPoke(file, "/configuration/appSettings/add[@testing]", null);
});
]]>
</code>
</example>
<para>
Credit to NAnt for the original example.
http://nant.sourceforge.net/release/latest/help/tasks/xmlpoke.html.
</para>
</member>
<member name="M:Cake.Common.Xml.XmlPokeAliases.XmlPoke(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,System.String,System.String,Cake.Common.Xml.XmlPokeSettings)">
<summary>
Set the value of, or remove, target nodes.
</summary>
<param name="context">The context.</param>
<param name="filePath">The target file.</param>
<param name="xpath">The xpath of the nodes to set.</param>
<param name="value">The value to set too. Leave blank to remove the selected nodes.</param>
<param name="settings">Additional settings to tweak Xml Poke behavior.</param>
<example>
<para>
Change the <c>server</c> setting in the configuration from <c>testhost.somecompany.com</c>
to <c>productionhost.somecompany.com</c>.
</para>
<para>XML file:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="server" value="testhost.somecompany.com" />
</appSettings>
</configuration>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var file = File("test.xml");
XmlPoke(file, "/configuration/appSettings/add[@key = 'server']/@value", "productionhost.somecompany.com");
});
]]>
</code>
</example>
<example>
<para>
Modify the <c>noNamespaceSchemaLocation</c> in an XML file.
</para>
<para>XML file:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<Commands xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Path Value">
</Commands>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var file = File("test.xml");
XmlPoke(file, "/Commands/@xsi:noNamespaceSchemaLocation", "d:\\Commands.xsd", new XmlPokeSettings {
Namespaces = new Dictionary<string, string> {
{ /* Prefix */ "xsi", /* URI */ "http://www.w3.org/2001/XMLSchema-instance" }
}
});
});
]]>
</code>
</example>
<example>
<para>
Remove an app setting from a config file.
</para>
<para>XML file:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="server" value="testhost.somecompany.com" />
<add key="testing" value="true" />
</appSettings>
</configuration>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var file = File("test.xml");
XmlPoke(file, "/configuration/appSettings/add[@testing]", null);
});
]]>
</code>
</example>
<para>
Credit to NAnt for the original example.
http://nant.sourceforge.net/release/latest/help/tasks/xmlpoke.html.
</para>
</member>
<member name="M:Cake.Common.Xml.XmlPokeAliases.XmlPokeString(Cake.Core.ICakeContext,System.String,System.String,System.String)">
<summary>
Set the value of, or remove, target nodes.
</summary>
<param name="context">The context.</param>
<param name="sourceXml">The source xml to transform.</param>
<param name="xpath">The xpath of the nodes to set.</param>
<param name="value">The value to set too. Leave blank to remove the selected nodes.</param>
<returns>Resulting XML.</returns>
<example>
<para>
Change the <c>server</c> setting in the configuration from <c>testhost.somecompany.com</c>
to <c>productionhost.somecompany.com</c>.
</para>
<para>XML string:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="server" value="testhost.somecompany.com" />
</appSettings>
</configuration>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var result = XmlPokeString(xmlString, "/configuration/appSettings/add[@key = 'server']/@value", "productionhost.somecompany.com");
});
]]>
</code>
</example>
<example>
<para>
Modify the <c>noNamespaceSchemaLocation</c> in an XML file.
</para>
<para>XML string:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<Commands xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Path Value">
</Commands>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var result = XmlPokeString(xmlString, "/Commands/@xsi:noNamespaceSchemaLocation", "d:\\Commands.xsd", new XmlPokeSettings {
Namespaces = new Dictionary<string, string> {
{ /* Prefix */ "xsi", /* URI */ "http://www.w3.org/2001/XMLSchema-instance" }
}
});
});
]]>
</code>
</example>
<example>
<para>
Remove an app setting from a config file.
</para>
<para>XML string:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="server" value="testhost.somecompany.com" />
<add key="testing" value="true" />
</appSettings>
</configuration>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var result = XmlPokeString(xmlString, "/configuration/appSettings/add[@testing]", null);
});
]]>
</code>
</example>
<para>
Credit to NAnt for the original example.
http://nant.sourceforge.net/release/latest/help/tasks/xmlpoke.html.
</para>
</member>
<member name="M:Cake.Common.Xml.XmlPokeAliases.XmlPokeString(Cake.Core.ICakeContext,System.String,System.String,System.String,Cake.Common.Xml.XmlPokeSettings)">
<summary>
Set the value of, or remove, target nodes.
</summary>
<param name="context">The context.</param>
<param name="sourceXml">The source xml to transform.</param>
<param name="xpath">The xpath of the nodes to set.</param>
<param name="value">The value to set too. Leave blank to remove the selected nodes.</param>
<param name="settings">Additional settings to tweak Xml Poke behavior.</param>
<returns>Resulting XML.</returns>
<example>
<para>
Change the <c>server</c> setting in the configuration from <c>testhost.somecompany.com</c>
to <c>productionhost.somecompany.com</c>.
</para>
<para>XML string:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="server" value="testhost.somecompany.com" />
</appSettings>
</configuration>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var result = XmlPokeString(xmlString, "/configuration/appSettings/add[@key = 'server']/@value", "productionhost.somecompany.com");
});
]]>
</code>
</example>
<example>
<para>
Modify the <c>noNamespaceSchemaLocation</c> in an XML file.
</para>
<para>XML string:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<Commands xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Path Value">
</Commands>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var result = XmlPokeString(xmlString, "/Commands/@xsi:noNamespaceSchemaLocation", "d:\\Commands.xsd", new XmlPokeSettings {
Namespaces = new Dictionary<string, string> {
{ /* Prefix */ "xsi", /* URI */ "http://www.w3.org/2001/XMLSchema-instance" }
}
});
});
]]>
</code>
</example>
<example>
<para>
Remove an app setting from a config file.
</para>
<para>XML string:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="server" value="testhost.somecompany.com" />
<add key="testing" value="true" />
</appSettings>
</configuration>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var result = XmlPokeString(xmlString, "/configuration/appSettings/add[@testing]", null);
});
]]>
</code>
</example>
<para>
Credit to NAnt for the original example.
http://nant.sourceforge.net/release/latest/help/tasks/xmlpoke.html.
</para>
</member>
<member name="M:Cake.Common.Xml.XmlPokeAliases.XmlPoke(System.IO.Stream,System.IO.Stream,System.String,System.String,Cake.Common.Xml.XmlPokeSettings)">
<summary>
Set the value of, or remove, target nodes.
</summary>
<param name="source">The source xml to transform.</param>
<param name="destination">The destination to write too.</param>
<param name="xpath">The xpath of the nodes to set.</param>
<param name="value">The value to set too. Leave blank to remove the selected nodes.</param>
<param name="settings">Additional settings to tweak Xml Poke behavior.</param>
</member>
<member name="M:Cake.Common.Xml.XmlPokeAliases.GetXmlReaderSettings(Cake.Common.Xml.XmlPokeSettings)">
<summary>
Gets a XmlReaderSettings from a XmlPokeSettings.
</summary>
<returns>The xml reader settings.</returns>
<param name="settings">Additional settings to tweak Xml Poke behavior.</param>
</member>
<member name="M:Cake.Common.Xml.XmlPokeAliases.GetXmlWriterSettings(Cake.Common.Xml.XmlPokeSettings)">
<summary>
Gets a XmlWriterSettings from a XmlPokeSettings.
</summary>
<param name="settings">Additional settings to tweak Xml Poke behavior.</param>
<returns>The xml writer settings.</returns>
</member>
<member name="T:Cake.Common.Xml.XmlPokeSettings">
<summary>
Contains settings for <see cref="T:Cake.Common.Xml.XmlPokeAliases"/>.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlPokeSettings.PreserveWhitespace">
<summary>
Gets or sets a value indicating whether to preserve white space.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlPokeSettings.Namespaces">
<summary>
Gets or sets namespaces to include for xpath recognition.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlPokeSettings.Encoding">
<summary>
Gets or sets the type of text encoding to use.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlPokeSettings.DtdProcessing">
<summary>
Gets or sets a value that determines the processing of DTDs.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlPokeSettings.NewLineOnAttributes">
<summary>
Gets or sets a value indicating whether to write attributes on a new line.
This setting is used when <see cref="P:Cake.Common.Xml.XmlPokeSettings.Indent"/> is set to true.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlPokeSettings.IndentChars">
<summary>
Gets or sets the character string to use when indenting.
This setting is used when <see cref="P:Cake.Common.Xml.XmlPokeSettings.Indent"/> is set to true.
The default is two spaces.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlPokeSettings.Indent">
<summary>
Gets or sets a value indicating whether to indent elements.
</summary>
</member>
<member name="M:Cake.Common.Xml.XmlPokeSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Xml.XmlPokeSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Xml.XmlTransformation">
<summary>
Provides functionality to perform XML transformation.
</summary>
</member>
<member name="M:Cake.Common.Xml.XmlTransformation.Transform(System.String,System.String)">
<summary>
Performs XML XSL transformation.
</summary>
<param name="xsl">XML style sheet.</param>
<param name="xml">XML data.</param>
<returns>Transformed XML string.</returns>
</member>
<member name="M:Cake.Common.Xml.XmlTransformation.Transform(System.String,System.String,Cake.Common.Xml.XmlTransformationSettings)">
<summary>
Performs XML XSL transformation.
</summary>
<param name="xsl">XML style sheet.</param>
<param name="xml">XML data.</param>
<param name="settings">Settings for result file xml transformation.</param>
<returns>Transformed XML string.</returns>
</member>
<member name="M:Cake.Common.Xml.XmlTransformation.Transform(Cake.Core.IO.IFileSystem,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath)">
<summary>
Performs XML XSL transformation.
</summary>
<param name="fileSystem">The file system.</param>
<param name="xslPath">Path to xml style sheet.</param>
<param name="xmlPath">Path xml data.</param>
<param name="resultPath">Transformation result path.</param>
</member>
<member name="M:Cake.Common.Xml.XmlTransformation.Transform(Cake.Core.IO.IFileSystem,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Common.Xml.XmlTransformationSettings)">
<summary>
Performs XML XSL transformation.
</summary>
<param name="fileSystem">The file system.</param>
<param name="xslPath">Path to xml style sheet.</param>
<param name="xmlPath">Path xml data.</param>
<param name="resultPath">Transformation result path.</param>
<param name="settings">Settings for result file xml transformation.</param>
</member>
<member name="M:Cake.Common.Xml.XmlTransformation.Transform(System.IO.TextReader,System.IO.TextReader,System.IO.Stream,System.Xml.XmlWriterSettings)">
<summary>
Performs XML XSL transformation.
</summary>
<param name="xsl">XML style sheet.</param>
<param name="xml">XML data.</param>
<param name="result">Transformation result.</param>
<param name="settings">Optional settings for result file xml writer.</param>
</member>
<member name="M:Cake.Common.Xml.XmlTransformation.Transform(System.Xml.XmlReader,System.Xml.XmlReader,System.Xml.XmlWriter)">
<summary>
Performs XML XSL transformation.
</summary>
<param name="xsl">XML style sheet.</param>
<param name="xml">XML data.</param>
<param name="result">Transformation result.</param>
</member>
<member name="T:Cake.Common.Xml.XmlTransformationAlias">
<summary>
Contains functionality related to XML XSL transformation.
</summary>
</member>
<member name="M:Cake.Common.Xml.XmlTransformationAlias.XmlTransform(Cake.Core.ICakeContext,System.String,System.String)">
<summary>
Performs XML XSL transformation.
</summary>
<param name="context">The context.</param>
<param name="xsl">XML style sheet.</param>
<param name="xml">XML data.</param>
<returns>Transformed XML string.</returns>
<example>
<code>
<para>This example code will convert xml to a new xml structure using XmlTransform alias.</para>
<![CDATA[
string xsl = @"<xsl:stylesheet version=""1.0"" xmlns:xsl=""http://www.w3.org/1999/XSL/Transform"">
<xsl:output method=""xml"" omit-xml-declaration=""yes"" />
<xsl:template match=""/"">
<xsl:for-each select=""pastery/cake"" >
<price><xsl:value-of select=""@price""/></price>
</xsl:for-each>
</xsl:template>
</xsl:stylesheet>";
string xml = @"<?xml version=""1.0"" encoding=""UTF-8""?>
<pastery>
<cake price=""1.62"" />
</pastery>";
var priceTag = XmlTransform(xsl, xml);
]]>
</code>
<para>Result:</para>
<code>
<![CDATA[<price>1.62</price>]]>
</code>
</example>
</member>
<member name="M:Cake.Common.Xml.XmlTransformationAlias.XmlTransform(Cake.Core.ICakeContext,System.String,System.String,Cake.Common.Xml.XmlTransformationSettings)">
<summary>
Performs XML XSL transformation.
</summary>
<param name="context">The context.</param>
<param name="xsl">XML style sheet.</param>
<param name="xml">XML data.</param>
<param name="settings">Optional settings for result file xml writer.</param>
<returns>Transformed XML string.</returns>
<example>
<code>
<para>This example code will convert specific part of xml to plaintext using XmlTransform alias.</para>
<![CDATA[string xsl = @"<xsl:stylesheet version=""1.0"" xmlns:xsl=""http://www.w3.org/1999/XSL/Transform"">
<xsl:output method=""text"" omit-xml-declaration=""yes"" indent=""no""/>
<xsl:strip-space elements=""*""/>
<xsl:template match=""pastery/cake""><xsl:value-of select=""@price""/></xsl:template>
</xsl:stylesheet>";
string xml = @"<?xml version=""1.0"" encoding=""UTF-8""?>
<pastery>
<cake price=""1.62"" />
</pastery>";
var text = XmlTransform(xsl, xml, new XmlTransformationSettings {
ConformanceLevel = System.Xml.ConformanceLevel.Fragment, Encoding = Encoding.ASCII });
]]>
</code>
</example>
</member>
<member name="M:Cake.Common.Xml.XmlTransformationAlias.XmlTransform(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath)">
<summary>
Performs XML XSL transformation.
</summary>
<param name="context">The context.</param>
<param name="xslPath">Path to xml style sheet.</param>
<param name="xmlPath">Path xml data.</param>
<param name="resultPath">Transformation result path, will overwrite if exists.</param>
<example>
<code>
<para>This example code will convert the Cake nuspec into html using the XmlTransform alias.</para>
<para>XML stylesheet:</para>
<![CDATA[
<?xml version="1.0" ?>
<xsl:stylesheet
version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:p="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd"
exclude-result-prefixes="p"
>
<xsl:output method="xml" indent="yes" omit-xml-declaration="yes" />
<xsl:template match="/">
<html lang="en" class="static">
<head>
<title>
<xsl:for-each select="package/p:metadata">
<xsl:value-of select="p:id"/>
</xsl:for-each>
</title>
</head>
<body>
<xsl:for-each select="package/p:metadata">
<h1>
<xsl:value-of select="p:id"/>
</h1>
<h2>Description</h2>
<i><xsl:value-of select="p:description"/></i>
</xsl:for-each>
<h3>Files</h3>
<ul>
<xsl:for-each select="package/files/file" >
<li><xsl:value-of select="@src"/></li>
</xsl:for-each>
</ul>
</body>
</html>
</xsl:template>
</xsl:stylesheet>
]]>
</code>
<para>XmlTransform usage:</para>
<code>
XmlTransform("./nuspec.xsl", "./nuspec/Cake.nuspec", "./Cake.htm");
</code>
</example>
</member>
<member name="M:Cake.Common.Xml.XmlTransformationAlias.XmlTransform(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Common.Xml.XmlTransformationSettings)">
<summary>
Performs XML XSL transformation.
</summary>
<param name="context">The context.</param>
<param name="xslPath">Path to xml style sheet.</param>
<param name="xmlPath">Path xml data.</param>
<param name="resultPath">Transformation result path.</param>
<param name="settings">Optional settings for result file xml writer.</param>
<example>
<code>
<para>This example code will convert the Cake nuspec into html using the XmlTransform alias,
specifying that result should be indented and using Unicode encoding.</para>
<para>XML stylesheet:</para>
<![CDATA[
<?xml version="1.0" ?>
<xsl:stylesheet
version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:p="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd"
exclude-result-prefixes="p"
>
<xsl:output method="xml" indent="yes" omit-xml-declaration="yes" />
<xsl:template match="/">
<html lang="en" class="static">
<head>
<title>
<xsl:for-each select="package/p:metadata">
<xsl:value-of select="p:id"/>
</xsl:for-each>
</title>
</head>
<body>
<xsl:for-each select="package/p:metadata">
<h1>
<xsl:value-of select="p:id"/>
</h1>
<h2>Description</h2>
<i><xsl:value-of select="p:description"/></i>
</xsl:for-each>
<h3>Files</h3>
<ul>
<xsl:for-each select="package/files/file" >
<li><xsl:value-of select="@src"/></li>
</xsl:for-each>
</ul>
</body>
</html>
</xsl:template>
</xsl:stylesheet>
]]>
</code>
<para>XmlTransform usage:</para>
<code>
XmlTransform("./nuspec.xsl", "./nuspec/Cake.nuspec", "./Cake.htm",
new XmlTransformationSettings { Indent = true, Encoding = Encoding.Unicode});
</code>
</example>
</member>
<member name="T:Cake.Common.Xml.XmlTransformationSettings">
<summary>
Contains settings for <see cref="T:Cake.Common.Xml.XmlTransformation"/>.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.Overwrite">
<summary>
Gets or sets a value indicating whether overwriting existing file is permitted.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.CheckCharacters">
<summary>
Gets or sets a value indicating whether the XML writer should check to ensure that all characters in the document conform to the "2.2 Characters" section of the W3C XML 1.0 Recommendation.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.ConformanceLevel">
<summary>
Gets or sets a value indicating level of conformance that the XmlWriter checks the XML output for.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.DoNotEscapeUriAttributes">
<summary>
Gets or sets a value indicating whether the XmlWriter does not escape URI attributes.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.Encoding">
<summary>
Gets or sets the type of text encoding to use.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.Indent">
<summary>
Gets or sets a value indicating whether to indent elements.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.IndentChars">
<summary>
Gets or sets the character string to use when indenting. This setting is used when the Indent property is set to true.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.NamespaceHandling">
<summary>
Gets or sets a value that indicates whether the XmlWriter should remove duplicate namespace declarations when writing XML content. The default behavior is for the writer to output all namespace declarations that are present in the writer's namespace resolver.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.NewLineChars">
<summary>
Gets or sets the character string to use for line breaks.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.NewLineHandling">
<summary>
Gets or sets a value indicating whether to normalize line breaks in the output.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.NewLineOnAttributes">
<summary>
Gets or sets a value indicating whether to write attributes on a new line.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.OmitXmlDeclaration">
<summary>
Gets or sets a value indicating whether to omit an XML declaration.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.WriteEndDocumentOnClose">
<summary>
Gets or sets a value indicating whether the XmlWriter will add closing tags to all unclosed element tags when the Close method is called.
</summary>
</member>
<member name="M:Cake.Common.Xml.XmlTransformationSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Xml.XmlTransformationSettings"/> class.
</summary>
</member>
</members>
</doc>
md5: EE74AD8B08CCF8B94A63D7BF29755566 | sha1: E3838675F98A847132A4183FBB450721B794760E | sha256: 930C3A8E204E41227EB137178FF59BF91EC923688690FE862A597528B22D7C48 | sha512: 4C881BD393B98013C852A649F311C176BE8DD39DA1C05C15BF96CA7D54EF52D4E6D4F17A124C1BCDFC40F29EC8B6769872A5E4F6A10D731D164DCD999987FFE0
<?xml version="1.0"?>
<doc>
<assembly>
<name>Cake.Core</name>
</assembly>
<members>
<member name="T:Cake.Core.Annotations.CakeAliasAttribute">
<summary>
An attribute used to mark script aliases.
</summary>
</member>
<member name="T:Cake.Core.Annotations.CakeAliasCategoryAttribute">
<summary>
An attribute used for documentation of alias methods/properties.
</summary>
</member>
<member name="P:Cake.Core.Annotations.CakeAliasCategoryAttribute.Name">
<summary>
Gets the category name.
</summary>
<value>The category name.</value>
</member>
<member name="M:Cake.Core.Annotations.CakeAliasCategoryAttribute.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Annotations.CakeAliasCategoryAttribute"/> class.
</summary>
<param name="name">The category name.</param>
</member>
<member name="T:Cake.Core.Annotations.CakeMethodAliasAttribute">
<summary>
An attribute used to mark script method aliases.
</summary>
</member>
<member name="T:Cake.Core.Annotations.CakeModuleAttribute">
<summary>
An attribute used to identify a module implementation in an assembly.
</summary>
</member>
<member name="P:Cake.Core.Annotations.CakeModuleAttribute.ModuleType">
<summary>
Gets the module type.
</summary>
<value>The module type.</value>
</member>
<member name="M:Cake.Core.Annotations.CakeModuleAttribute.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Annotations.CakeModuleAttribute"/> class.
</summary>
<param name="moduleType">The module type.</param>
</member>
<member name="T:Cake.Core.Annotations.CakeNamespaceImportAttribute">
<summary>
An attribute used to hint Cake about additional namespaces that need
to be imported for an alias to work. This attribute can mark an
extension method, the extension method class, or the assembly to provide a global set of imports.
</summary>
</member>
<member name="P:Cake.Core.Annotations.CakeNamespaceImportAttribute.Namespace">
<summary>
Gets the namespace.
</summary>
<value>The namespace.</value>
</member>
<member name="M:Cake.Core.Annotations.CakeNamespaceImportAttribute.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Annotations.CakeNamespaceImportAttribute"/> class.
</summary>
<param name="namespace">The namespace.</param>
</member>
<member name="T:Cake.Core.Annotations.CakePropertyAliasAttribute">
<summary>
An attribute used to mark script property aliases.
</summary>
</member>
<member name="P:Cake.Core.Annotations.CakePropertyAliasAttribute.Cache">
<summary>
Gets or sets a value indicating whether the result of the property alias method should be cached.
Indicates .
</summary>
<value>
<c>true</c> if cache; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Core.Annotations.NamespaceDoc">
<summary>
This namespace contain attributes used by
the Cake engine and addins.
</summary>
</member>
<member name="T:Cake.Core.CakeArguments">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeArguments.#ctor(System.Linq.ILookup{System.String,System.String})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeArguments"/> class.
</summary>
<param name="arguments">The arguments.</param>
</member>
<member name="M:Cake.Core.CakeArguments.HasArgument(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeArguments.GetArguments(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeArguments.GetArguments">
<inheritdoc/>
</member>
<member name="T:Cake.Core.CakeConsole">
<summary>
The default console implementation.
</summary>
</member>
<member name="P:Cake.Core.CakeConsole.ForegroundColor">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeConsole.BackgroundColor">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeConsole.SupportAnsiEscapeCodes">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeConsole.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeConsole"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Core.CakeConsole.Write(System.String,System.Object[])">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeConsole.WriteLine(System.String,System.Object[])">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeConsole.WriteError(System.String,System.Object[])">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeConsole.WriteErrorLine(System.String,System.Object[])">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeConsole.ResetColor">
<inheritdoc/>
</member>
<member name="T:Cake.Core.CakeContext">
<summary>
Implementation of <see cref="T:Cake.Core.ICakeContext"/>.
</summary>
</member>
<member name="M:Cake.Core.CakeContext.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IGlobber,Cake.Core.Diagnostics.ICakeLog,Cake.Core.ICakeArguments,Cake.Core.IO.IProcessRunner,Cake.Core.IO.IRegistry,Cake.Core.Tooling.IToolLocator,Cake.Core.ICakeDataService,Cake.Core.Configuration.ICakeConfiguration)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeContext"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="globber">The globber.</param>
<param name="log">The log.</param>
<param name="arguments">The arguments.</param>
<param name="processRunner">The process runner.</param>
<param name="registry">The registry.</param>
<param name="tools">The tool locator.</param>
<param name="data">The data service.</param>
<param name="configuration">The cake configuration.</param>
</member>
<member name="P:Cake.Core.CakeContext.FileSystem">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContext.Environment">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContext.Globber">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContext.Log">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContext.Arguments">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContext.ProcessRunner">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContext.Registry">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContext.Tools">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContext.Data">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContext.Configuration">
<inheritdoc/>
</member>
<member name="T:Cake.Core.CakeContextAdapter">
<summary>
Adapter to ensure correct conversion of Cake Context in derived classes.
</summary>
</member>
<member name="M:Cake.Core.CakeContextAdapter.#ctor(Cake.Core.ICakeContext)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeContextAdapter"/> class.
</summary>
<param name="context">The Cake Context.</param>
</member>
<member name="P:Cake.Core.CakeContextAdapter.FileSystem">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContextAdapter.Environment">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContextAdapter.Globber">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContextAdapter.Log">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContextAdapter.Arguments">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContextAdapter.ProcessRunner">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContextAdapter.Registry">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContextAdapter.Tools">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContextAdapter.Data">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContextAdapter.Configuration">
<inheritdoc/>
</member>
<member name="T:Cake.Core.CakeDataService">
<summary>
Implementation of <see cref="T:Cake.Core.ICakeDataService"/>.
</summary>
</member>
<member name="M:Cake.Core.CakeDataService.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeDataService"/> class.
</summary>
</member>
<member name="M:Cake.Core.CakeDataService.Get``1">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeDataService.Add``1(``0)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.CakeEngine">
<summary>
The Cake execution engine.
</summary>
</member>
<member name="P:Cake.Core.CakeEngine.Tasks">
<inheritdoc/>
</member>
<member name="E:Cake.Core.CakeEngine.Setup">
<inheritdoc/>
</member>
<member name="E:Cake.Core.CakeEngine.Teardown">
<inheritdoc/>
</member>
<member name="E:Cake.Core.CakeEngine.TaskSetup">
<inheritdoc/>
</member>
<member name="E:Cake.Core.CakeEngine.TaskTeardown">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEngine.#ctor(Cake.Core.ICakeDataService,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeEngine"/> class.
</summary>
<param name="data">The data service.</param>
<param name="log">The log.</param>
</member>
<member name="M:Cake.Core.CakeEngine.RegisterTask(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEngine.RegisterSetupAction(System.Action{Cake.Core.ISetupContext})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEngine.RegisterSetupAction``1(System.Func{Cake.Core.ISetupContext,``0})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEngine.RegisterTeardownAction(System.Action{Cake.Core.ITeardownContext})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEngine.RegisterTeardownAction``1(System.Action{Cake.Core.ITeardownContext,``0})">
<inheritdoc/>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.CakeEngine.RegisterTaskSetupAction(System.Action{Cake.Core.ITaskSetupContext})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEngine.RegisterTaskSetupAction``1(System.Action{Cake.Core.ITaskSetupContext,``0})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEngine.RegisterTaskTeardownAction(System.Action{Cake.Core.ITaskTeardownContext})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEngine.RegisterTaskTeardownAction``1(System.Action{Cake.Core.ITaskTeardownContext,``0})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEngine.RunTargetAsync(Cake.Core.ICakeContext,Cake.Core.IExecutionStrategy,Cake.Core.ExecutionSettings)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.CakeEnvironment">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeEnvironment.WorkingDirectory">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeEnvironment.ApplicationRoot">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeEnvironment.Platform">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeEnvironment.Runtime">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEnvironment.#ctor(Cake.Core.ICakePlatform,Cake.Core.ICakeRuntime)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeEnvironment" /> class.
</summary>
<param name="platform">The platform.</param>
<param name="runtime">The runtime.</param>
</member>
<member name="M:Cake.Core.CakeEnvironment.GetSpecialPath(Cake.Core.IO.SpecialPath)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEnvironment.GetEnvironmentVariable(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEnvironment.GetEnvironmentVariables">
<inheritdoc/>
</member>
<member name="T:Cake.Core.CakeEnvironmentExtensions">
<summary>
Contains extensions for <see cref="T:Cake.Core.ICakeEnvironment"/>.
</summary>
</member>
<member name="M:Cake.Core.CakeEnvironmentExtensions.ExpandEnvironmentVariables(Cake.Core.ICakeEnvironment,System.String)">
<summary>
Expands the environment variables in the provided text.
</summary>
<example>
<code>
var expanded = environment.ExpandEnvironmentVariables("%APPDATA%/foo");
</code>
</example>
<param name="environment">The environment.</param>
<param name="text">A string containing the names of zero or more environment variables.</param>
<returns>A string with each environment variable replaced by its value.</returns>
</member>
<member name="T:Cake.Core.CakeException">
<summary>
Represent errors that occur during script execution.
</summary>
</member>
<member name="P:Cake.Core.CakeException.ExitCode">
<summary>
Gets custom exit code.
</summary>
</member>
<member name="M:Cake.Core.CakeException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeException"/> class.
</summary>
</member>
<member name="M:Cake.Core.CakeException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeException"/> class.
</summary>
<param name="message">The message that describes the error.</param>
</member>
<member name="M:Cake.Core.CakeException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeException"/> class.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param>
</member>
<member name="M:Cake.Core.CakeException.#ctor(System.Int32)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeException"/> class.
</summary>
<param name="exitCode">Exit code.</param>
</member>
<member name="M:Cake.Core.CakeException.#ctor(System.Int32,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeException"/> class.
</summary>
<param name="exitCode">Custom exit code.</param>
<param name="message">The error message that explains the reason for the exception.</param>
</member>
<member name="M:Cake.Core.CakeException.#ctor(System.Int32,System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeException"/> class.
</summary>
<param name="exitCode">Custom exit code.</param>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param>
</member>
<member name="M:Cake.Core.CakeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
</member>
<member name="T:Cake.Core.CakePlatform">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakePlatform.Family">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakePlatform.Is64Bit">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakePlatform.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakePlatform"/> class.
</summary>
</member>
<member name="T:Cake.Core.CakeReport">
<summary>
Contains information about tasks that were executed in a script.
</summary>
</member>
<member name="P:Cake.Core.CakeReport.IsEmpty">
<summary>
Gets a value indicating whether the report is empty.
</summary>
<value>
<c>true</c> if this report is empty; otherwise, <c>false</c>.
</value>
</member>
<member name="M:Cake.Core.CakeReport.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeReport"/> class.
</summary>
</member>
<member name="M:Cake.Core.CakeReport.Add(System.String,System.TimeSpan)">
<summary>
Adds a task result to the report.
</summary>
<param name="task">The task.</param>
<param name="span">The span.</param>
</member>
<member name="M:Cake.Core.CakeReport.Add(System.String,Cake.Core.CakeReportEntryCategory,System.TimeSpan)">
<summary>
Adds a task result to the report with a specific category.
</summary>
<param name="task">The task.</param>
<param name="category">The category.</param>
<param name="span">The span.</param>
</member>
<member name="M:Cake.Core.CakeReport.AddSkipped(System.String)">
<summary>
Adds a skipped task result to the report.
</summary>
<param name="task">The task.</param>
</member>
<member name="M:Cake.Core.CakeReport.AddFailed(System.String,System.TimeSpan)">
<summary>
Adds a failed task result to the report.
</summary>
<param name="task">The task.</param>
<param name="span">The span.</param>
</member>
<member name="M:Cake.Core.CakeReport.AddDelegated(System.String,System.TimeSpan)">
<summary>
Adds a delegated task result to the report.
</summary>
<param name="task">The task.</param>
<param name="span">The span.</param>
</member>
<member name="M:Cake.Core.CakeReport.Add(System.String,Cake.Core.CakeReportEntryCategory,System.TimeSpan,Cake.Core.CakeTaskExecutionStatus)">
<summary>
Adds a task result to the report.
</summary>
<param name="task">The task.</param>
<param name="category">The category.</param>
<param name="span">The span.</param>
<param name="executionStatus">The execution status.</param>
</member>
<member name="M:Cake.Core.CakeReport.GetEnumerator">
<summary>
Returns an enumerator that iterates through the collection.
</summary>
<returns>
A <see cref="T:System.Collections.Generic.IEnumerator`1" /> that can be used to iterate through the collection.
</returns>
</member>
<member name="M:Cake.Core.CakeReport.System#Collections#IEnumerable#GetEnumerator">
<summary>
Returns an enumerator that iterates through a collection.
</summary>
<returns>
An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.
</returns>
</member>
<member name="T:Cake.Core.CakeReportEntry">
<summary>
Represents an entry in a <see cref="T:Cake.Core.CakeReport"/>.
</summary>
</member>
<member name="P:Cake.Core.CakeReportEntry.TaskName">
<summary>
Gets the task name.
</summary>
<value>The name.</value>
</member>
<member name="P:Cake.Core.CakeReportEntry.Category">
<summary>
Gets the task category.
</summary>
<value>The category.</value>
</member>
<member name="P:Cake.Core.CakeReportEntry.Duration">
<summary>
Gets the duration the task ran for.
</summary>
<value>The duration the task ran for.</value>
</member>
<member name="P:Cake.Core.CakeReportEntry.ExecutionStatus">
<summary>
Gets the task execution status.
</summary>
<value>The execution status.</value>
</member>
<member name="M:Cake.Core.CakeReportEntry.#ctor(System.String,Cake.Core.CakeReportEntryCategory,System.TimeSpan)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeReportEntry"/> class.
</summary>
<param name="taskName">The name of the task.</param>
<param name="category">The task category.</param>
<param name="duration">The duration.</param>
</member>
<member name="M:Cake.Core.CakeReportEntry.#ctor(System.String,Cake.Core.CakeReportEntryCategory,System.TimeSpan,Cake.Core.CakeTaskExecutionStatus)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeReportEntry"/> class.
</summary>
<param name="taskName">The name of the task.</param>
<param name="category">The task category.</param>
<param name="duration">The duration.</param>
<param name="executionStatus">The execution status.</param>
</member>
<member name="T:Cake.Core.CakeReportEntryCategory">
<summary>
Represents a Cake report entry category.
</summary>
</member>
<member name="F:Cake.Core.CakeReportEntryCategory.Task">
<summary>
Represents a normal task.
</summary>
</member>
<member name="F:Cake.Core.CakeReportEntryCategory.Setup">
<summary>
Represent a setup task.
</summary>
</member>
<member name="F:Cake.Core.CakeReportEntryCategory.Teardown">
<summary>
Represent a teardown task.
</summary>
</member>
<member name="T:Cake.Core.CakeReportPrinter">
<summary>
The default report printer.
</summary>
</member>
<member name="M:Cake.Core.CakeReportPrinter.#ctor(Cake.Core.IConsole,Cake.Core.ICakeContext)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeReportPrinter"/> class.
</summary>
<param name="console">The console.</param>
<param name="context">The context.</param>
</member>
<member name="M:Cake.Core.CakeReportPrinter.Write(Cake.Core.CakeReport)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.CakeRuntime">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeRuntime.BuiltFramework">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeRuntime.Runtime">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeRuntime.CakeVersion">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeRuntime.IsCoreClr">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeRuntime.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeRuntime"/> class.
</summary>
</member>
<member name="T:Cake.Core.CakeTask">
<summary>
A <see cref="T:Cake.Core.CakeTask"/> represents a unit of work.
</summary>
</member>
<member name="P:Cake.Core.CakeTask.Name">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeTask.Description">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeTask.Dependencies">
<summary>
Gets the task's dependencies.
</summary>
<value>The task's dependencies.</value>
</member>
<member name="P:Cake.Core.CakeTask.Dependees">
<summary>
Gets the tasks that the task want to be a dependency of.
</summary>
<value>The tasks that the task want to be a dependency of.</value>
</member>
<member name="P:Cake.Core.CakeTask.Criterias">
<summary>
Gets the task's criterias.
</summary>
<value>The task's criterias.</value>
</member>
<member name="P:Cake.Core.CakeTask.ErrorHandler">
<summary>
Gets or sets the error handler.
</summary>
<value>The error handler.</value>
</member>
<member name="P:Cake.Core.CakeTask.ErrorReporter">
<summary>
Gets or sets the error reporter.
</summary>
</member>
<member name="P:Cake.Core.CakeTask.FinallyHandler">
<summary>
Gets or sets the finally handler.
</summary>
</member>
<member name="P:Cake.Core.CakeTask.Actions">
<summary>
Gets the task's actions.
</summary>
<value>The task's actions.</value>
</member>
<member name="P:Cake.Core.CakeTask.DelayedActions">
<summary>
Gets the task's actions that are run at execution time to additionally populate <see cref="P:Cake.Core.CakeTask.Actions"/>.
</summary>
<value>The task's delayed actions actions.</value>
</member>
<member name="P:Cake.Core.CakeTask.DeferExceptions">
<summary>
Gets or sets a value indicating whether gets the task's state if it will defer exceptions until the end of the task.
</summary>
<value>The task's defer exceptions state.</value>
</member>
<member name="M:Cake.Core.CakeTask.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeTask"/> class.
</summary>
<param name="name">The name of the task.</param>
</member>
<member name="M:Cake.Core.CakeTask.Execute(Cake.Core.ICakeContext)">
<summary>
Executes the task using the specified context.
</summary>
<param name="context">The context.</param>
<returns>Returned Task.</returns>
</member>
<member name="T:Cake.Core.CakeTaskBuilderExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.CakeTaskBuilder"/>.
</summary>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.WithCriteria(Cake.Core.CakeTaskBuilder,System.Boolean)">
<summary>
Adds a criteria that has to be fulfilled for the task to run.
</summary>
<param name="builder">The task builder.</param>
<param name="criteria">The criteria.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.WithCriteria(Cake.Core.CakeTaskBuilder,System.Boolean,System.String)">
<summary>
Adds a criteria that has to be fulfilled for the task to run.
</summary>
<param name="builder">The task builder.</param>
<param name="criteria">The criteria.</param>
<param name="message">The message to display if the task was skipped due to the provided criteria.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.WithCriteria(Cake.Core.CakeTaskBuilder,System.Func{System.Boolean})">
<summary>
Adds a criteria that has to be fulfilled for the task to run.
The criteria is evaluated when traversal of the graph occurs.
</summary>
<param name="builder">The task builder.</param>
<param name="criteria">The criteria.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.WithCriteria(Cake.Core.CakeTaskBuilder,System.Func{System.Boolean},System.String)">
<summary>
Adds a criteria that has to be fulfilled for the task to run.
The criteria is evaluated when traversal of the graph occurs.
</summary>
<param name="builder">The task builder.</param>
<param name="criteria">The criteria.</param>
<param name="message">The message to display if the task was skipped due to the provided criteria.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.WithCriteria(Cake.Core.CakeTaskBuilder,System.Func{Cake.Core.ICakeContext,System.Boolean})">
<summary>
Adds a criteria that has to be fulfilled for the task to run.
The criteria is evaluated when traversal of the graph occurs.
</summary>
<param name="builder">The task builder.</param>
<param name="criteria">The criteria.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.WithCriteria(Cake.Core.CakeTaskBuilder,System.Func{Cake.Core.ICakeContext,System.Boolean},System.String)">
<summary>
Adds a criteria that has to be fulfilled for the task to run.
The criteria is evaluated when traversal of the graph occurs.
</summary>
<param name="builder">The task builder.</param>
<param name="criteria">The criteria.</param>
<param name="message">The message to display if the task was skipped due to the provided criteria.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.WithCriteria``1(Cake.Core.CakeTaskBuilder,System.Func{``0,System.Boolean})">
<summary>
Adds a criteria that has to be fulfilled for the task to run.
The criteria is evaluated when traversal of the graph occurs.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="criteria">The criteria.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.WithCriteria``1(Cake.Core.CakeTaskBuilder,System.Func{``0,System.Boolean},System.String)">
<summary>
Adds a criteria that has to be fulfilled for the task to run.
The criteria is evaluated when traversal of the graph occurs.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="criteria">The criteria.</param>
<param name="message">The message to display if the task was skipped due to the provided criteria.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.WithCriteria``1(Cake.Core.CakeTaskBuilder,System.Func{Cake.Core.ICakeContext,``0,System.Boolean})">
<summary>
Adds a criteria that has to be fulfilled for the task to run.
The criteria is evaluated when traversal of the graph occurs.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="criteria">The criteria.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.WithCriteria``1(Cake.Core.CakeTaskBuilder,System.Func{Cake.Core.ICakeContext,``0,System.Boolean},System.String)">
<summary>
Adds a criteria that has to be fulfilled for the task to run.
The criteria is evaluated when traversal of the graph occurs.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="criteria">The criteria.</param>
<param name="message">The message to display if the task was skipped due to the provided criteria.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.IsDependentOn(Cake.Core.CakeTaskBuilder,System.String)">
<summary>
Creates a dependency between two tasks.
</summary>
<param name="builder">The task builder.</param>
<param name="name">The name of the dependent task.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.IsDependentOn(Cake.Core.CakeTaskBuilder,Cake.Core.CakeTaskBuilder)">
<summary>
Creates a dependency between two tasks.
</summary>
<param name="builder">The task builder.</param>
<param name="other">The name of the dependent task.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.IsDependeeOf(Cake.Core.CakeTaskBuilder,System.String)">
<summary>
Makes the task a dependency of another task.
</summary>
<param name="builder">The task builder.</param>
<param name="name">The name of the task the current task will be a dependency of.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DeferOnError(Cake.Core.CakeTaskBuilder)">
<summary>
Defers all exceptions until after all actions for this task have completed.
</summary>
<param name="builder">The task builder.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.ContinueOnError(Cake.Core.CakeTaskBuilder)">
<summary>
Adds an indication to the task that a thrown exception will not halt the script execution.
</summary>
<param name="builder">The task builder.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError(Cake.Core.CakeTaskBuilder,System.Action)">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError(Cake.Core.CakeTaskBuilder,System.Func{System.Threading.Tasks.Task})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError(Cake.Core.CakeTaskBuilder,System.Action{System.Exception})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError(Cake.Core.CakeTaskBuilder,System.Func{System.Exception,System.Threading.Tasks.Task})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError(Cake.Core.CakeTaskBuilder,System.Action{System.Exception,Cake.Core.ICakeContext})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError(Cake.Core.CakeTaskBuilder,System.Func{System.Exception,Cake.Core.ICakeContext,System.Threading.Tasks.Task})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError``1(Cake.Core.CakeTaskBuilder,System.Action{``0})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<typeparam name="TData">The extra data to operate with inside the error handler.</typeparam>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError``1(Cake.Core.CakeTaskBuilder,System.Func{``0,System.Threading.Tasks.Task})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<typeparam name="TData">The extra data to operate with inside the error handler.</typeparam>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError``1(Cake.Core.CakeTaskBuilder,System.Action{System.Exception,``0})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<typeparam name="TData">The extra data to operate with inside the error handler.</typeparam>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError``1(Cake.Core.CakeTaskBuilder,System.Func{System.Exception,``0,System.Threading.Tasks.Task})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<typeparam name="TData">The extra data to operate with inside the error handler.</typeparam>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError``1(Cake.Core.CakeTaskBuilder,System.Action{System.Exception,Cake.Core.ICakeContext,``0})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<typeparam name="TData">The extra data to operate with inside the error handler.</typeparam>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError``1(Cake.Core.CakeTaskBuilder,System.Func{System.Exception,Cake.Core.ICakeContext,``0,System.Threading.Tasks.Task})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<typeparam name="TData">The extra data to operate with inside the error handler.</typeparam>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Finally(Cake.Core.CakeTaskBuilder,System.Action)">
<summary>
Adds a finally handler to be executed after the task have finished executing.
</summary>
<param name="builder">The builder.</param>
<param name="finallyHandler">The finally handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Finally(Cake.Core.CakeTaskBuilder,System.Func{System.Threading.Tasks.Task})">
<summary>
Adds a finally handler to be executed after the task have finished executing.
</summary>
<param name="builder">The builder.</param>
<param name="finallyHandler">The finally handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.ReportError(Cake.Core.CakeTaskBuilder,System.Action{System.Exception})">
<summary>
Adds an error reporter for the task to be executed when an exception is thrown from the task.
This action is invoked before the error handler, but gives no opportunity to recover from the error.
</summary>
<param name="builder">The builder.</param>
<param name="errorReporter">The finally handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.ReportError(Cake.Core.CakeTaskBuilder,System.Func{System.Exception,System.Threading.Tasks.Task})">
<summary>
Adds an error reporter for the task to be executed when an exception is thrown from the task.
This action is invoked before the error handler, but gives no opportunity to recover from the error.
</summary>
<param name="builder">The builder.</param>
<param name="errorReporter">The finally handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Does(Cake.Core.CakeTaskBuilder,System.Action)">
<summary>
Adds an action to be executed when the task is invoked.
</summary>
<param name="builder">The task builder.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Does``1(Cake.Core.CakeTaskBuilder,System.Action{``0})">
<summary>
Adds an action to be executed when the task is invoked.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Does(Cake.Core.CakeTaskBuilder,System.Func{System.Threading.Tasks.Task})">
<summary>
Adds an action to be executed when the task is invoked.
</summary>
<param name="builder">The task builder.</param>
<param name="func">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Does(Cake.Core.CakeTaskBuilder,System.Action{Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed when the task is invoked.
</summary>
<param name="builder">The task builder.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Does(Cake.Core.CakeTaskBuilder,System.Func{Cake.Core.ICakeContext,System.Threading.Tasks.Task})">
<summary>
Adds an action to be executed when the task is invoked.
</summary>
<param name="builder">The task builder.</param>
<param name="func">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Does``1(Cake.Core.CakeTaskBuilder,System.Func{``0,System.Threading.Tasks.Task})">
<summary>
Adds an action to be executed when the task is invoked.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="func">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Does``1(Cake.Core.CakeTaskBuilder,System.Action{Cake.Core.ICakeContext,``0})">
<summary>
Adds an action to be executed when the task is invoked.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Does``1(Cake.Core.CakeTaskBuilder,System.Func{Cake.Core.ICakeContext,``0,System.Threading.Tasks.Task})">
<summary>
Adds an action to be executed when the task is invoked.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="func">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``1(Cake.Core.CakeTaskBuilder,System.Collections.Generic.IEnumerable{``0},System.Action{``0})">
<summary>
Adds an action to be executed foreach item in the list.
</summary>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="items">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Collections.Generic.IEnumerable{``1},System.Action{``0,``1})">
<summary>
Adds an action to be executed foreach item in the list.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="items">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Collections.Generic.IEnumerable{``1},System.Action{``0,``1,Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed foreach item in the list.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="items">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``1(Cake.Core.CakeTaskBuilder,System.Collections.Generic.IEnumerable{``0},System.Action{``0,Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed foreach item in the list.
</summary>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="items">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``1(Cake.Core.CakeTaskBuilder,System.Func{System.Collections.Generic.IEnumerable{``0}},System.Action{``0})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``1(Cake.Core.CakeTaskBuilder,System.Func{Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{``0}},System.Action{``0})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{System.Collections.Generic.IEnumerable{``1}},System.Action{``0,``1})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{System.Collections.Generic.IEnumerable{``1}},System.Action{``0,``1,Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``1(Cake.Core.CakeTaskBuilder,System.Func{System.Collections.Generic.IEnumerable{``0}},System.Action{``0,Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{``1}},System.Action{``0,``1})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{``0,System.Collections.Generic.IEnumerable{``1}},System.Action{``0,``1,Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{``1}},System.Action{``0,``1,Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{``0,System.Collections.Generic.IEnumerable{``1}},System.Action{``0,``1})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{``0,System.Collections.Generic.IEnumerable{``1}},System.Action{``1,Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{``0,System.Collections.Generic.IEnumerable{``1}},System.Action{``1})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{``0,Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{``1}},System.Action{``0,``1,Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{``0,Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{``1}},System.Action{``0,``1})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{``0,Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{``1}},System.Action{``1,Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{``0,Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{``1}},System.Action{``1})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``1(Cake.Core.CakeTaskBuilder,System.Func{Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{``0}},System.Action{``0,Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Description(Cake.Core.CakeTaskBuilder,System.String)">
<summary>
Adds a description to the task.
</summary>
<param name="builder">The task builder.</param>
<param name="description">The description.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Core.CakeTaskBuilder">
<summary>
Allows configuration to be performed for a registered <see cref="T:Cake.Core.CakeTask"/>.
</summary>
</member>
<member name="P:Cake.Core.CakeTaskBuilder.Task">
<summary>
Gets a read-only representation of the task being configured.
</summary>
</member>
<member name="T:Cake.Core.CakeTaskCriteria">
<summary>
Represents Cake task criteria.
</summary>
</member>
<member name="P:Cake.Core.CakeTaskCriteria.Predicate">
<summary>
Gets the criteria predicate.
</summary>
<value>The criteria predicate.</value>
</member>
<member name="P:Cake.Core.CakeTaskCriteria.Message">
<summary>
Gets the criteria message.
</summary>
<value>The criteria message.</value>
</member>
<member name="M:Cake.Core.CakeTaskCriteria.#ctor(System.Func{Cake.Core.ICakeContext,System.Boolean},System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeTaskCriteria"/> class.
</summary>
<param name="predicate">The criteria predicate.</param>
<param name="message">The criteria message if skipped.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="predicate"/> is null.</exception>
</member>
<member name="T:Cake.Core.CakeTaskDependency">
<summary>
Represents a task dependency.
</summary>
</member>
<member name="P:Cake.Core.CakeTaskDependency.Name">
<summary>
Gets the name of the dependency.
</summary>
</member>
<member name="P:Cake.Core.CakeTaskDependency.Required">
<summary>
Gets a value indicating whether or not the dependency is required.
</summary>
</member>
<member name="M:Cake.Core.CakeTaskDependency.#ctor(System.String,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeTaskDependency"/> class.
</summary>
<param name="name">The name of the task.</param>
<param name="required">Whether or not the dependency is required.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="name"/> is null.</exception>
</member>
<member name="T:Cake.Core.CakeTaskExecutionStatus">
<summary>
The execution status of a <see cref="T:Cake.Core.CakeTask"/>.
</summary>
</member>
<member name="F:Cake.Core.CakeTaskExecutionStatus.Executed">
<summary>
The task was executed.
</summary>
</member>
<member name="F:Cake.Core.CakeTaskExecutionStatus.Delegated">
<summary>
The task delegated execution.
</summary>
</member>
<member name="F:Cake.Core.CakeTaskExecutionStatus.Skipped">
<summary>
The task was skipped.
</summary>
</member>
<member name="F:Cake.Core.CakeTaskExecutionStatus.Failed">
<summary>
The task failed.
</summary>
</member>
<member name="T:Cake.Core.CakeTaskExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.CakeTask"/>.
</summary>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.AddDependency(Cake.Core.CakeTask,System.String,System.Boolean)">
<summary>
Adds the dependency to the task's dependencies.
</summary>
<param name="task">The task.</param>
<param name="name">The name of the dependency .</param>
<param name="required">Whether or not the dependency is required.</param>
<exception cref="T:Cake.Core.CakeException">The task already has the dependency.</exception>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.AddDependee(Cake.Core.CakeTask,System.String,System.Boolean)">
<summary>
Adds the dependee to the task's dependees.
</summary>
<param name="task">The task.</param>
<param name="name">The name of the dependee.</param>
<param name="required">Whether or not the dependee is required.</param>
<exception cref="T:Cake.Core.CakeException">The task already is a dependee.</exception>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.AddCriteria(Cake.Core.CakeTask,System.Func{Cake.Core.ICakeContext,System.Boolean},System.String)">
<summary>
Adds to the task's criteria.
</summary>
<param name="task">The task.</param>
<param name="predicate">The criteria predicate.</param>
<param name="message">The criteria message if skipped.</param>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.SetErrorHandler(Cake.Core.CakeTask,System.Action{System.Exception,Cake.Core.ICakeContext})">
<summary>
Sets the task's error handler.
</summary>
<param name="task">The task.</param>
<param name="errorHandler">The error handler.</param>
<exception cref="T:Cake.Core.CakeException">There can only be one error handler per task.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="errorHandler"/> is null.</exception>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.SetErrorHandler(Cake.Core.CakeTask,System.Func{System.Exception,Cake.Core.ICakeContext,System.Threading.Tasks.Task})">
<summary>
Sets the task's error handler.
</summary>
<param name="task">The task.</param>
<param name="errorHandler">The error handler.</param>
<exception cref="T:Cake.Core.CakeException">There can only be one error handler per task.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="errorHandler"/> is null.</exception>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.SetErrorReporter(Cake.Core.CakeTask,System.Action{System.Exception})">
<summary>
Sets the task's error reporter.
</summary>
<param name="task">The task.</param>
<param name="errorReporter">The error reporter.</param>
<exception cref="T:Cake.Core.CakeException">There can only be one error reporter per task.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="errorReporter"/> is null.</exception>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.SetErrorReporter(Cake.Core.CakeTask,System.Func{System.Exception,System.Threading.Tasks.Task})">
<summary>
Sets the task's error reporter.
</summary>
<param name="task">The task.</param>
<param name="errorReporter">The error reporter.</param>
<exception cref="T:Cake.Core.CakeException">There can only be one error reporter per task.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="errorReporter"/> is null.</exception>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.SetFinallyHandler(Cake.Core.CakeTask,System.Action)">
<summary>
Sets the task's finally handler.
</summary>
<param name="task">The task.</param>
<param name="finallyHandler">The finally handler.</param>
<exception cref="T:Cake.Core.CakeException">There can only be one finally handler per task.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="finallyHandler"/> is null.</exception>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.SetFinallyHandler(Cake.Core.CakeTask,System.Func{System.Threading.Tasks.Task})">
<summary>
Sets the task's finally handler.
</summary>
<param name="task">The task.</param>
<param name="finallyHandler">The finally handler.</param>
<exception cref="T:Cake.Core.CakeException">There can only be one finally handler per task.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="finallyHandler"/> is null.</exception>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.AddAction(Cake.Core.CakeTask,System.Func{Cake.Core.ICakeContext,System.Threading.Tasks.Task})">
<summary>
Adds the action to the task's actions.
</summary>
<param name="task">The task.</param>
<param name="action">The action.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="action"/> is null.</exception>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.AddDelayedAction(Cake.Core.CakeTask,System.Action{Cake.Core.ICakeContext})">
<summary>
Adds the action to the task's delayed actions.
</summary>
<param name="task">The task.</param>
<param name="action">The action.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="action"/> is null.</exception>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.SetDeferExceptions(Cake.Core.CakeTask,System.Boolean)">
<summary>
Sets the task's defer exceptions state.
</summary>
<param name="task">The task.</param>
<param name="value">The defer exceptions state.</param>
</member>
<member name="T:Cake.Core.Composition.ICakeContainerRegistrar">
<summary>
Represents a container registry used to register types and instances with Cake.
</summary>
</member>
<member name="M:Cake.Core.Composition.ICakeContainerRegistrar.RegisterType(System.Type)">
<summary>
Registers a type with the container registry.
</summary>
<param name="type">The implementation type to register.</param>
<returns>A registration builder used to configure the registration.</returns>
</member>
<member name="M:Cake.Core.Composition.ICakeContainerRegistrar.RegisterInstance``1(``0)">
<summary>
Registers an instance with the container registry.
</summary>
<typeparam name="TImplementation">The instance's implementation type to register.</typeparam>
<param name="instance">The instance to register.</param>
<returns>A registration builder used to configure the registration.</returns>
</member>
<member name="T:Cake.Core.Composition.ICakeModule">
<summary>
Represents a module responsible for
registering types and instances.
</summary>
</member>
<member name="M:Cake.Core.Composition.ICakeModule.Register(Cake.Core.Composition.ICakeContainerRegistrar)">
<summary>
Performs custom registrations in the provided registrar.
</summary>
<param name="registrar">The container registrar.</param>
</member>
<member name="T:Cake.Core.Composition.ICakeRegistrationBuilder">
<summary>
Represents a registration builder for a container.
</summary>
</member>
<member name="M:Cake.Core.Composition.ICakeRegistrationBuilder.As(System.Type)">
<summary>
Adds a registration type to the configuration.
</summary>
<param name="type">The registration type.</param>
<returns>The same <see cref="T:Cake.Core.Composition.ICakeRegistrationBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.Composition.ICakeRegistrationBuilder.AsSelf">
<summary>
Adds a registration type that matches the implementation type.
</summary>
<returns>The same <see cref="T:Cake.Core.Composition.ICakeRegistrationBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.Composition.ICakeRegistrationBuilder.Singleton">
<summary>
Configure the component so that every dependent component
gets the same, shared instance. This is the default lifetime scope.
</summary>
<returns>The same <see cref="T:Cake.Core.Composition.ICakeRegistrationBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.Composition.ICakeRegistrationBuilder.Transient">
<summary>
Configure the component so that every dependent component
gets a new, unique instance.
</summary>
<returns>The same <see cref="T:Cake.Core.Composition.ICakeRegistrationBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Core.Composition.ContainerRegistrarExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.Composition.ICakeContainerRegistrar"/>.
</summary>
</member>
<member name="M:Cake.Core.Composition.ContainerRegistrarExtensions.RegisterType``1(Cake.Core.Composition.ICakeContainerRegistrar)">
<summary>
Registers a type with the container registrar.
</summary>
<typeparam name="TImplementation">The implementation type to register.</typeparam>
<param name="registrar">The container registrar.</param>
<returns>A registration builder used to configure the registration.</returns>
</member>
<member name="M:Cake.Core.Composition.ContainerRegistrarExtensions.As``1(Cake.Core.Composition.ICakeRegistrationBuilder)">
<summary>
Adds a registration type to an existing registration builder.
</summary>
<typeparam name="TRegistration">The registration type.</typeparam>
<param name="builder">The registration builder.</param>
<returns>The same <see cref="T:Cake.Core.Composition.ICakeRegistrationBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Core.Configuration.CakeConfiguration">
<summary>
The default implementation of the Cake configuration.
</summary>
</member>
<member name="M:Cake.Core.Configuration.CakeConfiguration.#ctor(System.Collections.Generic.IDictionary{System.String,System.String})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Configuration.CakeConfiguration"/> class.
</summary>
<param name="lookup">The initial configuration table.</param>
</member>
<member name="M:Cake.Core.Configuration.CakeConfiguration.GetValue(System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Configuration.CakeConfigurationProvider">
<summary>
Implementation of the Cake configuration provider.
</summary>
</member>
<member name="M:Cake.Core.Configuration.CakeConfigurationProvider.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Configuration.CakeConfigurationProvider"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Core.Configuration.CakeConfigurationProvider.CreateConfiguration(Cake.Core.IO.DirectoryPath,System.Collections.Generic.IDictionary{System.String,System.String})">
<summary>
Creates a configuration from the provided arguments.
</summary>
<param name="path">The directory to look for the configuration file.</param>
<param name="arguments">The arguments.</param>
<returns>The created configuration.</returns>
</member>
<member name="M:Cake.Core.Configuration.CakeConfigurationProvider.CreateConfiguration(Cake.Core.IO.DirectoryPath,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}},System.Collections.Generic.IDictionary{System.String,System.String})">
<summary>
Creates a configuration from the provided arguments.
</summary>
<param name="path">The directory to look for the configuration file.</param>
<param name="baseConfiguration">The initial base configuration.</param>
<param name="arguments">The arguments.</param>
<returns>The created configuration.</returns>
</member>
<member name="T:Cake.Core.Configuration.ICakeConfiguration">
<summary>
Represents the Cake configuration.
</summary>
</member>
<member name="M:Cake.Core.Configuration.ICakeConfiguration.GetValue(System.String)">
<summary>
Gets the value that corresponds to the specified key.
</summary>
<param name="key">The key.</param>
<returns>The value for the specified key, or <c>null</c> if key doesn't exists.</returns>
</member>
<member name="T:Cake.Core.DefaultExecutionStrategy">
<summary>
The default execution strategy.
</summary>
</member>
<member name="M:Cake.Core.DefaultExecutionStrategy.#ctor(Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.DefaultExecutionStrategy"/> class.
</summary>
<param name="log">The log.</param>
</member>
<member name="M:Cake.Core.DefaultExecutionStrategy.PerformSetup(System.Action{Cake.Core.ISetupContext},Cake.Core.ISetupContext)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.DefaultExecutionStrategy.PerformTeardown(System.Action{Cake.Core.ITeardownContext},Cake.Core.ITeardownContext)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.DefaultExecutionStrategy.ExecuteAsync(Cake.Core.CakeTask,Cake.Core.ICakeContext)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.DefaultExecutionStrategy.Skip(Cake.Core.CakeTask,Cake.Core.CakeTaskCriteria)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.DefaultExecutionStrategy.ReportErrorsAsync(System.Func{System.Exception,System.Threading.Tasks.Task},System.Exception)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.DefaultExecutionStrategy.HandleErrorsAsync(System.Func{System.Exception,Cake.Core.ICakeContext,System.Threading.Tasks.Task},System.Exception,Cake.Core.ICakeContext)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.DefaultExecutionStrategy.InvokeFinallyAsync(System.Func{System.Threading.Tasks.Task})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.DefaultExecutionStrategy.PerformTaskSetup(System.Action{Cake.Core.ITaskSetupContext},Cake.Core.ITaskSetupContext)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.DefaultExecutionStrategy.PerformTaskTeardown(System.Action{Cake.Core.ITaskTeardownContext},Cake.Core.ITaskTeardownContext)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Diagnostics.CakeBuildLog">
<summary>
A log that writes to the console.
</summary>
</member>
<member name="P:Cake.Core.Diagnostics.CakeBuildLog.Verbosity">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Diagnostics.CakeBuildLog.#ctor(Cake.Core.IConsole,Cake.Core.Diagnostics.Verbosity)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Diagnostics.CakeBuildLog" /> class.
</summary>
<param name="console">The console.</param>
<param name="verbosity">The verbosity.</param>
</member>
<member name="M:Cake.Core.Diagnostics.CakeBuildLog.Write(Cake.Core.Diagnostics.Verbosity,Cake.Core.Diagnostics.LogLevel,System.String,System.Object[])">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Diagnostics.CakeDebugger">
<summary>
The Cake debugger.
</summary>
</member>
<member name="M:Cake.Core.Diagnostics.CakeDebugger.#ctor(Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Diagnostics.CakeDebugger"/> class.
</summary>
<param name="log">The log.</param>
</member>
<member name="M:Cake.Core.Diagnostics.CakeDebugger.WaitForAttach(System.TimeSpan)">
<summary>
Waits for a debugger to attach.
</summary>
<param name="timeout">The timeout.</param>
</member>
<member name="T:Cake.Core.Diagnostics.ICakeDebugger">
<summary>
Represents a mechanism to interact with the debugger.
</summary>
</member>
<member name="M:Cake.Core.Diagnostics.ICakeDebugger.WaitForAttach(System.TimeSpan)">
<summary>
Waits for a debugger to attach to the process.
</summary>
<param name="timeout">The timeout.</param>
</member>
<member name="T:Cake.Core.Diagnostics.ICakeLog">
<summary>
Represents a log.
</summary>
</member>
<member name="P:Cake.Core.Diagnostics.ICakeLog.Verbosity">
<summary>
Gets or sets the verbosity.
</summary>
<value>The verbosity.</value>
</member>
<member name="M:Cake.Core.Diagnostics.ICakeLog.Write(Cake.Core.Diagnostics.Verbosity,Cake.Core.Diagnostics.LogLevel,System.String,System.Object[])">
<summary>
Writes the text representation of the specified array of objects to the
log using the specified verbosity, log level and format information.
</summary>
<param name="verbosity">The verbosity.</param>
<param name="level">The log level.</param>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="T:Cake.Core.Diagnostics.LogAction">
<summary>
Delegate representing lazy log action.
</summary>
<param name="actionEntry">Proxy to log.</param>
</member>
<member name="T:Cake.Core.Diagnostics.LogActionEntry">
<summary>
Delegate representing lazy log entry.
</summary>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="T:Cake.Core.Diagnostics.LogExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.Diagnostics.ICakeLog"/>.
</summary>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Error(Cake.Core.Diagnostics.ICakeLog,System.String,System.Object[])">
<summary>
Writes an error message to the log using the specified format information.
</summary>
<param name="log">The log.</param>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Error(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity,System.String,System.Object[])">
<summary>
Writes an error message to the log using the specified verbosity and format information.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Error(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes an error message to the log using the specified verbosity and log message action.
Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<param name="logAction">The log action.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Error(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes an error message to the log using the specified log message action.
Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
</summary>
<param name="log">The log.</param>
<param name="logAction">The log action.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Error(Cake.Core.Diagnostics.ICakeLog,System.Object)">
<summary>
Writes an error message to the log using the specified value.
</summary>
<param name="log">The log.</param>
<param name="value">The value.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Error(Cake.Core.Diagnostics.ICakeLog,System.String)">
<summary>
Writes an error message to the log using the specified string value.
</summary>
<param name="log">The log.</param>
<param name="value">The value.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Warning(Cake.Core.Diagnostics.ICakeLog,System.String,System.Object[])">
<summary>
Writes a warning message to the log using the specified format information.
</summary>
<param name="log">The log.</param>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Warning(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity,System.String,System.Object[])">
<summary>
Writes a warning message to the log using the specified verbosity and format information.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Warning(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes a warning message to the log using the specified log message action.
Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
</summary>
<param name="log">The log.</param>
<param name="logAction">The log action.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Warning(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes a warning message to the log using the specified verbosity and log message action.
Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<param name="logAction">The log action.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Warning(Cake.Core.Diagnostics.ICakeLog,System.Object)">
<summary>
Writes an warning message to the log using the specified value.
</summary>
<param name="log">The log.</param>
<param name="value">The value.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Warning(Cake.Core.Diagnostics.ICakeLog,System.String)">
<summary>
Writes an warning message to the log using the specified string value.
</summary>
<param name="log">The log.</param>
<param name="value">The value.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Information(Cake.Core.Diagnostics.ICakeLog,System.String,System.Object[])">
<summary>
Writes an informational message to the log using the specified format information.
</summary>
<param name="log">The log.</param>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Information(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity,System.String,System.Object[])">
<summary>
Writes an informational message to the log using the specified verbosity and format information.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Information(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes an informational message to the log using the specified verbosity and log message action.
Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<param name="logAction">The log action.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Information(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes an informational message to the log using the specified log message action.
Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
</summary>
<param name="log">The log.</param>
<param name="logAction">The log action.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Information(Cake.Core.Diagnostics.ICakeLog,System.Object)">
<summary>
Writes an informational message to the log using the specified value.
</summary>
<param name="log">The log.</param>
<param name="value">The value.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Information(Cake.Core.Diagnostics.ICakeLog,System.String)">
<summary>
Writes an informational message to the log using the specified string value.
</summary>
<param name="log">The log.</param>
<param name="value">The value.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Verbose(Cake.Core.Diagnostics.ICakeLog,System.String,System.Object[])">
<summary>
Writes a verbose message to the log using the specified format information.
</summary>
<param name="log">The log.</param>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Verbose(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity,System.String,System.Object[])">
<summary>
Writes a verbose message to the log using the specified verbosity and format information.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Verbose(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes a verbose message to the log using the specified log message action.
Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
</summary>
<param name="log">The log.</param>
<param name="logAction">The log action.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Verbose(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes a verbose message to the log using the specified verbosity and log message action.
Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<param name="logAction">The log action.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Verbose(Cake.Core.Diagnostics.ICakeLog,System.Object)">
<summary>
Writes a verbose message to the log using the specified value.
</summary>
<param name="log">The log.</param>
<param name="value">The value.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Verbose(Cake.Core.Diagnostics.ICakeLog,System.String)">
<summary>
Writes a verbose message to the log using the specified string value.
</summary>
<param name="log">The log.</param>
<param name="value">The value.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Debug(Cake.Core.Diagnostics.ICakeLog,System.String,System.Object[])">
<summary>
Writes a debug message to the log using the specified format information.
</summary>
<param name="log">The log.</param>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Debug(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity,System.String,System.Object[])">
<summary>
Writes a debug message to the log using the specified verbosity and format information.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Debug(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes a debug message to the log using the specified log message action.
Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
</summary>
<param name="log">The log.</param>
<param name="logAction">The log action.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Debug(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes a debug message to the log using the specified verbosity and log message action.
Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<param name="logAction">The log action.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Debug(Cake.Core.Diagnostics.ICakeLog,System.Object)">
<summary>
Writes a debug message to the log using the specified value.
</summary>
<param name="log">The log.</param>
<param name="value">The value.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Debug(Cake.Core.Diagnostics.ICakeLog,System.String)">
<summary>
Writes a debug message to the log using the specified string value.
</summary>
<param name="log">The log.</param>
<param name="value">The value.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Write(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity,Cake.Core.Diagnostics.LogLevel,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes a message to the log using the specified verbosity, log level and log action delegate.
Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<param name="level">The log level.</param>
<param name="logAction">The log action.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.QuietVerbosity(Cake.Core.Diagnostics.ICakeLog)">
<summary>
Sets the log verbosity to quiet and returns a disposable that restores the log verbosity on dispose.
</summary>
<param name="log">The log.</param>
<returns>A disposable that restores the log verbosity.</returns>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.MinimalVerbosity(Cake.Core.Diagnostics.ICakeLog)">
<summary>
Sets the log verbosity to minimal and returns a disposable that restores the log verbosity on dispose.
</summary>
<param name="log">The log.</param>
<returns>A disposable that restores the log verbosity.</returns>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.NormalVerbosity(Cake.Core.Diagnostics.ICakeLog)">
<summary>
Sets the log verbosity to normal and returns a disposable that restores the log verbosity on dispose.
</summary>
<param name="log">The log.</param>
<returns>A disposable that restores the log verbosity.</returns>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.VerboseVerbosity(Cake.Core.Diagnostics.ICakeLog)">
<summary>
Sets the log verbosity to verbose and returns a disposable that restores the log verbosity on dispose.
</summary>
<param name="log">The log.</param>
<returns>A disposable that restores the log verbosity.</returns>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.DiagnosticVerbosity(Cake.Core.Diagnostics.ICakeLog)">
<summary>
Sets the log verbosity to diagnostic and returns a disposable that restores the log verbosity on dispose.
</summary>
<param name="log">The log.</param>
<returns>A disposable that restores the log verbosity.</returns>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.WithVerbosity(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity)">
<summary>
Sets the log verbosity as specified and returns a disposable that restores the log verbosity on dispose.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<returns>A disposable that restores the log verbosity.</returns>
</member>
<member name="T:Cake.Core.Diagnostics.LogLevel">
<summary>
Represents a log level.
</summary>
</member>
<member name="F:Cake.Core.Diagnostics.LogLevel.Fatal">
<summary>
Severe errors that cause premature termination.
</summary>
</member>
<member name="F:Cake.Core.Diagnostics.LogLevel.Error">
<summary>
Other runtime errors or unexpected conditions.
</summary>
</member>
<member name="F:Cake.Core.Diagnostics.LogLevel.Warning">
<summary>
Use of deprecated APIs, poor use of API, 'almost' errors, other runtime
situations that are undesirable or unexpected, but not necessarily "wrong".
</summary>
</member>
<member name="F:Cake.Core.Diagnostics.LogLevel.Information">
<summary>
Interesting runtime events.
</summary>
</member>
<member name="F:Cake.Core.Diagnostics.LogLevel.Verbose">
<summary>
Detailed information on the flow through the system.
</summary>
</member>
<member name="F:Cake.Core.Diagnostics.LogLevel.Debug">
<summary>
Most detailed information.
</summary>
</member>
<member name="T:Cake.Core.Diagnostics.NullLog">
<summary>
A log that discards messages written to it.
</summary>
</member>
<member name="P:Cake.Core.Diagnostics.NullLog.Verbosity">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Diagnostics.NullLog.Write(Cake.Core.Diagnostics.Verbosity,Cake.Core.Diagnostics.LogLevel,System.String,System.Object[])">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Diagnostics.Verbosity">
<summary>
Represents verbosity.
</summary>
</member>
<member name="F:Cake.Core.Diagnostics.Verbosity.Quiet">
<summary>
Quiet verbosity.
</summary>
</member>
<member name="F:Cake.Core.Diagnostics.Verbosity.Minimal">
<summary>
Minimal verbosity.
</summary>
</member>
<member name="F:Cake.Core.Diagnostics.Verbosity.Normal">
<summary>
Normal verbosity.
</summary>
</member>
<member name="F:Cake.Core.Diagnostics.Verbosity.Verbose">
<summary>
Verbose verbosity.
</summary>
</member>
<member name="F:Cake.Core.Diagnostics.Verbosity.Diagnostic">
<summary>
Diagnostic verbosity.
</summary>
</member>
<member name="T:Cake.Core.Diagnostics.NamespaceDoc">
<summary>
This namespace contain types that
enable you to implement custom logging support
and interact with build logs.
</summary>
</member>
<member name="T:Cake.Core.Disposable">
<summary>
Disposable helper.
</summary>
</member>
<member name="M:Cake.Core.Disposable.Create(System.Action)">
<summary>
Creates an anonymous disposable with the specified disposer action.
</summary>
<param name="disposer">The disposer action.</param>
<returns>The anonymous disposable.</returns>
</member>
<member name="F:Cake.Core.Disposable.Empty">
<summary>
An empty disposable; does nothing.
</summary>
</member>
<member name="T:Cake.Core.ExecutionSettings">
<summary>
Contains settings related to execution of the script.
</summary>
</member>
<member name="P:Cake.Core.ExecutionSettings.Target">
<summary>
Gets the target to be executed.
</summary>
</member>
<member name="P:Cake.Core.ExecutionSettings.Exclusive">
<summary>
Gets a value indicating whether or not to use the target exclusively.
</summary>
</member>
<member name="M:Cake.Core.ExecutionSettings.SetTarget(System.String)">
<summary>
Sets the target to be executed.
</summary>
<param name="target">The target.</param>
<returns>The same <see cref="T:Cake.Core.ExecutionSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ExecutionSettings.UseExclusiveTarget">
<summary>
Whether or not to use the target exclusively.
</summary>
<returns>The same <see cref="T:Cake.Core.ExecutionSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Core.ByteArrayExtensions">
<summary>
Contains extension methods for <see cref="T:byte[]"/>.
</summary>
</member>
<member name="M:Cake.Core.ByteArrayExtensions.StartsWith(System.Byte[],System.Byte[])">
<summary>
Determines if a <see cref="T:byte[]"/> starts with a specified prefix.
</summary>
<param name="value">The value.</param>
<param name="prefix">The prefix to compare.</param>
<returns>Whether or not the <see cref="T:byte[]"/> starts with the specified prefix.</returns>
</member>
<member name="T:Cake.Core.CakeArgumentsExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.ICakeArguments"/>.
</summary>
</member>
<member name="M:Cake.Core.CakeArgumentsExtensions.GetArgument(Cake.Core.ICakeArguments,System.String)">
<summary>
Gets the value for an argument.
</summary>
<remarks>
If multiple arguments with the same name are
specified, the last argument value is returned.
</remarks>
<param name="arguments">The arguments.</param>
<param name="name">The argument name.</param>
<returns>The argument value.</returns>
</member>
<member name="T:Cake.Core.CakeConfigurationExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.Configuration.ICakeConfiguration"/>.
</summary>
</member>
<member name="M:Cake.Core.CakeConfigurationExtensions.GetToolPath(Cake.Core.Configuration.ICakeConfiguration,Cake.Core.IO.DirectoryPath,Cake.Core.ICakeEnvironment)">
<summary>
Gets the tool directory path.
</summary>
<param name="configuration">The Cake configuration.</param>
<param name="defaultRoot">The default root path.</param>
<param name="environment">The environment.</param>
<returns>The tool directory path.</returns>
</member>
<member name="M:Cake.Core.CakeConfigurationExtensions.GetModulePath(Cake.Core.Configuration.ICakeConfiguration,Cake.Core.IO.DirectoryPath,Cake.Core.ICakeEnvironment)">
<summary>
Gets the module directory path.
</summary>
<param name="configuration">The Cake configuration.</param>
<param name="defaultRoot">The default root path.</param>
<param name="environment">The environment.</param>
<returns>The module directory path.</returns>
</member>
<member name="T:Cake.Core.CakePlatformExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.ICakePlatform"/>.
</summary>
</member>
<member name="M:Cake.Core.CakePlatformExtensions.IsWindows(Cake.Core.ICakePlatform)">
<summary>
Determines whether the specified platform is a Windows platform.
</summary>
<param name="platform">The platform.</param>
<returns><c>true</c> if the platform is a Windows platform; otherwise <c>false</c>.</returns>
</member>
<member name="M:Cake.Core.CakePlatformExtensions.IsUnix(Cake.Core.ICakePlatform)">
<summary>
Determines whether the specified platform is a Unix platform.
</summary>
<param name="platform">The platform.</param>
<returns><c>true</c> if the platform is a Unix platform; otherwise <c>false</c>.</returns>
</member>
<member name="M:Cake.Core.CakePlatformExtensions.IsOSX(Cake.Core.ICakePlatform)">
<summary>
Determines whether the specified platform is a macOS platform.
</summary>
<param name="platform">The platform.</param>
<returns><c>true</c> if the platform is a macOS platform; otherwise <c>false</c>.</returns>
</member>
<member name="M:Cake.Core.CakePlatformExtensions.IsLinux(Cake.Core.ICakePlatform)">
<summary>
Determines whether the specified platform is a Linux platform.
</summary>
<param name="platform">The platform.</param>
<returns><c>true</c> if the platform is a Linux platform; otherwise <c>false</c>.</returns>
</member>
<member name="T:Cake.Core.ConsoleExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.IConsole"/>.
</summary>
</member>
<member name="M:Cake.Core.ConsoleExtensions.WriteLine(Cake.Core.IConsole)">
<summary>
Writes an empty line to the console output.
</summary>
<param name="console">The console to write to.</param>
</member>
<member name="M:Cake.Core.ConsoleExtensions.WriteErrorLine(Cake.Core.IConsole)">
<summary>
Writes an empty line to the console error output.
</summary>
<param name="console">The console to write to.</param>
</member>
<member name="T:Cake.Core.DirectoryExtensions">
<summary>
Contains extensions for <see cref="T:Cake.Core.IO.IDirectory"/>.
</summary>
</member>
<member name="M:Cake.Core.DirectoryExtensions.GetDirectories(Cake.Core.IO.IDirectory,System.String,Cake.Core.IO.SearchScope,System.Func{Cake.Core.IO.IFileSystemInfo,System.Boolean})">
<summary>
Gets directories matching the specified filter and scope, with option to exclude hidden directories.
</summary>
<param name="directory">The directory.</param>
<param name="filter">The filter.</param>
<param name="scope">The search scope.</param>
<param name="predicate">Predicate used to filter directories based on file system information.</param>
<returns>The directories matching the specified filter, scope and predicate.</returns>
</member>
<member name="M:Cake.Core.DirectoryExtensions.GetDirectories(Cake.Core.IO.IDirectory,System.String,Cake.Core.IO.SearchScope,System.Func{Cake.Core.IO.IFileSystemInfo,System.Boolean},System.Action{Cake.Core.IO.IFileSystemInfo})">
<summary>
Gets directories matching the specified filter and scope, with option to exclude hidden directories.
</summary>
<param name="directory">The directory.</param>
<param name="filter">The filter.</param>
<param name="scope">The search scope.</param>
<param name="predicate">Predicate used to filter directories based on file system information.</param>
<param name="action">Callback if directory gets filtered by <paramref name="predicate"/>.</param>
<returns>The directories matching the specified filter, scope and predicate.</returns>
</member>
<member name="M:Cake.Core.DirectoryExtensions.GetFiles(Cake.Core.IO.IDirectory,System.String,Cake.Core.IO.SearchScope,System.Func{Cake.Core.IO.IFileSystemInfo,System.Boolean})">
<summary>
Gets files matching the specified filter and scope.
</summary>
<param name="directory">The directory.</param>
<param name="filter">The filter.</param>
<param name="scope">The search scope.</param>
<param name="predicate">Predicate used to filter files based on file system information.</param>
<returns>The files matching the specified filter, scope and predicate.</returns>
</member>
<member name="M:Cake.Core.DirectoryExtensions.GetFiles(Cake.Core.IO.IDirectory,System.String,Cake.Core.IO.SearchScope,System.Func{Cake.Core.IO.IFileSystemInfo,System.Boolean},System.Action{Cake.Core.IO.IFileSystemInfo})">
<summary>
Gets files matching the specified filter and scope.
</summary>
<param name="directory">The directory.</param>
<param name="filter">The filter.</param>
<param name="scope">The search scope.</param>
<param name="predicate">Predicate used to filter files based on file system information.</param>
<param name="action">Callback if file gets filtered by <paramref name="predicate"/>.</param>
<returns>The files matching the specified filter, scope and predicate.</returns>
</member>
<member name="T:Cake.Core.EnumerableStringExtensions">
<summary>
Contains extension methods for <see cref="T:IEnumerable{String}"/>.
</summary>
</member>
<member name="M:Cake.Core.EnumerableStringExtensions.ToProcessArguments(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Performs a conversion from <see cref="T:System.Collections.Generic.IEnumerable`1"/> to <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.
</summary>
<param name="values">The text values to convert.</param>
<returns>A <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.</returns>
</member>
<member name="M:Cake.Core.EnumerableStringExtensions.ToProcessArgumentsQuoted(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Performs a conversion from <see cref="T:System.Collections.Generic.IEnumerable`1"/> to <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.
</summary>
<param name="values">The text values to convert.</param>
<returns>A <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.</returns>
</member>
<member name="T:Cake.Core.MethodInfoExtensions">
<summary>
Contains extension methods for <see cref="T:System.Reflection.MethodInfo"/>.
</summary>
</member>
<member name="M:Cake.Core.MethodInfoExtensions.GetSignature(System.Reflection.MethodInfo,System.Boolean,System.Boolean)">
<summary>
Gets the signature for a method.
</summary>
<param name="method">The method.</param>
<param name="includeMethodNamespace">if set to <c>true</c>, include method namespace.</param>
<param name="includeParameterNamespace">if set to <c>true</c>, include parameter namespace.</param>
<returns>The method signature.</returns>
</member>
<member name="M:Cake.Core.MethodInfoExtensions.GetFullName(System.Reflection.MethodInfo)">
<summary>
Gets the full name of a method.
</summary>
<param name="method">The method to get the full name for.</param>
<returns>The full name.</returns>
</member>
<member name="M:Cake.Core.MethodInfoExtensions.GetNamespace(System.Reflection.MethodInfo)">
<summary>
Gets the namespace of the method.
</summary>
<param name="method">The method.</param>
<returns>The namespace of the method.</returns>
</member>
<member name="T:Cake.Core.ProcessArgumentListExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.IO.ProcessArgumentBuilder" />.
</summary>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.Append(Cake.Core.IO.ProcessArgumentBuilder,System.String)">
<summary>
Appends the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="text">The text to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.Prepend(Cake.Core.IO.ProcessArgumentBuilder,System.String)">
<summary>
Prepend the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="text">The text to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.Append(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.Object[])">
<summary>
Formats and appends the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="format">A composite format string.</param>
<param name="args">An object array that contains zero or more objects to format.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="format" /> or <paramref name="args" /> is null. </exception>
<exception cref="T:System.FormatException"><paramref name="format" /> is invalid.-or- The index of a format item is less than zero, or greater than or equal to the length of the <paramref name="args" /> array. </exception>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.Prepend(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.Object[])">
<summary>
Formats and prepends the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="format">A composite format string.</param>
<param name="args">An object array that contains zero or more objects to format.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="format" /> or <paramref name="args" /> is null. </exception>
<exception cref="T:System.FormatException"><paramref name="format" /> is invalid.-or- The index of a format item is less than zero, or greater than or equal to the length of the <paramref name="args" /> array. </exception>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String)">
<summary>
Quotes and appends the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="text">The text to be quoted and appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String)">
<summary>
Quotes and prepends the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="text">The text to be quoted and prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.Object[])">
<summary>
Formats, quotes and appends the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="format">A composite format string to be quoted and appended.</param>
<param name="args">An object array that contains zero or more objects to format.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="format" /> or <paramref name="args" /> is null. </exception>
<exception cref="T:System.FormatException"><paramref name="format" /> is invalid.-or- The index of a format item is less than zero, or greater than or equal to the length of the <paramref name="args" /> array. </exception>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.Object[])">
<summary>
Formats, quotes and prepends the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="format">A composite format string to be quoted and prepended.</param>
<param name="args">An object array that contains zero or more objects to format.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="format" /> or <paramref name="args" /> is null. </exception>
<exception cref="T:System.FormatException"><paramref name="format" /> is invalid.-or- The index of a format item is less than zero, or greater than or equal to the length of the <paramref name="args" /> array. </exception>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendQuoted(Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and appends the specified argument to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="argument">The argument to be quoted and appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependQuoted(Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and prepends the specified argument to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="argument">The argument to be quoted and prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String)">
<summary>
Appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="text">The secret text to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String)">
<summary>
Prepends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="text">The secret text to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.Object[])">
<summary>
Formats and appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="format">A composite format string for the secret text to be appended.</param>
<param name="args">An object array that contains zero or more objects to format.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="format" /> or <paramref name="args" /> is null. </exception>
<exception cref="T:System.FormatException"><paramref name="format" /> is invalid.-or- The index of a format item is less than zero, or greater than or equal to the length of the <paramref name="args" /> array. </exception>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.Object[])">
<summary>
Formats and prepend the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="format">A composite format string for the secret text to be prepended.</param>
<param name="args">An object array that contains zero or more objects to format.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="format" /> or <paramref name="args" /> is null. </exception>
<exception cref="T:System.FormatException"><paramref name="format" /> is invalid.-or- The index of a format item is less than zero, or greater than or equal to the length of the <paramref name="args" /> array. </exception>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSecret(Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.IProcessArgument)">
<summary>
Appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="argument">The secret argument to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSecret(Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.IProcessArgument)">
<summary>
Prepend the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="argument">The secret argument to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String)">
<summary>
Quotes and appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="text">The secret text to be quoted and appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String)">
<summary>
Quotes and prepends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="text">The secret text to be quoted and prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.Object[])">
<summary>
Formats, quotes and appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="format">A composite format string for the secret text to be quoted and appended.</param>
<param name="args">An object array that contains zero or more objects to format.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="format" /> or <paramref name="args" /> is null. </exception>
<exception cref="T:System.FormatException"><paramref name="format" /> is invalid.-or- The index of a format item is less than zero, or greater than or equal to the length of the <paramref name="args" /> array. </exception>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.Object[])">
<summary>
Formats, quotes and prepends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="format">A composite format string for the secret text to be quoted and prepended.</param>
<param name="args">An object array that contains zero or more objects to format.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="format" /> or <paramref name="args" /> is null. </exception>
<exception cref="T:System.FormatException"><paramref name="format" /> is invalid.-or- The index of a format item is less than zero, or greater than or equal to the length of the <paramref name="args" /> array. </exception>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="argument">The secret argument to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and prepends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="argument">The secret argument to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitch(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String)">
<summary>
Appends the specified switch to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="text">The text to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitch(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String)">
<summary>
Prepend the specified switch to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="text">The text to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitch(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,System.String)">
<summary>
Appends the specified switch to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="text">The text to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitch(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,System.String)">
<summary>
Prepend the specified switch to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="text">The text to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitchQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String)">
<summary>
Quotes and appends the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="text">The text to be quoted and appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitchQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String)">
<summary>
Quotes and prepends the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="text">The text to be quoted and prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitchQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,System.String)">
<summary>
Quotes and appends the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="text">The text to be quoted and appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitchQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,System.String)">
<summary>
Quotes and prepends the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="text">The text to be quoted and prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitchQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and appends the specified argument to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="argument">The argument to be quoted and appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitchQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and prepends the specified argument to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="argument">The argument to be quoted and prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitchQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and appends the specified argument to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="argument">The argument to be quoted and appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitchQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and prepends the specified argument to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="argument">The argument to be quoted and prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitchSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String)">
<summary>
Appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="text">The secret text to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitchSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String)">
<summary>
Prepend the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="text">The secret text to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitchSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,System.String)">
<summary>
Appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="text">The secret text to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitchSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,System.String)">
<summary>
Prepend the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="text">The secret text to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitchSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="argument">The secret argument to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitchSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Prepend the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="argument">The secret argument to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitchSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="argument">The secret argument to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitchSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Prepend the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="argument">The secret argument to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitchQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String)">
<summary>
Quotes and appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="text">The secret text to be quoted and appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitchQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String)">
<summary>
Quotes and prepend the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="text">The secret text to be quoted and prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitchQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,System.String)">
<summary>
Quotes and appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="text">The secret text to be quoted and appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitchQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,System.String)">
<summary>
Quotes and prepends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="text">The secret text to be quoted and prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="argument">The secret argument to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and prepends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="argument">The secret argument to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="argument">The secret argument to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and prepend the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="argument">The secret argument to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.IsNullOrEmpty(Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Indicates whether a <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> is null or renders empty.
</summary>
<param name="builder">The builder.</param>
<returns><c>true</c> if <paramref name="builder"/> refers to a null or empty <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>;
<c>false</c> if the <paramref name="builder"/>refers to non null or empty <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.CopyTo(Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Copies all the arguments of the source <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> to target <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.
</summary>
<param name="source">The argument builder to copy from.</param>
<param name="target">The argument builder to copy to.</param>
</member>
<member name="T:Cake.Core.ProcessRunnerExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.IO.IProcessRunner"/>.
</summary>
</member>
<member name="M:Cake.Core.ProcessRunnerExtensions.Start(Cake.Core.IO.IProcessRunner,Cake.Core.IO.FilePath)">
<summary>
Starts a process using the specified information.
</summary>
<param name="processRunner">The process runner.</param>
<param name="filePath">The file name such as an application or document with which to start the process.</param>
<returns>A process handle.</returns>
</member>
<member name="T:Cake.Core.ProcessSettingsExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.IO.ProcessSettings" />.
</summary>
</member>
<member name="M:Cake.Core.ProcessSettingsExtensions.WithArguments(Cake.Core.IO.ProcessSettings,System.Action{Cake.Core.IO.ProcessArgumentBuilder})">
<summary>
Sets the arguments for the process.
</summary>
<param name="settings">The settings.</param>
<param name="arguments">The action used to set arguments.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessSettingsExtensions.UseWorkingDirectory(Cake.Core.IO.ProcessSettings,Cake.Core.IO.DirectoryPath)">
<summary>
Sets the working directory for the process to be started.
</summary>
<param name="settings">The process settings.</param>
<param name="path">The working directory for the process to be started.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessSettingsExtensions.SetRedirectedStandardOutputHandler(Cake.Core.IO.ProcessSettings,System.Func{System.String,System.String})">
<summary>
Sets a function that intercepts the standard output before being redirected. Use in conjunction with <see cref="P:Cake.Core.IO.ProcessSettings.RedirectStandardOutput"/>.
</summary>
<param name="settings">The process settings.</param>
<param name="handler">The standard output handler.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessSettingsExtensions.SetRedirectedStandardErrorHandler(Cake.Core.IO.ProcessSettings,System.Func{System.String,System.String})">
<summary>
Sets a function that intercepts the standard error before being redirected. Use in conjunction with <see cref="P:Cake.Core.IO.ProcessSettings.RedirectStandardOutput"/>.
</summary>
<param name="settings">The process settings.</param>
<param name="handler">The standard error handler.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessSettingsExtensions.SetRedirectStandardOutput(Cake.Core.IO.ProcessSettings,System.Boolean)">
<summary>
Sets a value indicating whether the output of an application is written to the standard output stream.
</summary>
<param name="settings">The process settings.</param>
<param name="redirect">true if output should be redirected; false if output should be written to the standard output stream. The default is false.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessSettingsExtensions.SetRedirectStandardError(Cake.Core.IO.ProcessSettings,System.Boolean)">
<summary>
Sets a value indicating whether the standard error of an application is written to the standard error stream.
</summary>
<param name="settings">The process settings.</param>
<param name="redirect">true if error output should be redirected; false if error output should be written to the standard error stream. The default is false.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessSettingsExtensions.SetTimeout(Cake.Core.IO.ProcessSettings,System.Int32)">
<summary>
Sets the optional timeout for process execution.
</summary>
<param name="settings">The process settings.</param>
<param name="timeout">The timeout duration.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Core.StringExtensions">
<summary>
Contains extension methods for <see cref="T:System.String"/>.
</summary>
</member>
<member name="M:Cake.Core.StringExtensions.Quote(System.String)">
<summary>
Quotes the specified <see cref="T:System.String"/>.
</summary>
<param name="value">The string to quote.</param>
<returns>A quoted string.</returns>
</member>
<member name="M:Cake.Core.StringExtensions.UnQuote(System.String)">
<summary>
Unquote the specified <see cref="T:System.String"/>.
</summary>
<param name="value">The string to unquote.</param>
<returns>An unquoted string.</returns>
</member>
<member name="M:Cake.Core.StringExtensions.SplitLines(System.String)">
<summary>
Splits the <see cref="T:System.String"/> into lines.
</summary>
<param name="content">The string to split.</param>
<returns>The lines making up the provided string.</returns>
</member>
<member name="M:Cake.Core.StringExtensions.NormalizeLineEndings(System.String)">
<summary>
Normalizes the line endings in a <see cref="T:System.String"/>.
</summary>
<param name="value">The string to normalize line endings in.</param>
<returns>A <see cref="T:System.String"/> with normalized line endings.</returns>
</member>
<member name="T:Cake.Core.TypeExtensions">
<summary>
Contains extension methods for <see cref="T:System.Type"/>.
</summary>
</member>
<member name="M:Cake.Core.TypeExtensions.IsStatic(System.Type)">
<summary>
Determines whether the specified <see cref="T:System.Type"/> is static.
</summary>
<param name="type">The type.</param>
<returns>Whether or not the specified type is static.</returns>
</member>
<member name="M:Cake.Core.TypeExtensions.GetFullName(System.Type,System.Boolean)">
<summary>
Gets the full name of a <see cref="T:System.Type"/>.
</summary>
<param name="type">The type.</param>
<param name="includeNamespace">if set to <c>true</c> then namespace is included.</param>
<returns>The full name of a type.</returns>
</member>
<member name="M:Cake.Core.TypeExtensions.IsSubclassOfRawGeneric(System.Type,System.Type)">
<summary>
Gets whether or not a given <see cref="T:System.Type"/> is a subclass of an raw/open generic.
</summary>
<param name="toCheck">The type to check.</param>
<param name="generic">The open generic to test.</param>
<code>typeof(Nullable<int>).IsSubclassOfRawGeneric(typeof(Nullable<>));.</code>
<returns>Returns <c>true</c> if the type is a subtype of a raw generic, else <c>false</c>.</returns>
</member>
<member name="T:Cake.Core.UriExtensions">
<summary>
Extensions for <see cref="T:System.Uri"/>.
</summary>
</member>
<member name="M:Cake.Core.UriExtensions.GetQueryString(System.Uri)">
<summary>
Extracts query string of <see cref="T:System.Uri"/>.
</summary>
<param name="uri">The URI.</param>
<returns>Collection of parameters and their values.</returns>
</member>
<member name="T:Cake.Core.Graph.CakeGraph">
<summary>
Represents the Cake task graph.
</summary>
</member>
<member name="M:Cake.Core.Graph.CakeGraph.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Graph.CakeGraph"/> class.
</summary>
</member>
<member name="P:Cake.Core.Graph.CakeGraph.Nodes">
<summary>
Gets the nodes in the graph.
</summary>
</member>
<member name="P:Cake.Core.Graph.CakeGraph.Edges">
<summary>
Gets the edges in the graph.
</summary>
</member>
<member name="M:Cake.Core.Graph.CakeGraph.Add(System.String)">
<summary>
Adds a node to the graph.
</summary>
<param name="node">The node to add.</param>
</member>
<member name="M:Cake.Core.Graph.CakeGraph.Connect(System.String,System.String)">
<summary>
Connects two nodes in the graph together.
If any of the nodes are missing, they will be added.
</summary>
<param name="start">The start node.</param>
<param name="end">The end node.</param>
</member>
<member name="M:Cake.Core.Graph.CakeGraph.Exist(System.String)">
<summary>
Gets whether or not a node exists in the graph.
</summary>
<param name="name">The name of the node.</param>
<returns>Whether or not the node exists in the graph.</returns>
</member>
<member name="M:Cake.Core.Graph.CakeGraph.Traverse(System.String)">
<summary>
Traverses the graph leading to the specified target.
</summary>
<param name="target">The target to traverse to.</param>
<returns>A list of nodes.</returns>
</member>
<member name="T:Cake.Core.Graph.CakeGraphBuilder">
<summary>
Responsible for building the Cake task graph.
</summary>
</member>
<member name="M:Cake.Core.Graph.CakeGraphBuilder.Build(System.Collections.Generic.IReadOnlyCollection{Cake.Core.ICakeTaskInfo})">
<summary>
Builds a <see cref="T:Cake.Core.Graph.CakeGraph"/> from the specified tasks.
</summary>
<param name="tasks">The tasks to build the graph from.</param>
<returns>An assembled graph.</returns>
</member>
<member name="T:Cake.Core.Graph.CakeGraphEdge">
<summary>
Represents an edge in a <see cref="T:Cake.Core.Graph.CakeGraph"/>.
</summary>
</member>
<member name="P:Cake.Core.Graph.CakeGraphEdge.Start">
<summary>
Gets the start node of the edge.
</summary>
</member>
<member name="P:Cake.Core.Graph.CakeGraphEdge.End">
<summary>
Gets the end node of the edge.
</summary>
</member>
<member name="M:Cake.Core.Graph.CakeGraphEdge.#ctor(System.String,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Graph.CakeGraphEdge"/> class.
</summary>
<param name="start">The start node.</param>
<param name="end">The end node.</param>
</member>
<member name="T:Cake.Core.ICakeArguments">
<summary>
Represents arguments passed to the executing script.
</summary>
</member>
<member name="M:Cake.Core.ICakeArguments.HasArgument(System.String)">
<summary>
Determines whether or not the specified argument exist.
</summary>
<param name="name">The argument name.</param>
<returns>
<c>true</c> if the argument exist; otherwise <c>false</c>.
</returns>
</member>
<member name="M:Cake.Core.ICakeArguments.GetArguments(System.String)">
<summary>
Gets all values for an argument.
</summary>
<param name="name">The argument name.</param>
<returns>The argument values.</returns>
</member>
<member name="M:Cake.Core.ICakeArguments.GetArguments">
<summary>
Gets all command line arguments.
</summary>
<returns>The command line arguments as IDictionary<string, ICollection<string>>.</returns>
</member>
<member name="T:Cake.Core.ICakeContext">
<summary>
Represents a context for scripts and script aliases.
</summary>
</member>
<member name="P:Cake.Core.ICakeContext.FileSystem">
<summary>
Gets the file system.
</summary>
<value>The file system.</value>
</member>
<member name="P:Cake.Core.ICakeContext.Environment">
<summary>
Gets the environment.
</summary>
<value>The environment.</value>
</member>
<member name="P:Cake.Core.ICakeContext.Globber">
<summary>
Gets the globber.
</summary>
<value>The globber.</value>
</member>
<member name="P:Cake.Core.ICakeContext.Log">
<summary>
Gets the log.
</summary>
<value>The log.</value>
</member>
<member name="P:Cake.Core.ICakeContext.Arguments">
<summary>
Gets the arguments.
</summary>
<value>The arguments.</value>
</member>
<member name="P:Cake.Core.ICakeContext.ProcessRunner">
<summary>
Gets the process runner.
</summary>
<value>The process runner.</value>
</member>
<member name="P:Cake.Core.ICakeContext.Registry">
<summary>
Gets the registry.
</summary>
<value>The registry.</value>
</member>
<member name="P:Cake.Core.ICakeContext.Tools">
<summary>
Gets the tool locator.
</summary>
<value>The tool locator.</value>
</member>
<member name="P:Cake.Core.ICakeContext.Data">
<summary>
Gets the data context resolver.
</summary>
</member>
<member name="P:Cake.Core.ICakeContext.Configuration">
<summary>
Gets the cake configuration.
</summary>
</member>
<member name="T:Cake.Core.ICakeDataResolver">
<summary>
Represents a data context resolver.
</summary>
</member>
<member name="M:Cake.Core.ICakeDataResolver.Get``1">
<summary>
Gets the data of the specified type.
</summary>
<typeparam name="TData">The data type.</typeparam>
<returns>The value of the data.</returns>
</member>
<member name="T:Cake.Core.ICakeDataService">
<summary>
Represents a data context service.
</summary>
</member>
<member name="M:Cake.Core.ICakeDataService.Add``1(``0)">
<summary>
Adds the data of the specified type.
</summary>
<typeparam name="TData">The data type.</typeparam>
<param name="value">The value of the data.</param>
</member>
<member name="T:Cake.Core.ICakeEngine">
<summary>
Represents the Cake engine.
</summary>
</member>
<member name="P:Cake.Core.ICakeEngine.Tasks">
<summary>
Gets all registered tasks.
</summary>
<value>The registered tasks.</value>
</member>
<member name="E:Cake.Core.ICakeEngine.Setup">
<summary>
Raised during setup before any tasks are run.
</summary>
</member>
<member name="E:Cake.Core.ICakeEngine.Teardown">
<summary>
Raised during teardown after all other tasks have been run.
</summary>
</member>
<member name="E:Cake.Core.ICakeEngine.TaskSetup">
<summary>
Raised before each task is run.
</summary>
</member>
<member name="E:Cake.Core.ICakeEngine.TaskTeardown">
<summary>
Raised after each task has been run.
</summary>
</member>
<member name="M:Cake.Core.ICakeEngine.RegisterTask(System.String)">
<summary>
Creates and registers a new Cake task.
</summary>
<param name="name">The name of the task.</param>
<returns>A <see cref="T:Cake.Core.CakeTaskBuilder"/> used to configure the task.</returns>
</member>
<member name="M:Cake.Core.ICakeEngine.RegisterSetupAction(System.Action{Cake.Core.ISetupContext})">
<summary>
Allows registration of an action that's executed before any tasks are run.
If setup fails, no tasks will be executed but teardown will be performed.
</summary>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.ICakeEngine.RegisterSetupAction``1(System.Func{Cake.Core.ISetupContext,``0})">
<summary>
Allows registration of an action that's executed before any tasks are run.
If setup fails, no tasks will be executed but teardown will be performed.
</summary>
<typeparam name="TData">The data type.</typeparam>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.ICakeEngine.RegisterTeardownAction(System.Action{Cake.Core.ITeardownContext})">
<summary>
Allows registration of an action that's executed after all other tasks have been run.
If a setup action or a task fails with or without recovery, the specified teardown action will still be executed.
</summary>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.ICakeEngine.RegisterTeardownAction``1(System.Action{Cake.Core.ITeardownContext,``0})">
<summary>
Allows registration of an action that's executed after all other tasks have been run.
If a setup action or a task fails with or without recovery, the specified teardown action will still be executed.
</summary>
<typeparam name="TData">The data type.</typeparam>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.ICakeEngine.RunTargetAsync(Cake.Core.ICakeContext,Cake.Core.IExecutionStrategy,Cake.Core.ExecutionSettings)">
<summary>
Runs the specified target using the specified <see cref="T:Cake.Core.IExecutionStrategy"/>.
</summary>
<param name="context">The context.</param>
<param name="strategy">The execution strategy.</param>
<param name="settings">The execution settings.</param>
<returns>The resulting report.</returns>
</member>
<member name="M:Cake.Core.ICakeEngine.RegisterTaskSetupAction(System.Action{Cake.Core.ITaskSetupContext})">
<summary>
Allows registration of an action that's executed before each task is run.
If the task setup fails, the task will not be executed but the task's teardown will be performed.
</summary>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.ICakeEngine.RegisterTaskSetupAction``1(System.Action{Cake.Core.ITaskSetupContext,``0})">
<summary>
Allows registration of an action that's executed before each task is run.
If the task setup fails, the task will not be executed but the task's teardown will be performed.
</summary>
<typeparam name="TData">The data type.</typeparam>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.ICakeEngine.RegisterTaskTeardownAction(System.Action{Cake.Core.ITaskTeardownContext})">
<summary>
Allows registration of an action that's executed after each task has been run.
If a task setup action or a task fails with or without recovery, the specified task teardown action will still be executed.
</summary>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.ICakeEngine.RegisterTaskTeardownAction``1(System.Action{Cake.Core.ITaskTeardownContext,``0})">
<summary>
Allows registration of an action that's executed after each task has been run.
If a task setup action or a task fails with or without recovery, the specified task teardown action will still be executed.
</summary>
<typeparam name="TData">The data type.</typeparam>
<param name="action">The action to be executed.</param>
</member>
<member name="T:Cake.Core.ICakeEnvironment">
<summary>
Represents the environment Cake operates in.
</summary>
</member>
<member name="P:Cake.Core.ICakeEnvironment.WorkingDirectory">
<summary>
Gets or sets the working directory.
</summary>
<value>The working directory.</value>
</member>
<member name="P:Cake.Core.ICakeEnvironment.ApplicationRoot">
<summary>
Gets the application root path.
</summary>
<value>The application root path.</value>
</member>
<member name="M:Cake.Core.ICakeEnvironment.GetSpecialPath(Cake.Core.IO.SpecialPath)">
<summary>
Gets a special path.
</summary>
<param name="path">The path.</param>
<returns>A <see cref="T:Cake.Core.IO.DirectoryPath"/> to the special path.</returns>
</member>
<member name="M:Cake.Core.ICakeEnvironment.GetEnvironmentVariable(System.String)">
<summary>
Gets an environment variable.
</summary>
<param name="variable">The variable.</param>
<returns>The value of the environment variable.</returns>
</member>
<member name="M:Cake.Core.ICakeEnvironment.GetEnvironmentVariables">
<summary>
Gets all environment variables.
</summary>
<returns>The environment variables as IDictionary<string, string>.</returns>
</member>
<member name="P:Cake.Core.ICakeEnvironment.Platform">
<summary>
Gets the platform Cake is running on.
</summary>
<value>The platform Cake is running on.</value>
</member>
<member name="P:Cake.Core.ICakeEnvironment.Runtime">
<summary>
Gets the runtime Cake is running in.
</summary>
<value>The runtime Cake is running in.</value>
</member>
<member name="T:Cake.Core.ICakePlatform">
<summary>
Represents the platform that Cake is running on.
</summary>
</member>
<member name="P:Cake.Core.ICakePlatform.Family">
<summary>
Gets the platform family.
</summary>
<value>The platform family.</value>
</member>
<member name="P:Cake.Core.ICakePlatform.Is64Bit">
<summary>
Gets a value indicating whether or not the current operative system is 64 bit.
</summary>
<value>
<c>true</c> if current operative system is 64 bit; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Core.ICakeReportPrinter">
<summary>
Represents a report printer.
</summary>
</member>
<member name="M:Cake.Core.ICakeReportPrinter.Write(Cake.Core.CakeReport)">
<summary>
Writes the specified report to a target.
</summary>
<param name="report">The report to write.</param>
</member>
<member name="T:Cake.Core.ICakeRuntime">
<summary>
Represents the runtime that Cake is running in.
</summary>
</member>
<member name="P:Cake.Core.ICakeRuntime.BuiltFramework">
<summary>
Gets the build-time .NET framework version that is being used.
</summary>
</member>
<member name="P:Cake.Core.ICakeRuntime.Runtime">
<summary>
Gets the current executing .NET Runtime.
</summary>
<returns>The target framework.</returns>
</member>
<member name="P:Cake.Core.ICakeRuntime.CakeVersion">
<summary>
Gets the version of Cake executing the script.
</summary>
<returns>The Cake.exe version.</returns>
</member>
<member name="P:Cake.Core.ICakeRuntime.IsCoreClr">
<summary>
Gets a value indicating whether we're running on CoreClr.
</summary>
<value>
<c>true</c> if we're running on CoreClr; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Core.ICakeTaskInfo">
<summary>
Provides descriptive properties about a cake task.
</summary>
</member>
<member name="P:Cake.Core.ICakeTaskInfo.Name">
<summary>
Gets the name of the task.
</summary>
<value>The name of the task.</value>
</member>
<member name="P:Cake.Core.ICakeTaskInfo.Description">
<summary>
Gets the description of the task.
</summary>
<value>The description of the task.</value>
</member>
<member name="P:Cake.Core.ICakeTaskInfo.Dependencies">
<summary>
Gets the task's dependencies.
</summary>
<value>The task's dependencies.</value>
</member>
<member name="P:Cake.Core.ICakeTaskInfo.Dependees">
<summary>
Gets the tasks that the task want to be a dependency of.
</summary>
<value>The tasks that the task want to be a dependency of.</value>
</member>
<member name="T:Cake.Core.IConsole">
<summary>
Represents console output.
</summary>
</member>
<member name="P:Cake.Core.IConsole.ForegroundColor">
<summary>
Gets or sets the foreground color.
</summary>
<value>The foreground color.</value>
</member>
<member name="P:Cake.Core.IConsole.BackgroundColor">
<summary>
Gets or sets the background color.
</summary>
<value>The background color.</value>
</member>
<member name="P:Cake.Core.IConsole.SupportAnsiEscapeCodes">
<summary>
Gets a value indicating whether or not the console supports ANSI escape codes.
</summary>
</member>
<member name="M:Cake.Core.IConsole.Write(System.String,System.Object[])">
<summary>
Writes the text representation of the specified array of objects to the
console output using the specified format information.
</summary>
<param name="format">A composite format string.</param>
<param name="arg">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.IConsole.WriteLine(System.String,System.Object[])">
<summary>
Writes the text representation of the specified array of objects, followed
by the current line terminator, to the console output using the specified
format information.
</summary>
<param name="format">A composite format string.</param>
<param name="arg">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.IConsole.WriteError(System.String,System.Object[])">
<summary>
Writes the text representation of the specified array of objects to the
console error output using the specified format information.
</summary>
<param name="format">A composite format string.</param>
<param name="arg">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.IConsole.WriteErrorLine(System.String,System.Object[])">
<summary>
Writes the text representation of the specified array of objects, followed
by the current line terminator, to the console error output using the
specified format information.
</summary>
<param name="format">A composite format string.</param>
<param name="arg">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.IConsole.ResetColor">
<summary>
Sets the foreground and background console colors to their defaults.
</summary>
</member>
<member name="T:Cake.Core.IExecutionStrategy">
<summary>
Represents a task execution strategy.
</summary>
</member>
<member name="M:Cake.Core.IExecutionStrategy.PerformSetup(System.Action{Cake.Core.ISetupContext},Cake.Core.ISetupContext)">
<summary>
Performs the setup.
</summary>
<param name="action">The action.</param>
<param name="context">The context.</param>
</member>
<member name="M:Cake.Core.IExecutionStrategy.PerformTeardown(System.Action{Cake.Core.ITeardownContext},Cake.Core.ITeardownContext)">
<summary>
Performs the teardown.
</summary>
<param name="action">The action.</param>
<param name="teardownContext">The context.</param>
</member>
<member name="M:Cake.Core.IExecutionStrategy.ExecuteAsync(Cake.Core.CakeTask,Cake.Core.ICakeContext)">
<summary>
Executes the specified task.
</summary>
<param name="task">The task to execute.</param>
<param name="context">The context.</param>
<returns>Returned Task.</returns>
</member>
<member name="M:Cake.Core.IExecutionStrategy.Skip(Cake.Core.CakeTask,Cake.Core.CakeTaskCriteria)">
<summary>
Skips the specified task.
</summary>
<param name="task">The task to skip.</param>
<param name="criteria">The criteria that caused the task to be skipped.</param>
</member>
<member name="M:Cake.Core.IExecutionStrategy.ReportErrorsAsync(System.Func{System.Exception,System.Threading.Tasks.Task},System.Exception)">
<summary>
Executes the error reporter.
</summary>
<param name="action">The action.</param>
<param name="exception">The exception.</param>
<returns>The awaitable task.</returns>
</member>
<member name="M:Cake.Core.IExecutionStrategy.HandleErrorsAsync(System.Func{System.Exception,Cake.Core.ICakeContext,System.Threading.Tasks.Task},System.Exception,Cake.Core.ICakeContext)">
<summary>
Executes the error handler.
</summary>
<param name="action">The action.</param>
<param name="exception">The exception.</param>
<param name="context">The context.</param>
<returns>The awaitable task.</returns>
</member>
<member name="M:Cake.Core.IExecutionStrategy.InvokeFinallyAsync(System.Func{System.Threading.Tasks.Task})">
<summary>
Invokes the finally handler.
</summary>
<param name="action">The action.</param>
<returns>The awaitable task.</returns>
</member>
<member name="M:Cake.Core.IExecutionStrategy.PerformTaskSetup(System.Action{Cake.Core.ITaskSetupContext},Cake.Core.ITaskSetupContext)">
<summary>
Performs the specified setup action before each task is invoked.
</summary>
<param name="action">The action.</param>
<param name="taskSetupContext">The context.</param>
</member>
<member name="M:Cake.Core.IExecutionStrategy.PerformTaskTeardown(System.Action{Cake.Core.ITaskTeardownContext},Cake.Core.ITaskTeardownContext)">
<summary>
Performs the specified teardown action after each task is invoked.
</summary>
<param name="action">The action.</param>
<param name="taskTeardownContext">The context.</param>
</member>
<member name="T:Cake.Core.IO.Arguments.QuotedArgument">
<summary>
Represents a quoted argument.
</summary>
</member>
<member name="M:Cake.Core.IO.Arguments.QuotedArgument.#ctor(Cake.Core.IO.IProcessArgument)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.Arguments.QuotedArgument"/> class.
</summary>
<param name="argument">The argument.</param>
</member>
<member name="M:Cake.Core.IO.Arguments.QuotedArgument.Render">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.Arguments.QuotedArgument.RenderSafe">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.Arguments.QuotedArgument.ToString">
<inheritdoc/>
</member>
<member name="T:Cake.Core.IO.Arguments.SecretArgument">
<summary>
Represents a secret argument.
</summary>
</member>
<member name="M:Cake.Core.IO.Arguments.SecretArgument.#ctor(Cake.Core.IO.IProcessArgument)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.Arguments.SecretArgument"/> class.
</summary>
<param name="argument">The argument.</param>
</member>
<member name="M:Cake.Core.IO.Arguments.SecretArgument.Render">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.Arguments.SecretArgument.RenderSafe">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.Arguments.SecretArgument.ToString">
<inheritdoc/>
</member>
<member name="T:Cake.Core.IO.Arguments.SwitchArgument">
<summary>
Represents a argument preceded by a switch.
</summary>
</member>
<member name="M:Cake.Core.IO.Arguments.SwitchArgument.#ctor(System.String,Cake.Core.IO.IProcessArgument,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.Arguments.SwitchArgument"/> class.
</summary>
<param name="switch">The switch.</param>
<param name="argument">The argument.</param>
<param name="separator">The separator between the <paramref name="switch"/> and the <paramref name="argument"/>.</param>
</member>
<member name="M:Cake.Core.IO.Arguments.SwitchArgument.Render">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.Arguments.SwitchArgument.RenderSafe">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.Arguments.SwitchArgument.ToString">
<inheritdoc/>
</member>
<member name="T:Cake.Core.IO.Arguments.TextArgument">
<summary>
Represents a text argument.
</summary>
</member>
<member name="M:Cake.Core.IO.Arguments.TextArgument.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.Arguments.TextArgument"/> class.
</summary>
<param name="text">The text.</param>
</member>
<member name="M:Cake.Core.IO.Arguments.TextArgument.Render">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.Arguments.TextArgument.RenderSafe">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.Arguments.TextArgument.ToString">
<inheritdoc/>
</member>
<member name="T:Cake.Core.IO.Arguments.NamespaceDoc">
<summary>
This namespace contain types
used to compose process arguments in a safe way.
</summary>
</member>
<member name="T:Cake.Core.IO.DirectoryPath">
<summary>
Represents a directory path.
</summary>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.DirectoryPath"/> class.
</summary>
<param name="path">The path.</param>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.GetDirectoryName">
<summary>
Gets the name of the directory.
</summary>
<returns>The directory name.</returns>
<remarks>
If this is passed a file path, it will return the file name.
This is by-and-large equivalent to how DirectoryInfo handles this scenario.
If we wanted to return the *actual* directory name, we'd need to pull in IFileSystem,
and do various checks to make sure things exists.
</remarks>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.GetFilePath(Cake.Core.IO.FilePath)">
<summary>
Combines the current path with the file name of a <see cref="T:Cake.Core.IO.FilePath"/>.
</summary>
<param name="path">The path.</param>
<returns>A combination of the current path and the file name of the provided <see cref="T:Cake.Core.IO.FilePath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.CombineWithFilePath(Cake.Core.IO.FilePath)">
<summary>
Combines the current path with a <see cref="T:Cake.Core.IO.FilePath"/>.
The provided <see cref="T:Cake.Core.IO.FilePath"/> must be relative.
</summary>
<param name="path">The path.</param>
<returns>A combination of the current path and the provided <see cref="T:Cake.Core.IO.FilePath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.Combine(Cake.Core.IO.DirectoryPath)">
<summary>
Combines the current path with another <see cref="T:Cake.Core.IO.DirectoryPath"/>.
The provided <see cref="T:Cake.Core.IO.DirectoryPath"/> must be relative.
</summary>
<param name="path">The path.</param>
<returns>A combination of the current path and the provided <see cref="T:Cake.Core.IO.DirectoryPath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.MakeAbsolute(Cake.Core.IO.DirectoryPath)">
<summary>
Makes the path absolute to another (absolute) path.
</summary>
<param name="path">The path.</param>
<returns>An absolute path.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.MakeAbsolute(Cake.Core.ICakeEnvironment)">
<summary>
Makes the path absolute (if relative) using the current working directory.
</summary>
<param name="environment">The environment.</param>
<returns>An absolute path.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.Collapse">
<summary>
Collapses a <see cref="T:Cake.Core.IO.DirectoryPath"/> containing ellipses.
</summary>
<returns>A collapsed <see cref="T:Cake.Core.IO.DirectoryPath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.op_Implicit(System.String)~Cake.Core.IO.DirectoryPath">
<summary>
Performs an implicit conversion from <see cref="T:System.String"/> to <see cref="T:Cake.Core.IO.DirectoryPath"/>.
</summary>
<param name="path">The path.</param>
<returns>A <see cref="T:Cake.Core.IO.DirectoryPath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.FromString(System.String)">
<summary>
Performs a conversion from <see cref="T:System.String"/> to <see cref="T:Cake.Core.IO.DirectoryPath"/>.
</summary>
<param name="path">The path.</param>
<returns>A <see cref="T:Cake.Core.IO.DirectoryPath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.GetRelativePath(Cake.Core.IO.DirectoryPath)">
<summary>
Get the relative path to another directory.
</summary>
<param name="to">The target directory path.</param>
<returns>A <see cref="T:Cake.Core.IO.DirectoryPath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.GetRelativePath(Cake.Core.IO.FilePath)">
<summary>
Get the relative path to another file.
</summary>
<param name="to">The target file path.</param>
<returns>A <see cref="T:Cake.Core.IO.FilePath"/>.</returns>
</member>
<member name="T:Cake.Core.IO.DirectoryPathCollection">
<summary>
A collection of <see cref="T:Cake.Core.IO.DirectoryPath"/>.
</summary>
</member>
<member name="P:Cake.Core.IO.DirectoryPathCollection.Count">
<summary>
Gets the number of directories in the collection.
</summary>
<value>The number of directories in the collection.</value>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.DirectoryPathCollection"/> class.
</summary>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.#ctor(Cake.Core.IO.PathComparer)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.DirectoryPathCollection"/> class.
</summary>
<param name="comparer">The comparer.</param>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.#ctor(System.Collections.Generic.IEnumerable{Cake.Core.IO.DirectoryPath})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.DirectoryPathCollection"/> class.
</summary>
<param name="paths">The paths.</param>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.#ctor(System.Collections.Generic.IEnumerable{Cake.Core.IO.DirectoryPath},Cake.Core.IO.PathComparer)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.DirectoryPathCollection"/> class.
</summary>
<param name="paths">The paths.</param>
<param name="comparer">The comparer.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="comparer"/> is <c>null</c>.</exception>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.Add(Cake.Core.IO.DirectoryPath)">
<summary>
Adds the specified path to the collection.
</summary>
<param name="path">The path to add.</param>
<returns>
<c>true</c> if the path was added; <c>false</c> if the path was already present.
</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.Add(System.Collections.Generic.IEnumerable{Cake.Core.IO.DirectoryPath})">
<summary>
Adds the specified paths to the collection.
</summary>
<param name="paths">The paths to add.</param>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.Remove(Cake.Core.IO.DirectoryPath)">
<summary>
Removes the specified path from the collection.
</summary>
<param name="path">The path to remove.</param>
<returns>
<c>true</c> if the path was removed; <c>false</c> if the path was not found in the collection.
</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.Remove(System.Collections.Generic.IEnumerable{Cake.Core.IO.DirectoryPath})">
<summary>
Removes the specified paths from the collection.
</summary>
<param name="paths">The paths to remove.</param>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.op_Addition(Cake.Core.IO.DirectoryPathCollection,Cake.Core.IO.DirectoryPath)">
<summary>Adds a path to the collection.</summary>
<param name="collection">The collection.</param>
<param name="path">The path to add.</param>
<returns>A new <see cref="T:Cake.Core.IO.DirectoryPathCollection"/> that contains the provided path as
well as the paths in the original collection.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.op_Addition(Cake.Core.IO.DirectoryPathCollection,System.Collections.Generic.IEnumerable{Cake.Core.IO.DirectoryPath})">
<summary>Adds multiple paths to the collection.</summary>
<param name="collection">The collection.</param>
<param name="paths">The paths to add.</param>
<returns>A new <see cref="T:Cake.Core.IO.DirectoryPathCollection"/> with the content of both collections.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.op_Subtraction(Cake.Core.IO.DirectoryPathCollection,Cake.Core.IO.DirectoryPath)">
<summary>
Removes a path from the collection.
</summary>
<param name="collection">The collection.</param>
<param name="path">The path to remove.</param>
<returns>A new <see cref="T:Cake.Core.IO.DirectoryPathCollection"/> that do not contain the provided path.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.op_Subtraction(Cake.Core.IO.DirectoryPathCollection,System.Collections.Generic.IEnumerable{Cake.Core.IO.DirectoryPath})">
<summary>
Removes multiple paths from the collection.
</summary>
<param name="collection">The collection.</param>
<param name="paths">The paths to remove.</param>
<returns>A new <see cref="T:Cake.Core.IO.DirectoryPathCollection"/> that do not contain the provided paths.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.GetEnumerator">
<summary>
Returns an enumerator that iterates through the collection.
</summary>
<returns>
A <see cref="T:System.Collections.Generic.IEnumerator`1" /> that can be used to iterate through the collection.
</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.System#Collections#IEnumerable#GetEnumerator">
<summary>
Returns an enumerator that iterates through a collection.
</summary>
<returns>
An <see cref="T:System.Collections.IEnumerator" /> that can be used to iterate through the collection.
</returns>
</member>
<member name="T:Cake.Core.IO.DirectoryPathConverter">
<summary>
A type converter for <see cref="T:Cake.Core.IO.DirectoryPath"/>.
</summary>
</member>
<member name="M:Cake.Core.IO.DirectoryPathConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.DirectoryPathConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.DirectoryPathConverter.CanConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Type)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.DirectoryPathConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.IO.FileExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.IO.IFile"/>.
</summary>
</member>
<member name="M:Cake.Core.IO.FileExtensions.Open(Cake.Core.IO.IFile,System.IO.FileMode)">
<summary>
Opens the file using the specified options.
</summary>
<param name="file">The file.</param>
<param name="mode">The mode.</param>
<returns>A <see cref="T:System.IO.Stream"/> to the file.</returns>
</member>
<member name="M:Cake.Core.IO.FileExtensions.Open(Cake.Core.IO.IFile,System.IO.FileMode,System.IO.FileAccess)">
<summary>
Opens the file using the specified options.
</summary>
<param name="file">The file.</param>
<param name="mode">The mode.</param>
<param name="access">The access.</param>
<returns>A <see cref="T:System.IO.Stream"/> to the file.</returns>
</member>
<member name="M:Cake.Core.IO.FileExtensions.OpenRead(Cake.Core.IO.IFile)">
<summary>
Opens the file for reading.
</summary>
<param name="file">The file.</param>
<returns>A <see cref="T:System.IO.Stream"/> to the file.</returns>
</member>
<member name="M:Cake.Core.IO.FileExtensions.OpenWrite(Cake.Core.IO.IFile)">
<summary>
Opens the file for writing.
If the file already exists, it will be overwritten.
</summary>
<param name="file">The file to be opened.</param>
<returns>A <see cref="T:System.IO.Stream"/> to the file.</returns>
</member>
<member name="M:Cake.Core.IO.FileExtensions.ReadLines(Cake.Core.IO.IFile,System.Text.Encoding)">
<summary>
Enumerates line in file.
</summary>
<param name="file">The file to be read from.</param>
<param name="encoding">The encoding that is applied to the content of the file.</param>
<returns>A <see cref="T:System.Collections.Generic.IEnumerable`1"/> of file line content.</returns>
</member>
<member name="M:Cake.Core.IO.FileExtensions.IsClrAssembly(Cake.Core.IO.IFile)">
<summary>
Checks if file has CLR PE Header.
</summary>
<param name="file">The file to be read from.</param>
<returns><c>true</c> if file is CLR assembly; otherwise, <c>false</c>.</returns>
<remarks>
See <a href="https://docs.microsoft.com/en-us/windows/desktop/Debug/pe-format">https://docs.microsoft.com/en-us/windows/desktop/Debug/pe-format</a> for more information.
</remarks>
</member>
<member name="T:Cake.Core.IO.FilePath">
<summary>
Represents a file path.
</summary>
</member>
<member name="P:Cake.Core.IO.FilePath.HasExtension">
<summary>
Gets a value indicating whether this path has a file extension.
</summary>
<value>
<c>true</c> if this file path has a file extension; otherwise, <c>false</c>.
</value>
</member>
<member name="M:Cake.Core.IO.FilePath.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.FilePath"/> class.
</summary>
<param name="path">The path.</param>
</member>
<member name="M:Cake.Core.IO.FilePath.GetDirectory">
<summary>
Gets the directory part of the path.
</summary>
<returns>The directory part of the path.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.GetFilename">
<summary>
Gets the filename.
</summary>
<returns>The filename.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.GetFilenameWithoutExtension">
<summary>
Gets the filename without its extension.
</summary>
<returns>The filename without its extension.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.GetExtension">
<summary>
Gets the file extension.
</summary>
<returns>The file extension.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.ChangeExtension(System.String)">
<summary>
Changes the file extension of the path.
</summary>
<param name="extension">The new extension.</param>
<returns>A new <see cref="T:Cake.Core.IO.FilePath"/> with a new extension.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.AppendExtension(System.String)">
<summary>
Appends a file extension to the path.
</summary>
<param name="extension">The extension.</param>
<returns>A new <see cref="T:Cake.Core.IO.FilePath"/> with an appended extension.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.MakeAbsolute(Cake.Core.ICakeEnvironment)">
<summary>
Makes the path absolute (if relative) using the current working directory.
</summary>
<param name="environment">The environment.</param>
<returns>An absolute path.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.MakeAbsolute(Cake.Core.IO.DirectoryPath)">
<summary>
Makes the path absolute (if relative) using the specified directory path.
</summary>
<param name="path">The path.</param>
<returns>An absolute path.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.Collapse">
<summary>
Collapses a <see cref="T:Cake.Core.IO.FilePath"/> containing ellipses.
</summary>
<returns>A collapsed <see cref="T:Cake.Core.IO.FilePath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.op_Implicit(System.String)~Cake.Core.IO.FilePath">
<summary>
Performs an implicit conversion from <see cref="T:System.String"/> to <see cref="T:Cake.Core.IO.FilePath"/>.
</summary>
<param name="path">The path.</param>
<returns>A <see cref="T:Cake.Core.IO.FilePath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.FromString(System.String)">
<summary>
Performs a conversion from <see cref="T:System.String"/> to <see cref="T:Cake.Core.IO.FilePath"/>.
</summary>
<param name="path">The path.</param>
<returns>A <see cref="T:Cake.Core.IO.FilePath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.GetRelativePath(Cake.Core.IO.DirectoryPath)">
<summary>
Get the relative path to another directory.
</summary>
<param name="to">The target directory path.</param>
<returns>A <see cref="T:Cake.Core.IO.DirectoryPath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.GetRelativePath(Cake.Core.IO.FilePath)">
<summary>
Get the relative path to another file.
</summary>
<param name="to">The target file path.</param>
<returns>A <see cref="T:Cake.Core.IO.FilePath"/>.</returns>
</member>
<member name="T:Cake.Core.IO.FilePathCollection">
<summary>
A collection of <see cref="T:Cake.Core.IO.FilePath"/>.
</summary>
</member>
<member name="P:Cake.Core.IO.FilePathCollection.Count">
<summary>
Gets the number of files in the collection.
</summary>
<value>The number of files in the collection.</value>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.FilePathCollection"/> class.
</summary>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.#ctor(Cake.Core.IO.PathComparer)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.FilePathCollection"/> class.
</summary>
<param name="comparer">The comparer.</param>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.#ctor(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.FilePathCollection"/> class.
</summary>
<param name="paths">The paths.</param>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.#ctor(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Core.IO.PathComparer)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.FilePathCollection"/> class.
</summary>
<param name="paths">The paths.</param>
<param name="comparer">The comparer.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="comparer"/> is <c>null</c>.</exception>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.Add(Cake.Core.IO.FilePath)">
<summary>
Adds the specified path to the collection.
</summary>
<param name="path">The path to add.</param>
<returns>
<c>true</c> if the path was added; <c>false</c> if the path was already present.
</returns>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.Add(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Adds the specified paths to the collection.
</summary>
<param name="paths">The paths to add.</param>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.Remove(Cake.Core.IO.FilePath)">
<summary>
Removes the specified path from the collection.
</summary>
<param name="path">The path to remove.</param>
<returns>
<c>true</c> if the path was removed; <c>false</c> if the path was not found in the collection.
</returns>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.Remove(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Removes the specified paths from the collection.
</summary>
<param name="paths">The paths to remove.</param>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.op_Addition(Cake.Core.IO.FilePathCollection,Cake.Core.IO.FilePath)">
<summary>Adds a path to the collection.</summary>
<param name="collection">The collection.</param>
<param name="path">The path to add.</param>
<returns>A new <see cref="T:Cake.Core.IO.FilePathCollection"/> that contains the provided path as
well as the paths in the original collection.</returns>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.op_Addition(Cake.Core.IO.FilePathCollection,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>Adds multiple paths to the collection.</summary>
<param name="collection">The collection.</param>
<param name="paths">The paths to add.</param>
<returns>A new <see cref="T:Cake.Core.IO.FilePathCollection"/> with the content of both collections.</returns>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.op_Subtraction(Cake.Core.IO.FilePathCollection,Cake.Core.IO.FilePath)">
<summary>
Removes a path from the collection.
</summary>
<param name="collection">The collection.</param>
<param name="path">The path to remove.</param>
<returns>A new <see cref="T:Cake.Core.IO.FilePathCollection"/> that do not contain the provided path.</returns>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.op_Subtraction(Cake.Core.IO.FilePathCollection,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Removes multiple paths from the collection.
</summary>
<param name="collection">The collection.</param>
<param name="paths">The paths to remove.</param>
<returns>A new <see cref="T:Cake.Core.IO.FilePathCollection"/> that do not contain the provided paths.</returns>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.GetEnumerator">
<summary>
Returns an enumerator that iterates through the collection.
</summary>
<returns>
A <see cref="T:System.Collections.Generic.IEnumerator`1" /> that can be used to iterate through the collection.
</returns>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.System#Collections#IEnumerable#GetEnumerator">
<summary>
Returns an enumerator that iterates through a collection.
</summary>
<returns>
An <see cref="T:System.Collections.IEnumerator" /> that can be used to iterate through the collection.
</returns>
</member>
<member name="T:Cake.Core.IO.FilePathConverter">
<summary>
A type converter for <see cref="T:Cake.Core.IO.FilePath"/>.
</summary>
</member>
<member name="M:Cake.Core.IO.FilePathConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.FilePathConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.FilePathConverter.CanConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Type)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.FilePathConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.IO.FileSystem">
<summary>
A physical file system implementation.
</summary>
</member>
<member name="M:Cake.Core.IO.FileSystem.GetFile(Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.FileSystem.GetDirectory(Cake.Core.IO.DirectoryPath)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.IO.FileSystemExtensions">
<summary>
Contains extensions for <see cref="T:Cake.Core.IO.IFileSystem"/>.
</summary>
</member>
<member name="M:Cake.Core.IO.FileSystemExtensions.Exist(Cake.Core.IO.IFileSystem,Cake.Core.IO.FilePath)">
<summary>
Determines if a specified <see cref="T:Cake.Core.IO.FilePath"/> exist.
</summary>
<param name="fileSystem">The file system.</param>
<param name="path">The path.</param>
<returns>Whether or not the specified file exist.</returns>
</member>
<member name="M:Cake.Core.IO.FileSystemExtensions.Exist(Cake.Core.IO.IFileSystem,Cake.Core.IO.DirectoryPath)">
<summary>
Determines if a specified <see cref="T:Cake.Core.IO.DirectoryPath"/> exist.
</summary>
<param name="fileSystem">The file system.</param>
<param name="path">The path.</param>
<returns>Whether or not the specified directory exist.</returns>
</member>
<member name="T:Cake.Core.IO.Globber">
<summary>
The file system globber.
</summary>
</member>
<member name="M:Cake.Core.IO.Globber.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.Globber"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Core.IO.Globber.Match(Cake.Core.IO.GlobPattern,Cake.Core.IO.GlobberSettings)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.IO.GlobberExtensions">
<summary>
Contains extensions for <see cref="T:Cake.Core.IO.IGlobber"/>.
</summary>
</member>
<member name="M:Cake.Core.IO.GlobberExtensions.GetFiles(Cake.Core.IO.IGlobber,Cake.Core.IO.GlobPattern)">
<summary>
Gets all files matching the specified pattern.
</summary>
<param name="globber">The globber.</param>
<param name="pattern">The pattern.</param>
<returns>The files matching the specified pattern.</returns>
</member>
<member name="M:Cake.Core.IO.GlobberExtensions.GetDirectories(Cake.Core.IO.IGlobber,Cake.Core.IO.GlobPattern)">
<summary>
Gets all directories matching the specified pattern.
</summary>
<param name="globber">The globber.</param>
<param name="pattern">The pattern.</param>
<returns>The directories matching the specified pattern.</returns>
</member>
<member name="M:Cake.Core.IO.GlobberExtensions.Match(Cake.Core.IO.IGlobber,Cake.Core.IO.GlobPattern)">
<summary>
Returns <see cref="T:Cake.Core.IO.Path" /> instances matching the specified pattern.
</summary>
<param name="globber">The globber.</param>
<param name="pattern">The pattern to match.</param>
<returns>
<see cref="T:Cake.Core.IO.Path" /> instances matching the specified pattern.
</returns>
</member>
<member name="M:Cake.Core.IO.GlobberExtensions.GetFiles(Cake.Core.IO.IGlobber,System.String)">
<summary>
Gets all files matching the specified pattern.
</summary>
<param name="globber">The globber.</param>
<param name="pattern">The pattern.</param>
<returns>The files matching the specified pattern.</returns>
</member>
<member name="M:Cake.Core.IO.GlobberExtensions.GetDirectories(Cake.Core.IO.IGlobber,System.String)">
<summary>
Gets all directories matching the specified pattern.
</summary>
<param name="globber">The globber.</param>
<param name="pattern">The pattern.</param>
<returns>The directories matching the specified pattern.</returns>
</member>
<member name="M:Cake.Core.IO.GlobberExtensions.Match(Cake.Core.IO.IGlobber,System.String)">
<summary>
Returns <see cref="T:Cake.Core.IO.Path" /> instances matching the specified pattern.
</summary>
<param name="globber">The globber.</param>
<param name="pattern">The pattern to match.</param>
<returns>
<see cref="T:Cake.Core.IO.Path" /> instances matching the specified pattern.
</returns>
</member>
<member name="T:Cake.Core.IO.GlobberSettings">
<summary>
Contains settings used by the globber.
</summary>
</member>
<member name="P:Cake.Core.IO.GlobberSettings.Predicate">
<summary>
Gets or sets the predicate used to filter directories based on file system information.
</summary>
</member>
<member name="P:Cake.Core.IO.GlobberSettings.FilePredicate">
<summary>
Gets or sets the filter used to filter files based on file system information.
</summary>
</member>
<member name="P:Cake.Core.IO.GlobberSettings.IsCaseSensitive">
<summary>
Gets or sets whether or not globbing is case sensitive or not.
If not set, the default value for the operating system will be used.
</summary>
</member>
<member name="T:Cake.Core.IO.GlobPattern">
<summary>
The file system globber pattern.
</summary>
</member>
<member name="P:Cake.Core.IO.GlobPattern.Pattern">
<summary>
Gets the the globber pattern.
</summary>
</member>
<member name="M:Cake.Core.IO.GlobPattern.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.GlobPattern"/> class.
</summary>
<param name="pattern">The globber pattern.</param>
</member>
<member name="M:Cake.Core.IO.GlobPattern.op_Implicit(System.String)~Cake.Core.IO.GlobPattern">
<summary>
Performs an implicit conversion from <see cref="T:System.String"/> to <see cref="T:Cake.Core.IO.GlobPattern"/>.
</summary>
<param name="pattern">The string pattern.</param>
<returns>A <see cref="T:Cake.Core.IO.GlobPattern"/>.</returns>
</member>
<member name="M:Cake.Core.IO.GlobPattern.op_Implicit(Cake.Core.IO.GlobPattern)~System.String">
<summary>
Performs an implicit conversion from <see cref="T:Cake.Core.IO.GlobPattern"/> to <see cref="T:System.String"/>.
</summary>
<param name="pattern">The glob pattern.</param>
<returns>A <see cref="T:Cake.Core.IO.GlobPattern"/>.</returns>
</member>
<member name="M:Cake.Core.IO.GlobPattern.FromString(System.String)">
<summary>
Performs a conversion from <see cref="T:System.String"/> to <see cref="T:Cake.Core.IO.GlobPattern"/>.
</summary>
<param name="pattern">The pattern.</param>
<returns>A <see cref="T:Cake.Core.IO.GlobPattern"/>.</returns>
</member>
<member name="M:Cake.Core.IO.GlobPattern.Equals(System.Object)">
<summary>
Determines whether two <see cref="T:Cake.Core.IO.GlobPattern"/>. instances are equal.
</summary>
<param name="obj">The object to compare with the current object.</param>
<returns>
<c>true</c> if the specified object is equal to the current object; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Cake.Core.IO.GlobPattern.GetHashCode">
<summary>
Returns the hash code for the <see cref="T:Cake.Core.IO.GlobPattern"/>.
</summary>
<returns>
A 32-bit signed integer hash code.
</returns>
</member>
<member name="M:Cake.Core.IO.GlobPattern.ToString">
<summary>
Returns a <see cref="T:System.String" /> that represents this instance.
</summary>
<returns>
A <see cref="T:System.String" /> that represents this instance.
</returns>
</member>
<member name="T:Cake.Core.IO.IDirectory">
<summary>
Represents a directory.
</summary>
</member>
<member name="P:Cake.Core.IO.IDirectory.Path">
<summary>
Gets the path to the directory.
</summary>
<value>The path.</value>
</member>
<member name="M:Cake.Core.IO.IDirectory.Create">
<summary>
Creates the directory.
</summary>
</member>
<member name="M:Cake.Core.IO.IDirectory.Move(Cake.Core.IO.DirectoryPath)">
<summary>
Moves the directory to the specified destination path.
</summary>
<param name="destination">The destination path.</param>
</member>
<member name="M:Cake.Core.IO.IDirectory.Delete(System.Boolean)">
<summary>
Deletes the directory.
</summary>
<param name="recursive">Will perform a recursive delete if set to <c>true</c>.</param>
</member>
<member name="M:Cake.Core.IO.IDirectory.GetDirectories(System.String,Cake.Core.IO.SearchScope)">
<summary>
Gets directories matching the specified filter and scope.
</summary>
<param name="filter">The filter.</param>
<param name="scope">The search scope.</param>
<returns>Directories matching the filter and scope.</returns>
</member>
<member name="M:Cake.Core.IO.IDirectory.GetFiles(System.String,Cake.Core.IO.SearchScope)">
<summary>
Gets files matching the specified filter and scope.
</summary>
<param name="filter">The filter.</param>
<param name="scope">The search scope.</param>
<returns>Files matching the specified filter and scope.</returns>
</member>
<member name="T:Cake.Core.IO.IFile">
<summary>
Represents a file.
</summary>
</member>
<member name="P:Cake.Core.IO.IFile.Path">
<summary>
Gets the path to the file.
</summary>
<value>The path.</value>
</member>
<member name="P:Cake.Core.IO.IFile.Length">
<summary>
Gets the length of the file.
</summary>
<value>The length of the file.</value>
</member>
<member name="P:Cake.Core.IO.IFile.Attributes">
<summary>
Gets or sets the file attributes.
</summary>
<value>The file attributes.</value>
</member>
<member name="M:Cake.Core.IO.IFile.Copy(Cake.Core.IO.FilePath,System.Boolean)">
<summary>
Copies the file to the specified destination path.
</summary>
<param name="destination">The destination path.</param>
<param name="overwrite">Will overwrite existing destination file if set to <c>true</c>.</param>
</member>
<member name="M:Cake.Core.IO.IFile.Move(Cake.Core.IO.FilePath)">
<summary>
Moves the file to the specified destination path.
</summary>
<param name="destination">The destination path.</param>
</member>
<member name="M:Cake.Core.IO.IFile.Delete">
<summary>
Deletes the file.
</summary>
</member>
<member name="M:Cake.Core.IO.IFile.Open(System.IO.FileMode,System.IO.FileAccess,System.IO.FileShare)">
<summary>
Opens the file using the specified options.
</summary>
<param name="fileMode">The file mode.</param>
<param name="fileAccess">The file access.</param>
<param name="fileShare">The file share.</param>
<returns>A <see cref="T:System.IO.Stream"/> to the file.</returns>
</member>
<member name="T:Cake.Core.IO.IFileSystem">
<summary>
Represents a file system.
</summary>
</member>
<member name="M:Cake.Core.IO.IFileSystem.GetFile(Cake.Core.IO.FilePath)">
<summary>
Gets a <see cref="T:Cake.Core.IO.IFile"/> instance representing the specified path.
</summary>
<param name="path">The path.</param>
<returns>A <see cref="T:Cake.Core.IO.IFile"/> instance representing the specified path.</returns>
</member>
<member name="M:Cake.Core.IO.IFileSystem.GetDirectory(Cake.Core.IO.DirectoryPath)">
<summary>
Gets a <see cref="T:Cake.Core.IO.IDirectory"/> instance representing the specified path.
</summary>
<param name="path">The path.</param>
<returns>A <see cref="T:Cake.Core.IO.IDirectory"/> instance representing the specified path.</returns>
</member>
<member name="T:Cake.Core.IO.IFileSystemInfo">
<summary>
Represents an entry in the file system.
</summary>
</member>
<member name="P:Cake.Core.IO.IFileSystemInfo.Path">
<summary>
Gets the path to the entry.
</summary>
<value>The path.</value>
</member>
<member name="P:Cake.Core.IO.IFileSystemInfo.Exists">
<summary>
Gets a value indicating whether this <see cref="T:Cake.Core.IO.IFileSystemInfo"/> exists.
</summary>
<value>
<c>true</c> if the entry exists; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Core.IO.IFileSystemInfo.Hidden">
<summary>
Gets a value indicating whether this <see cref="T:Cake.Core.IO.IFileSystemInfo"/> is hidden.
</summary>
<value>
<c>true</c> if the entry is hidden; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Core.IO.IGlobber">
<summary>
Represents a file system globber.
</summary>
</member>
<member name="M:Cake.Core.IO.IGlobber.Match(Cake.Core.IO.GlobPattern,Cake.Core.IO.GlobberSettings)">
<summary>
Returns <see cref="T:Cake.Core.IO.Path" /> instances matching the specified pattern.
</summary>
<param name="pattern">The pattern to match.</param>
<param name="settings">The globber settings.</param>
<returns>
<see cref="T:Cake.Core.IO.Path" /> instances matching the specified pattern.
</returns>
</member>
<member name="T:Cake.Core.IO.IProcess">
<summary>
Represents a process.
</summary>
</member>
<member name="M:Cake.Core.IO.IProcess.WaitForExit">
<summary>
Waits for the process to exit.
</summary>
</member>
<member name="M:Cake.Core.IO.IProcess.WaitForExit(System.Int32)">
<summary>
Waits for the process to exit with possible timeout for command.
</summary>
<param name="milliseconds">The amount of time, in milliseconds, to wait for the associated process to exit. The maximum is the largest possible value of a 32-bit integer, which represents infinity to the operating system.</param>
<returns>true if the associated process has exited; otherwise, false.</returns>
</member>
<member name="M:Cake.Core.IO.IProcess.GetExitCode">
<summary>
Gets the exit code of the process.
</summary>
<returns>The exit code of the process.</returns>
</member>
<member name="M:Cake.Core.IO.IProcess.GetStandardError">
<summary>
Get the standard error of process.
</summary>
<returns>Returns process error output if <see cref="P:Cake.Core.IO.ProcessSettings.RedirectStandardError">RedirectStandardError</see> is true.</returns>
</member>
<member name="M:Cake.Core.IO.IProcess.GetStandardOutput">
<summary>
Get the standard output of process.
</summary>
<returns>Returns process output if <see cref="P:Cake.Core.IO.ProcessSettings.RedirectStandardOutput">RedirectStandardOutput</see> is true.</returns>
</member>
<member name="M:Cake.Core.IO.IProcess.Kill">
<summary>
Immediately stops the associated process.
</summary>
</member>
<member name="T:Cake.Core.IO.IProcessArgument">
<summary>
Represents a process argument.
</summary>
</member>
<member name="M:Cake.Core.IO.IProcessArgument.Render">
<summary>
Render the arguments as a <see cref="T:System.String"/>.
Sensitive information will be included.
</summary>
<returns>A string representation of the argument.</returns>
</member>
<member name="M:Cake.Core.IO.IProcessArgument.RenderSafe">
<summary>
Renders the argument as a <see cref="T:System.String"/>.
Sensitive information will be redacted.
</summary>
<returns>A safe string representation of the argument.</returns>
</member>
<member name="T:Cake.Core.IO.IProcessRunner">
<summary>
Represents a process runner.
</summary>
</member>
<member name="M:Cake.Core.IO.IProcessRunner.Start(Cake.Core.IO.FilePath,Cake.Core.IO.ProcessSettings)">
<summary>
Starts a process using the specified information.
</summary>
<param name="filePath">The file name such as an application or document with which to start the process.</param>
<param name="settings">The information about the process to start.</param>
<returns>A process handle.</returns>
</member>
<member name="T:Cake.Core.IO.IRegistry">
<summary>
Represents the Windows registry.
</summary>
</member>
<member name="P:Cake.Core.IO.IRegistry.CurrentUser">
<summary>
Gets a registry key representing HKEY_CURRENT_USER.
</summary>
<value>
A registry key representing HKEY_CURRENT_USER.
</value>
</member>
<member name="P:Cake.Core.IO.IRegistry.LocalMachine">
<summary>
Gets a registry key representing HKEY_LOCAL_MACHINE.
</summary>
<value>
A registry key representing HKEY_LOCAL_MACHINE.
</value>
</member>
<member name="P:Cake.Core.IO.IRegistry.ClassesRoot">
<summary>
Gets a registry key representing HKEY_CLASSES_ROOT.
</summary>
<value>
A registry key representing HKEY_CLASSES_ROOT.
</value>
</member>
<member name="P:Cake.Core.IO.IRegistry.Users">
<summary>
Gets a registry key representing HKEY_USERS.
</summary>
<value>
A registry key representing HKEY_USERS.
</value>
</member>
<member name="P:Cake.Core.IO.IRegistry.PerformanceData">
<summary>
Gets a registry key representing HKEY_PERFORMANCE_DATA.
</summary>
<value>
A registry key representing HKEY_PERFORMANCE_DATA.
</value>
</member>
<member name="P:Cake.Core.IO.IRegistry.CurrentConfig">
<summary>
Gets a registry key representing HKEY_CURRENT_CONFIG.
</summary>
<value>
A registry key representing HKEY_CURRENT_CONFIG.
</value>
</member>
<member name="T:Cake.Core.IO.IRegistryKey">
<summary>
Represents a Windows registry key.
</summary>
</member>
<member name="M:Cake.Core.IO.IRegistryKey.GetSubKeyNames">
<summary>
Gets all sub keys.
</summary>
<returns>All sub keys.</returns>
</member>
<member name="M:Cake.Core.IO.IRegistryKey.OpenKey(System.String)">
<summary>
Opens the sub key with the specified name.
</summary>
<param name="name">The name of the key.</param>
<returns>The sub key with the specified name.</returns>
</member>
<member name="M:Cake.Core.IO.IRegistryKey.GetValue(System.String)">
<summary>
Gets the value of the key.
</summary>
<param name="name">The name of the key.</param>
<returns>The value of the key.</returns>
</member>
<member name="T:Cake.Core.IO.NuGet.INuGetToolResolver">
<summary>
Represents a NuGet path resolver.
</summary>
</member>
<member name="M:Cake.Core.IO.NuGet.INuGetToolResolver.ResolvePath">
<summary>
Resolves the path to nuget.exe.
</summary>
<returns>The path to nuget.exe.</returns>
</member>
<member name="T:Cake.Core.IO.NuGet.NuGetToolResolver">
<summary>
Contains NuGet path resolver functionality.
</summary>
</member>
<member name="M:Cake.Core.IO.NuGet.NuGetToolResolver.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.NuGet.NuGetToolResolver" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Core.IO.NuGet.NuGetToolResolver.ResolvePath">
<inheritdoc/>
</member>
<member name="T:Cake.Core.IO.NuGet.NamespaceDoc">
<summary>
This namespace contain types
related to NuGet functionality.
</summary>
</member>
<member name="T:Cake.Core.IO.Path">
<summary>
Provides properties and instance methods for working with paths.
This class must be inherited.
</summary>
</member>
<member name="P:Cake.Core.IO.Path.FullPath">
<summary>
Gets the full path.
</summary>
<value>The full path.</value>
</member>
<member name="P:Cake.Core.IO.Path.IsRelative">
<summary>
Gets a value indicating whether or not this path is relative.
</summary>
<value>
<c>true</c> if this path is relative; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Core.IO.Path.IsUNC">
<summary>
Gets a value indicating whether or not this path is an UNC path.
</summary>
<value>
<c>true</c> if this path is an UNC path; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Core.IO.Path.Separator">
<summary>
Gets the separator this path was normalized with.
</summary>
</member>
<member name="P:Cake.Core.IO.Path.Segments">
<summary>
Gets the segments making up the path.
</summary>
<value>The segments making up the path.</value>
</member>
<member name="M:Cake.Core.IO.Path.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.Path"/> class.
</summary>
<param name="path">The path.</param>
</member>
<member name="M:Cake.Core.IO.Path.ToString">
<summary>
Returns a <see cref="T:System.String" /> that represents this path.
</summary>
<returns>
A <see cref="T:System.String" /> that represents this instance.
</returns>
</member>
<member name="T:Cake.Core.IO.PathCollection">
<summary>
A collection of <see cref="T:Cake.Core.IO.Path"/>.
</summary>
</member>
<member name="P:Cake.Core.IO.PathCollection.Count">
<summary>
Gets the number of paths in the collection.
</summary>
<value>The number of paths in the collection.</value>
</member>
<member name="M:Cake.Core.IO.PathCollection.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.PathCollection"/> class.
</summary>
</member>
<member name="M:Cake.Core.IO.PathCollection.#ctor(Cake.Core.IO.PathComparer)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.PathCollection"/> class.
</summary>
<param name="comparer">The comparer.</param>
</member>
<member name="M:Cake.Core.IO.PathCollection.#ctor(System.Collections.Generic.IEnumerable{Cake.Core.IO.Path})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.PathCollection"/> class.
</summary>
<param name="paths">The paths.</param>
</member>
<member name="M:Cake.Core.IO.PathCollection.#ctor(System.Collections.Generic.IEnumerable{Cake.Core.IO.Path},Cake.Core.IO.PathComparer)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.PathCollection"/> class.
</summary>
<param name="paths">The paths.</param>
<param name="comparer">The comparer.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="comparer"/> is <c>null</c>.</exception>
</member>
<member name="M:Cake.Core.IO.PathCollection.Add(Cake.Core.IO.Path)">
<summary>
Adds the specified path to the collection.
</summary>
<param name="path">The path to add.</param>
<returns>
<c>true</c> if the path was added; <c>false</c> if the path was already present.
</returns>
</member>
<member name="M:Cake.Core.IO.PathCollection.Add(System.Collections.Generic.IEnumerable{Cake.Core.IO.Path})">
<summary>
Adds the specified paths to the collection.
</summary>
<param name="paths">The paths to add.</param>
</member>
<member name="M:Cake.Core.IO.PathCollection.Remove(Cake.Core.IO.Path)">
<summary>
Removes the specified path from the collection.
</summary>
<param name="path">The path to remove.</param>
<returns>
<c>true</c> if the path was removed; <c>false</c> if the path was not found in the collection.
</returns>
</member>
<member name="M:Cake.Core.IO.PathCollection.Remove(System.Collections.Generic.IEnumerable{Cake.Core.IO.Path})">
<summary>
Removes the specified paths from the collection.
</summary>
<param name="paths">The paths to remove.</param>
</member>
<member name="M:Cake.Core.IO.PathCollection.op_Addition(Cake.Core.IO.PathCollection,Cake.Core.IO.Path)">
<summary>Adds a path to the collection.</summary>
<param name="collection">The collection.</param>
<param name="path">The path to add.</param>
<returns>A new <see cref="T:Cake.Core.IO.PathCollection"/> that contains the provided path as
well as the paths in the original collection.</returns>
</member>
<member name="M:Cake.Core.IO.PathCollection.op_Addition(Cake.Core.IO.PathCollection,System.Collections.Generic.IEnumerable{Cake.Core.IO.Path})">
<summary>Adds multiple paths to the collection.</summary>
<param name="collection">The collection.</param>
<param name="paths">The paths to add.</param>
<returns>A new <see cref="T:Cake.Core.IO.PathCollection"/> with the content of both collections.</returns>
</member>
<member name="M:Cake.Core.IO.PathCollection.op_Subtraction(Cake.Core.IO.PathCollection,Cake.Core.IO.Path)">
<summary>
Removes a path from the collection.
</summary>
<param name="collection">The collection.</param>
<param name="path">The path to remove.</param>
<returns>A new <see cref="T:Cake.Core.IO.PathCollection"/> that do not contain the provided path.</returns>
</member>
<member name="M:Cake.Core.IO.PathCollection.op_Subtraction(Cake.Core.IO.PathCollection,System.Collections.Generic.IEnumerable{Cake.Core.IO.Path})">
<summary>
Removes multiple paths from the collection.
</summary>
<param name="collection">The collection.</param>
<param name="paths">The paths to remove.</param>
<returns>A new <see cref="T:Cake.Core.IO.PathCollection"/> that do not contain the provided paths.</returns>
</member>
<member name="M:Cake.Core.IO.PathCollection.GetEnumerator">
<summary>
Returns an enumerator that iterates through the collection.
</summary>
<returns>
A <see cref="T:System.Collections.Generic.IEnumerator`1" /> that can be used to iterate through the collection.
</returns>
</member>
<member name="M:Cake.Core.IO.PathCollection.System#Collections#IEnumerable#GetEnumerator">
<summary>
Returns an enumerator that iterates through a collection.
</summary>
<returns>
An <see cref="T:System.Collections.IEnumerator" /> that can be used to iterate through the collection.
</returns>
</member>
<member name="T:Cake.Core.IO.PathComparer">
<summary>
Compares <see cref="T:Cake.Core.IO.Path"/> instances.
</summary>
</member>
<member name="F:Cake.Core.IO.PathComparer.Default">
<summary>
The default path comparer.
</summary>
</member>
<member name="P:Cake.Core.IO.PathComparer.IsCaseSensitive">
<summary>
Gets a value indicating whether comparison is case sensitive.
</summary>
<value>
<c>true</c> if comparison is case sensitive; otherwise, <c>false</c>.
</value>
</member>
<member name="M:Cake.Core.IO.PathComparer.#ctor(System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.PathComparer"/> class.
</summary>
<param name="isCaseSensitive">if set to <c>true</c>, comparison is case sensitive.</param>
</member>
<member name="M:Cake.Core.IO.PathComparer.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.PathComparer"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Core.IO.PathComparer.Equals(Cake.Core.IO.Path,Cake.Core.IO.Path)">
<summary>
Determines whether the specified <see cref="T:Cake.Core.IO.Path"/> instances are equal.
</summary>
<param name="x">The first <see cref="T:Cake.Core.IO.Path"/> to compare.</param>
<param name="y">The second <see cref="T:Cake.Core.IO.Path"/> to compare.</param>
<returns>
True if the specified <see cref="T:Cake.Core.IO.Path"/> instances are equal; otherwise, false.
</returns>
</member>
<member name="M:Cake.Core.IO.PathComparer.GetHashCode(Cake.Core.IO.Path)">
<summary>
Returns a hash code for the specified <see cref="T:Cake.Core.IO.Path"/>.
</summary>
<param name="obj">The path.</param>
<returns>
A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
</returns>
</member>
<member name="T:Cake.Core.IO.PathExtensions">
<summary>
Contains extensions for <see cref="T:Cake.Core.IO.FilePath"/> and <see cref="T:Cake.Core.IO.DirectoryPath"/>.
</summary>
</member>
<member name="M:Cake.Core.IO.PathExtensions.ExpandEnvironmentVariables(Cake.Core.IO.FilePath,Cake.Core.ICakeEnvironment)">
<summary>
Expands all environment variables in the provided <see cref="T:Cake.Core.IO.FilePath"/>.
</summary>
<example>
<code>
var path = new FilePath("%APPDATA%/foo.bar");
var expanded = path.ExpandEnvironmentVariables(environment);
</code>
</example>
<param name="path">The file path to expand.</param>
<param name="environment">The environment.</param>
<returns>A new <see cref="T:Cake.Core.IO.FilePath"/> with each environment variable replaced by its value.</returns>
</member>
<member name="M:Cake.Core.IO.PathExtensions.ExpandEnvironmentVariables(Cake.Core.IO.DirectoryPath,Cake.Core.ICakeEnvironment)">
<summary>
Expands all environment variables in the provided <see cref="T:Cake.Core.IO.DirectoryPath"/>.
</summary>
<example>
<code>
var path = new DirectoryPath("%APPDATA%");
var expanded = path.ExpandEnvironmentVariables(environment);
</code>
</example>
<param name="path">The directory to expand.</param>
<param name="environment">The environment.</param>
<returns>A new <see cref="T:Cake.Core.IO.DirectoryPath"/> with each environment variable replaced by its value.</returns>
</member>
<member name="T:Cake.Core.IO.ProcessArgumentBuilder">
<summary>
Utility for building process arguments.
</summary>
</member>
<member name="P:Cake.Core.IO.ProcessArgumentBuilder.Count">
<summary>
Gets the number of arguments contained in the <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.
</summary>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> class.
</summary>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.Clear">
<summary>
Clears all arguments from the builder.
</summary>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.Append(Cake.Core.IO.IProcessArgument)">
<summary>
Appends an argument.
</summary>
<param name="argument">The argument.</param>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.Prepend(Cake.Core.IO.IProcessArgument)">
<summary>
Prepends an argument.
</summary>
<param name="argument">The argument.</param>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.Render">
<summary>
Renders the arguments as a <see cref="T:System.String"/>.
Sensitive information will be included.
</summary>
<returns>A string representation of the arguments.</returns>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.RenderSafe">
<summary>
Renders the arguments as a <see cref="T:System.String"/>.
Sensitive information will be redacted.
</summary>
<returns>A safe string representation of the arguments.</returns>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.FilterUnsafe(System.String)">
<summary>
Tries to filer any unsafe arguments from string.
</summary>
<param name="source">unsafe source string.</param>
<returns>Filtered string.</returns>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.op_Implicit(System.String)~Cake.Core.IO.ProcessArgumentBuilder">
<summary>
Performs an implicit conversion from <see cref="T:System.String"/> to <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.
</summary>
<param name="value">The text value to convert.</param>
<returns>A <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.</returns>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.FromString(System.String)">
<summary>
Performs a conversion from <see cref="T:System.String"/> to <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.
</summary>
<param name="value">The text value to convert.</param>
<returns>A <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.</returns>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.FromStringQuoted(System.String)">
<summary>
Performs a conversion from <see cref="T:System.String"/> to <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.
</summary>
<param name="value">The text value to convert.</param>
<returns>A <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.</returns>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.FromStrings(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Performs a conversion from <see cref="T:System.Collections.Generic.IEnumerable`1"/> to <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.
</summary>
<param name="values">The text values to convert.</param>
<returns>A <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.</returns>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.FromStringsQuoted(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Performs a conversion from <see cref="T:System.Collections.Generic.IEnumerable`1"/> to <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.
</summary>
<param name="values">The text values to convert.</param>
<returns>A <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.</returns>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.System#Collections#Generic#IEnumerable{Cake#Core#IO#IProcessArgument}#GetEnumerator">
<summary>
Returns an enumerator that iterates through the collection.
</summary>
<returns>
An enumerator that can be used to iterate through the collection.
</returns>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.System#Collections#IEnumerable#GetEnumerator">
<summary>
Returns an enumerator that iterates through a collection.
</summary>
<returns>
An <see cref="T:System.Collections.IEnumerator" /> that can be used to iterate through the collection.
</returns>
</member>
<member name="T:Cake.Core.IO.ProcessRunner">
<summary>
Responsible for starting processes.
</summary>
</member>
<member name="M:Cake.Core.IO.ProcessRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.Diagnostics.ICakeLog,Cake.Core.Tooling.IToolLocator,Cake.Core.Configuration.ICakeConfiguration)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.ProcessRunner" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="log">The log.</param>
<param name="tools">The tool locator.</param>
<param name="configuration">The tool configuration.</param>
</member>
<member name="M:Cake.Core.IO.ProcessRunner.Start(Cake.Core.IO.FilePath,Cake.Core.IO.ProcessSettings)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.IO.ProcessSettings">
<summary>
Specifies a set of values that are used to start a process.
</summary>
</member>
<member name="P:Cake.Core.IO.ProcessSettings.Arguments">
<summary>
Gets or sets the set of command-line arguments to use when starting the application.
</summary>
<value>The set of command-line arguments to use when starting the application.</value>
</member>
<member name="P:Cake.Core.IO.ProcessSettings.WorkingDirectory">
<summary>
Gets or sets the working directory for the process to be started.
</summary>
<value>The working directory for the process to be started.</value>
</member>
<member name="P:Cake.Core.IO.ProcessSettings.NoWorkingDirectory">
<summary>
Gets or sets a value indicating whether or not to opt out of using
an explicit working directory for the process.
</summary>
</member>
<member name="P:Cake.Core.IO.ProcessSettings.RedirectStandardError">
<summary>
Gets or sets a value indicating whether the error output of an application is written to the standard error stream.
</summary>
<value>true if error output should be redirected; false if error output should be written to the standard error stream. The default is false.</value>
</member>
<member name="P:Cake.Core.IO.ProcessSettings.RedirectStandardOutput">
<summary>
Gets or sets a value indicating whether the output of an application is written to the standard output stream.
</summary>
<value>true if output should be redirected; false if output should be written to the standard output stream. The default is false.</value>
</member>
<member name="P:Cake.Core.IO.ProcessSettings.RedirectedStandardErrorHandler">
<summary>
Gets or sets a function that intercepts the error output before being redirected. Use in conjunction with <see cref="P:Cake.Core.IO.ProcessSettings.RedirectStandardError"/>.
</summary>
</member>
<member name="P:Cake.Core.IO.ProcessSettings.RedirectedStandardOutputHandler">
<summary>
Gets or sets a function that intercepts the standard output before being redirected. Use in conjunction with <see cref="P:Cake.Core.IO.ProcessSettings.RedirectStandardOutput"/>.
</summary>
</member>
<member name="P:Cake.Core.IO.ProcessSettings.Timeout">
<summary>
Gets or sets optional timeout, in milliseconds, to wait for the associated process to exit. The maximum is the largest possible value of a 32-bit integer, which represents infinity to the operating system.
</summary>
</member>
<member name="P:Cake.Core.IO.ProcessSettings.Silent">
<summary>
Gets or sets a value indicating whether process output will be suppressed.
</summary>
<value>
<c>true</c> if process output will be suppressed; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Core.IO.ProcessSettings.EnvironmentVariables">
<summary>
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
</summary>
<example>
<code>
StartProcess("cmd", new ProcessSettings{
Arguments = "/c set",
EnvironmentVariables = new Dictionary<string, string>{
{ "CI", "True" },
{ "TEMP", MakeAbsolute(Directory("./Temp")).FullPath }
}
});
</code>
</example>
</member>
<member name="T:Cake.Core.IO.SearchScope">
<summary>
Represents a search scope.
</summary>
</member>
<member name="F:Cake.Core.IO.SearchScope.Current">
<summary>
The current directory.
</summary>
</member>
<member name="F:Cake.Core.IO.SearchScope.Recursive">
<summary>
The current directory and child directories.
</summary>
</member>
<member name="T:Cake.Core.IO.SpecialPath">
<summary>
Represents a special path.
</summary>
</member>
<member name="F:Cake.Core.IO.SpecialPath.ApplicationData">
<summary>
The directory that serves as a common repository for application-specific
data for the current roaming user.
</summary>
</member>
<member name="F:Cake.Core.IO.SpecialPath.CommonApplicationData">
<summary>
The directory that serves as a common repository for application-specific
data that is used by all users.
</summary>
</member>
<member name="F:Cake.Core.IO.SpecialPath.LocalApplicationData">
<summary>
The directory that serves as a common repository for application-specific
data that is used by the current, non-roaming user.
</summary>
</member>
<member name="F:Cake.Core.IO.SpecialPath.ProgramFiles">
<summary>
The Program Files folder.
</summary>
</member>
<member name="F:Cake.Core.IO.SpecialPath.ProgramFilesX86">
<summary>
The Program Files (X86) folder.
</summary>
</member>
<member name="F:Cake.Core.IO.SpecialPath.Windows">
<summary>
The Windows folder.
</summary>
</member>
<member name="F:Cake.Core.IO.SpecialPath.LocalTemp">
<summary>
The current user's temporary folder.
</summary>
</member>
<member name="T:Cake.Core.IO.WindowsRegistry">
<summary>
Represents an Windows implementation of <see cref="T:Cake.Core.IO.IRegistry"/>.
</summary>
</member>
<member name="P:Cake.Core.IO.WindowsRegistry.CurrentUser">
<inheritdoc/>
</member>
<member name="P:Cake.Core.IO.WindowsRegistry.LocalMachine">
<inheritdoc/>
</member>
<member name="P:Cake.Core.IO.WindowsRegistry.ClassesRoot">
<inheritdoc/>
</member>
<member name="P:Cake.Core.IO.WindowsRegistry.Users">
<inheritdoc/>
</member>
<member name="P:Cake.Core.IO.WindowsRegistry.PerformanceData">
<inheritdoc/>
</member>
<member name="P:Cake.Core.IO.WindowsRegistry.CurrentConfig">
<inheritdoc/>
</member>
<member name="T:Cake.Core.IO.NamespaceDoc">
<summary>
This namespace contain fundamental types that support
input and output, including the ability to read and write data
to streams and to interact with the file system.
</summary>
</member>
<member name="T:Cake.Core.ISetupContext">
<summary>
Acts as a context providing info about the overall build before its started.
</summary>
</member>
<member name="P:Cake.Core.ISetupContext.TargetTask">
<summary>
Gets target (initiating) task.
</summary>
</member>
<member name="P:Cake.Core.ISetupContext.TasksToExecute">
<summary>
Gets all registered tasks that are going to be executed.
</summary>
</member>
<member name="T:Cake.Core.ITaskSetupContext">
<summary>
Acts as a context providing info about a <see cref="T:Cake.Core.CakeTask"/> before its invocation.
</summary>
</member>
<member name="P:Cake.Core.ITaskSetupContext.Task">
<summary>
Gets the <see cref="T:Cake.Core.ICakeTaskInfo"/> describing the <see cref="T:Cake.Core.CakeTask"/> that has just been invoked.
</summary>
<value>
The task.
</value>
</member>
<member name="T:Cake.Core.ITaskTeardownContext">
<summary>
Acts as a context providing info about a <see cref="T:Cake.Core.CakeTask"/> following its invocation.
</summary>
</member>
<member name="P:Cake.Core.ITaskTeardownContext.Task">
<summary>
Gets the <see cref="T:Cake.Core.ICakeTaskInfo"/> describing the <see cref="T:Cake.Core.CakeTask"/> that has just been invoked.
</summary>
<value>
The task.
</value>
</member>
<member name="P:Cake.Core.ITaskTeardownContext.Duration">
<summary>
Gets the duration of the <see cref="T:Cake.Core.CakeTask"/>'s execution.
</summary>
<value>
The duration of the <see cref="T:Cake.Core.CakeTask"/>'s execution.
</value>
</member>
<member name="P:Cake.Core.ITaskTeardownContext.Skipped">
<summary>
Gets a value indicating whether this <see cref="T:Cake.Core.CakeTask"/> was skipped (not executed).
</summary>
<value>
<c>true</c> if skipped; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Core.ITaskTeardownContext.Successful">
<summary>
Gets a value indicating whether this <see cref="T:Cake.Core.CakeTask"/> was successful.
</summary>
<value>
<c>true</c> if successful; otherwise <c>false</c>.
</value>
</member>
<member name="P:Cake.Core.ITaskTeardownContext.ThrownException">
<summary>
Gets the exception that was thrown by the tasl.
</summary>
</member>
<member name="T:Cake.Core.ITeardownContext">
<summary>
Acts as a context providing info about the overall build following its completion.
</summary>
</member>
<member name="P:Cake.Core.ITeardownContext.Successful">
<summary>
Gets a value indicating whether this build was successful.
</summary>
<value>
<c>true</c> if successful; otherwise <c>false</c>.
</value>
</member>
<member name="P:Cake.Core.ITeardownContext.ThrownException">
<summary>
Gets the exception that was thrown by the target.
</summary>
</member>
<member name="T:Cake.Core.Modules.CoreModule">
<summary>
The module responsible for registering
default types in the Cake.Core assembly.
</summary>
</member>
<member name="M:Cake.Core.Modules.CoreModule.Register(Cake.Core.Composition.ICakeContainerRegistrar)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Packaging.IPackageInstaller">
<summary>
Represents an installer for a specific package.
</summary>
</member>
<member name="M:Cake.Core.Packaging.IPackageInstaller.CanInstall(Cake.Core.Packaging.PackageReference,Cake.Core.Packaging.PackageType)">
<summary>
Determines whether this instance can install the specified resource.
</summary>
<param name="package">The package resource.</param>
<param name="type">The package type.</param>
<returns>
<c>true</c> if this installer can install the
specified resource; otherwise <c>false</c>.
</returns>
</member>
<member name="M:Cake.Core.Packaging.IPackageInstaller.Install(Cake.Core.Packaging.PackageReference,Cake.Core.Packaging.PackageType,Cake.Core.IO.DirectoryPath)">
<summary>
Installs the specified resource at the given location.
</summary>
<param name="package">The package resource.</param>
<param name="type">The package type.</param>
<param name="path">The location where to install the resource.</param>
<returns>The installed files.</returns>
</member>
<member name="T:Cake.Core.Packaging.PackageReference">
<summary>
Represents an URI resource.
</summary>
</member>
<member name="P:Cake.Core.Packaging.PackageReference.OriginalString">
<summary>
Gets the original string.
</summary>
<value>The original string.</value>
</member>
<member name="P:Cake.Core.Packaging.PackageReference.Scheme">
<summary>
Gets the scheme.
</summary>
<value>The scheme.</value>
</member>
<member name="P:Cake.Core.Packaging.PackageReference.Address">
<summary>
Gets the address.
</summary>
<value>The address.</value>
</member>
<member name="P:Cake.Core.Packaging.PackageReference.Parameters">
<summary>
Gets the parameters.
</summary>
<value>The parameters.</value>
</member>
<member name="P:Cake.Core.Packaging.PackageReference.Package">
<summary>
Gets the package.
</summary>
<value>The package.</value>
</member>
<member name="M:Cake.Core.Packaging.PackageReference.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Packaging.PackageReference"/> class.
</summary>
<param name="uri">The URI.</param>
</member>
<member name="M:Cake.Core.Packaging.PackageReference.#ctor(System.Uri)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Packaging.PackageReference"/> class.
</summary>
<param name="uri">The URI.</param>
<exception cref="T:System.ArgumentException">Package query string parameter is missing.;uri.</exception>
</member>
<member name="T:Cake.Core.Packaging.PackageType">
<summary>
Represents a package type.
</summary>
</member>
<member name="F:Cake.Core.Packaging.PackageType.Unspecified">
<summary>
Represents an unspecified package type.
</summary>
</member>
<member name="F:Cake.Core.Packaging.PackageType.Addin">
<summary>
Represents an addin.
</summary>
</member>
<member name="F:Cake.Core.Packaging.PackageType.Tool">
<summary>
Represents a tool.
</summary>
</member>
<member name="F:Cake.Core.Packaging.PackageType.Module">
<summary>
Represents a module.
</summary>
</member>
<member name="T:Cake.Core.PlatformFamily">
<summary>
Represents a platform family.
</summary>
</member>
<member name="F:Cake.Core.PlatformFamily.Unknown">
<summary>
The platform family is unknown.
</summary>
</member>
<member name="F:Cake.Core.PlatformFamily.Windows">
<summary>
Represents the Windows platform family.
</summary>
</member>
<member name="F:Cake.Core.PlatformFamily.Linux">
<summary>
Represents the Linux platform family.
</summary>
</member>
<member name="F:Cake.Core.PlatformFamily.OSX">
<summary>
Represents the OSX platform family.
</summary>
</member>
<member name="T:Cake.Core.Polyfill.Runtime">
<summary>
The current Runtime Cake is executing on.
</summary>
</member>
<member name="F:Cake.Core.Polyfill.Runtime.Clr">
<summary>
Full Framework or Mono.
</summary>
</member>
<member name="F:Cake.Core.Polyfill.Runtime.CoreClr">
<summary>
.NET Core or .NET 5+.
</summary>
</member>
<member name="T:Cake.Core.NamespaceDoc">
<summary>
The <see cref="N:Cake.Core"/> namespace contains fundamental classes and
base classes for Cake and the Cake scripting environment.
</summary>
</member>
<member name="T:Cake.Core.Scripting.NamespaceDoc">
<summary>
This namespace contain types
related to script processing and execution.
</summary>
</member>
<member name="T:Cake.Core.Scripting.Processors.NamespaceDoc">
<summary>
This namespace contain types
related to script processing.
</summary>
</member>
<member name="T:Cake.Core.Scripting.Processors.LineProcessor">
<summary>
Abstract line processor.
</summary>
</member>
<member name="M:Cake.Core.Scripting.Processors.LineProcessor.Process(Cake.Core.Scripting.Analysis.IScriptAnalyzerContext,System.String,System.String@)">
<summary>
Processes the specified line.
</summary>
<param name="analyzer">The analyzer.</param>
<param name="line">The line.</param>
<param name="replacement">The replacement for line, null if no replacement.</param>
<returns><c>true</c> if the line was processed
by this processor; otherwise <c>false</c>.</returns>
</member>
<member name="M:Cake.Core.Scripting.Processors.LineProcessor.Split(System.String)">
<summary>
Splits the specified line into tokens.
</summary>
<param name="line">The line to split.</param>
<returns>The parts that make up the line.</returns>
</member>
<member name="T:Cake.Core.Scripting.Processors.Loading.ILoadDirectiveProvider">
<summary>
Represents a load directive provider.
</summary>
</member>
<member name="M:Cake.Core.Scripting.Processors.Loading.ILoadDirectiveProvider.CanLoad(Cake.Core.Scripting.Analysis.IScriptAnalyzerContext,Cake.Core.Scripting.Processors.Loading.LoadReference)">
<summary>
Indicates whether or not this provider can load the specified <see cref="T:Cake.Core.Scripting.Processors.Loading.LoadReference"/>.
</summary>
<param name="context">The context.</param>
<param name="reference">The reference to the code to load.</param>
<returns><c>true</c> if the provider can load the reference; otherwise <c>false</c>.</returns>
</member>
<member name="M:Cake.Core.Scripting.Processors.Loading.ILoadDirectiveProvider.Load(Cake.Core.Scripting.Analysis.IScriptAnalyzerContext,Cake.Core.Scripting.Processors.Loading.LoadReference)">
<summary>
Loads the specified <see cref="T:Cake.Core.Scripting.Processors.Loading.LoadReference"/>.
</summary>
<param name="context">The context.</param>
<param name="reference">The reference to load.</param>
</member>
<member name="T:Cake.Core.Scripting.Processors.Loading.LoadReference">
<summary>
Represents a resource to load via the #load directive.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Processors.Loading.LoadReference.OriginalString">
<summary>
Gets the original string.
</summary>
<value>The original string.</value>
</member>
<member name="P:Cake.Core.Scripting.Processors.Loading.LoadReference.Scheme">
<summary>
Gets the scheme.
</summary>
<value>The scheme.</value>
</member>
<member name="P:Cake.Core.Scripting.Processors.Loading.LoadReference.Address">
<summary>
Gets the address.
</summary>
<value>The address.</value>
</member>
<member name="P:Cake.Core.Scripting.Processors.Loading.LoadReference.Parameters">
<summary>
Gets the parameters.
</summary>
<value>The parameters.</value>
</member>
<member name="M:Cake.Core.Scripting.Processors.Loading.LoadReference.#ctor(System.Uri)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Scripting.Processors.Loading.LoadReference"/> class.
</summary>
<param name="uri">The URI.</param>
</member>
<member name="T:Cake.Core.Scripting.Analysis.IScriptAnalyzer">
<summary>
Represents the script analyzer responsible for
parsing and analyzing scripts.
</summary>
</member>
<member name="M:Cake.Core.Scripting.Analysis.IScriptAnalyzer.Analyze(Cake.Core.IO.FilePath,Cake.Core.Scripting.Analysis.ScriptAnalyzerSettings)">
<summary>
Analyzes the specified script path.
</summary>
<param name="path">The path to the script to analyze.</param>
<param name="settings">The script analyzer settings.</param>
<returns>The script analysis result.</returns>
</member>
<member name="T:Cake.Core.Scripting.Analysis.IScriptAnalyzerContext">
<summary>
Represents the context used by the <see cref="T:Cake.Core.Scripting.Analysis.ScriptAnalyzer"/>.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptAnalyzerContext.Root">
<summary>
Gets the path to the initial script being executed.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptAnalyzerContext.Current">
<summary>
Gets the current script being processed.
</summary>
<value>The current script being processed.</value>
</member>
<member name="M:Cake.Core.Scripting.Analysis.IScriptAnalyzerContext.Analyze(Cake.Core.IO.FilePath)">
<summary>
Processes the specified script path using the same context.
</summary>
<param name="scriptPath">The script path to process.</param>
</member>
<member name="M:Cake.Core.Scripting.Analysis.IScriptAnalyzerContext.AddScriptLine(System.String)">
<summary>
Adds a script line to the result.
</summary>
<param name="line">The script line to add.</param>
</member>
<member name="M:Cake.Core.Scripting.Analysis.IScriptAnalyzerContext.AddScriptError(System.String)">
<summary>
Adds a script error to the result.
</summary>
<param name="error">The script error to add.</param>
</member>
<member name="T:Cake.Core.Scripting.Analysis.IScriptInformation">
<summary>
Represents information about a script.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptInformation.Path">
<summary>
Gets the script path.
</summary>
<value>The script path.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptInformation.Includes">
<summary>
Gets the includes.
</summary>
<value>The includes.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptInformation.References">
<summary>
Gets the referenced script assemblies.
</summary>
<value>The referenced script assemblies.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptInformation.Namespaces">
<summary>
Gets all namespaces referenced by the script.
</summary>
<value>The namespaces referenced by the script.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptInformation.UsingAliases">
<summary>
Gets all using aliases defined by the scripts.
</summary>
<value>The using aliases defined by the script.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptInformation.UsingStaticDirectives">
<summary>
Gets all types referenced with the using static directive.
</summary>
<value>The fully qualified type names referenced by using static in the script.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptInformation.Defines">
<summary>
Gets the defines directives defined by the scripts.
</summary>
<value>The defines.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptInformation.Tools">
<summary>
Gets the tools.
</summary>
<value>The tools.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptInformation.Addins">
<summary>
Gets the addins.
</summary>
<value>The addins.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptInformation.Modules">
<summary>
Gets the modules.
</summary>
<value>The modules.</value>
</member>
<member name="T:Cake.Core.Scripting.Analysis.ScriptAnalyzer">
<summary>
The script analyzer.
</summary>
</member>
<member name="M:Cake.Core.Scripting.Analysis.ScriptAnalyzer.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.Diagnostics.ICakeLog,System.Collections.Generic.IEnumerable{Cake.Core.Scripting.Processors.Loading.ILoadDirectiveProvider})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Scripting.Analysis.ScriptAnalyzer"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="log">The log.</param>
<param name="providers">The load directive providers.</param>
</member>
<member name="M:Cake.Core.Scripting.Analysis.ScriptAnalyzer.Analyze(Cake.Core.IO.FilePath,Cake.Core.Scripting.Analysis.ScriptAnalyzerSettings)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Scripting.Analysis.ScriptAnalyzerError">
<summary>
Represents a script analysis error.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerError.File">
<summary>
Gets the file containing the error.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerError.Line">
<summary>
Gets the line number for the error.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerError.Message">
<summary>
Gets the error message.
</summary>
</member>
<member name="M:Cake.Core.Scripting.Analysis.ScriptAnalyzerError.#ctor(Cake.Core.IO.FilePath,System.Int32,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Scripting.Analysis.ScriptAnalyzerError"/> class.
</summary>
<param name="file">The file containing the error.</param>
<param name="line">The line number for the error.</param>
<param name="message">The error message.</param>
</member>
<member name="T:Cake.Core.Scripting.Analysis.ScriptAnalyzerMode">
<summary>
Represents the script analyzer mode.
</summary>
</member>
<member name="F:Cake.Core.Scripting.Analysis.ScriptAnalyzerMode.Everything">
<summary>
Analyzes everything.
</summary>
</member>
<member name="F:Cake.Core.Scripting.Analysis.ScriptAnalyzerMode.Modules">
<summary>
Analyzes modules.
</summary>
</member>
<member name="T:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult">
<summary>
Represents a script analysis result.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.Script">
<summary>
Gets the analyzed script.
</summary>
<value>The script.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.Lines">
<summary>
Gets the merged script lines.
</summary>
<value>The merged script lines.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.References">
<summary>
Gets all references.
</summary>
<value>The references.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.Namespaces">
<summary>
Gets all the namespaces.
</summary>
<value>The namespaces.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.UsingAliases">
<summary>
Gets the using aliases.
</summary>
<value>The using aliases.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.UsingStaticDirectives">
<summary>
Gets all types referenced with the using static directive.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.Defines">
<summary>
Gets the defines.
</summary>
<value>The defines.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.Addins">
<summary>
Gets the addins.
</summary>
<value>The addins.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.Tools">
<summary>
Gets the tools.
</summary>
<value>The tools.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.Modules">
<summary>
Gets the modules.
</summary>
<value>The modules.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.Succeeded">
<summary>
Gets a value indicating whether to analysis succeeded without errors.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.Errors">
<summary>
Gets the list of analyzer errors.
</summary>
</member>
<member name="M:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.#ctor(Cake.Core.Scripting.Analysis.IScriptInformation,System.Collections.Generic.IReadOnlyList{System.String},System.Collections.Generic.IReadOnlyList{Cake.Core.Scripting.Analysis.ScriptAnalyzerError})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult"/> class.
</summary>
<param name="script">The script.</param>
<param name="lines">The merged script lines.</param>
<param name="errors">The analyzer errors.</param>
</member>
<member name="T:Cake.Core.Scripting.Analysis.ScriptAnalyzerSettings">
<summary>
Represents settings for the script analyzer.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerSettings.Mode">
<summary>
Gets or sets the analyzer mode.
</summary>
</member>
<member name="T:Cake.Core.Scripting.CodeGen.GenericParameterConstraintEmitter">
<summary>
Responsible for generating generic parameter constraints on generated generic methods.
</summary>
</member>
<member name="T:Cake.Core.Scripting.CodeGen.MethodAliasGenerator">
<summary>
Responsible for generating script method aliases.
</summary>
</member>
<member name="M:Cake.Core.Scripting.CodeGen.MethodAliasGenerator.Generate(System.Reflection.MethodInfo)">
<summary>
Generates a script method alias from the specified method.
The provided method must be an extension method for <see cref="T:Cake.Core.ICakeContext"/>
and it must be decorated with the <see cref="T:Cake.Core.Annotations.CakeMethodAliasAttribute"/>.
</summary>
<param name="method">The method to generate the code for.</param>
<returns>The generated code.</returns>
</member>
<member name="M:Cake.Core.Scripting.CodeGen.MethodAliasGenerator.Generate(System.Reflection.MethodInfo,System.String@)">
<summary>
Generates a script method alias from the specified method.
The provided method must be an extension method for <see cref="T:Cake.Core.ICakeContext"/>
and it must be decorated with the <see cref="T:Cake.Core.Annotations.CakeMethodAliasAttribute"/>.
</summary>
<param name="method">The method to generate the code for.</param>
<param name="hash">The hash of method signature.</param>
<returns>The generated code.</returns>
</member>
<member name="T:Cake.Core.Scripting.CodeGen.ParameterEmitter">
<summary>
Responsible for generating parameter tokens in method alias generation.
</summary>
</member>
<member name="T:Cake.Core.Scripting.CodeGen.ParameterFormatter">
<summary>
Provides support for cleaning parameter names consisting of reserved keywords.
</summary>
</member>
<member name="T:Cake.Core.Scripting.CodeGen.PropertyAliasGenerator">
<summary>
Responsible for generating script property aliases.
</summary>
</member>
<member name="M:Cake.Core.Scripting.CodeGen.PropertyAliasGenerator.Generate(System.Reflection.MethodInfo)">
<summary>
Generates a script property alias from the specified method.
The provided method must be an extension method for <see cref="T:Cake.Core.ICakeContext"/>
and it must be decorated with the <see cref="T:Cake.Core.Annotations.CakePropertyAliasAttribute"/>.
</summary>
<param name="method">The method to generate the code for.</param>
<returns>The generated code.</returns>
</member>
<member name="M:Cake.Core.Scripting.CodeGen.PropertyAliasGenerator.Generate(System.Reflection.MethodInfo,System.String@)">
<summary>
Generates a script property alias from the specified method.
The provided method must be an extension method for <see cref="T:Cake.Core.ICakeContext"/>
and it must be decorated with the <see cref="T:Cake.Core.Annotations.CakePropertyAliasAttribute"/>.
</summary>
<param name="method">The method to generate the code for.</param>
<param name="hash">The hash of property signature.</param>
<returns>The generated code.</returns>
</member>
<member name="T:Cake.Core.Scripting.IScriptAliasFinder">
<summary>
Represents a script alias generator.
</summary>
</member>
<member name="M:Cake.Core.Scripting.IScriptAliasFinder.FindAliases(System.Collections.Generic.IEnumerable{System.Reflection.Assembly})">
<summary>
Finds script aliases in the provided assemblies.
</summary>
<param name="assemblies">The assemblies to find script aliases in.</param>
<returns>The script aliases that were found.</returns>
</member>
<member name="T:Cake.Core.Scripting.IScriptConventions">
<summary>
Represents the script conventions used by Cake.
</summary>
</member>
<member name="M:Cake.Core.Scripting.IScriptConventions.GetDefaultNamespaces">
<summary>
Gets the default namespaces.
</summary>
<returns>A list containing all default namespaces.</returns>
</member>
<member name="M:Cake.Core.Scripting.IScriptConventions.GetDefaultAssemblies(Cake.Core.IO.DirectoryPath)">
<summary>
Gets the default assemblies.
</summary>
<param name="root">The root to where to find Cake related assemblies.</param>
<returns>A list containing all default assemblies.</returns>
</member>
<member name="M:Cake.Core.Scripting.IScriptConventions.GetDefaultDefines">
<summary>
Gets the default defines.
</summary>
<returns>A list containing all default defines.</returns>
</member>
<member name="T:Cake.Core.Scripting.IScriptEngine">
<summary>
Represents a script engine.
</summary>
</member>
<member name="M:Cake.Core.Scripting.IScriptEngine.CreateSession(Cake.Core.Scripting.IScriptHost)">
<summary>
Creates a new script session.
</summary>
<param name="host">The host.</param>
<returns>A new script session.</returns>
</member>
<member name="T:Cake.Core.Scripting.IScriptHost">
<summary>
Represents a script host that works as a context for scripts.
</summary>
</member>
<member name="P:Cake.Core.Scripting.IScriptHost.Context">
<summary>
Gets the context.
</summary>
<value>The context.</value>
</member>
<member name="P:Cake.Core.Scripting.IScriptHost.Tasks">
<summary>
Gets all registered tasks.
</summary>
<value>The registered tasks.</value>
</member>
<member name="P:Cake.Core.Scripting.IScriptHost.Settings">
<summary>
Gets the execution settings.
</summary>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.Task(System.String)">
<summary>
Registers a new task.
</summary>
<param name="name">The name of the task.</param>
<returns>A <see cref="T:Cake.Core.CakeTaskBuilder"/>.</returns>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.Setup(System.Action{Cake.Core.ISetupContext})">
<summary>
Allows registration of an action that's executed before any tasks are run.
If setup fails, no tasks will be executed but teardown will be performed.
</summary>
<param name="action">The action to be executed.</param>
<example>
<code>
Setup(context => {
context.Log.Information("Hello World!");
});
</code>
</example>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.Setup``1(System.Func{Cake.Core.ISetupContext,``0})">
<summary>
Allows registration of an action that's executed before any tasks are run.
If setup fails, no tasks will be executed but teardown will be performed.
</summary>
<typeparam name="TData">The data type.</typeparam>
<param name="action">The action to be executed.</param>
<example>
<code>
Setup<Foo>(context => {
return new Foo();
});
</code>
</example>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.Teardown(System.Action{Cake.Core.ITeardownContext})">
<summary>
Allows registration of an action that's executed after all other tasks have been run.
If a setup action or a task fails with or without recovery, the specified teardown action will still be executed.
</summary>
<param name="action">The action to be executed.</param>
<example>
<code>
Teardown(context => {
context.Log.Information("Goodbye World!");
});
</code>
</example>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.Teardown``1(System.Action{Cake.Core.ITeardownContext,``0})">
<summary>
Allows registration of an action that's executed after all other tasks have been run.
If a setup action or a task fails with or without recovery, the specified teardown action will still be executed.
</summary>
<typeparam name="TData">The data type.</typeparam>
<param name="action">The action to be executed.</param>
<example>
<code>
Teardown((context, data) => {
context.Log.Information("Goodbye {0}!", data.Place);
});
</code>
</example>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.TaskSetup(System.Action{Cake.Core.ITaskSetupContext})">
<summary>
Allows registration of an action that's executed before each task is run.
If the task setup fails, its task will not be executed but the task teardown will be performed.
</summary>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.TaskSetup``1(System.Action{Cake.Core.ITaskSetupContext,``0})">
<summary>
Allows registration of an action that's executed before each task is run.
If the task setup fails, its task will not be executed but the task teardown will be performed.
</summary>
<typeparam name="TData">The data type.</typeparam>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.TaskTeardown(System.Action{Cake.Core.ITaskTeardownContext})">
<summary>
Allows registration of an action that's executed after each task has been run.
If a task setup action or a task fails with or without recovery, the specified task teardown action will still be executed.
</summary>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.TaskTeardown``1(System.Action{Cake.Core.ITaskTeardownContext,``0})">
<summary>
Allows registration of an action that's executed after each task has been run.
If a task setup action or a task fails with or without recovery, the specified task teardown action will still be executed.
</summary>
<typeparam name="TData">The data type.</typeparam>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.RunTarget(System.String)">
<summary>
Runs the specified target.
</summary>
<param name="target">The target to run.</param>
<returns>The resulting report.</returns>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.RunTargetAsync(System.String)">
<summary>
Runs the specified target.
</summary>
<param name="target">The target to run.</param>
<returns>The resulting report.</returns>
</member>
<member name="T:Cake.Core.Scripting.IScriptProcessor">
<summary>
Represents a script processor.
</summary>
</member>
<member name="M:Cake.Core.Scripting.IScriptProcessor.InstallAddins(System.Collections.Generic.IReadOnlyCollection{Cake.Core.Packaging.PackageReference},Cake.Core.IO.DirectoryPath)">
<summary>
Installs the addins.
</summary>
<param name="addins">The addins to install.</param>
<param name="installPath">The install path.</param>
<returns>A list containing file paths to installed addin assemblies.</returns>
</member>
<member name="M:Cake.Core.Scripting.IScriptProcessor.InstallTools(System.Collections.Generic.IReadOnlyCollection{Cake.Core.Packaging.PackageReference},Cake.Core.IO.DirectoryPath)">
<summary>
Installs the tools.
</summary>
<param name="tools">The tools to install.</param>
<param name="installPath">The install path.</param>
</member>
<member name="M:Cake.Core.Scripting.IScriptProcessor.InstallModules(System.Collections.Generic.IReadOnlyCollection{Cake.Core.Packaging.PackageReference},Cake.Core.IO.DirectoryPath)">
<summary>
Installs the modules.
</summary>
<param name="modules">The modules to install.</param>
<param name="installPath">The install path.</param>
</member>
<member name="T:Cake.Core.Scripting.IScriptRunner">
<summary>
Represents a script runner responsible for running scripts.
</summary>
</member>
<member name="M:Cake.Core.Scripting.IScriptRunner.Run(Cake.Core.Scripting.IScriptHost,Cake.Core.IO.FilePath)">
<summary>
Runs the script using the specified script host.
</summary>
<param name="host">The script host.</param>
<param name="scriptPath">The script path.</param>
</member>
<member name="T:Cake.Core.Scripting.IScriptSession">
<summary>
Represents a script session.
</summary>
</member>
<member name="M:Cake.Core.Scripting.IScriptSession.AddReference(Cake.Core.IO.FilePath)">
<summary>
Adds a reference path to the session.
</summary>
<param name="path">The reference path.</param>
</member>
<member name="M:Cake.Core.Scripting.IScriptSession.AddReference(System.Reflection.Assembly)">
<summary>
Adds an assembly reference to the session.
</summary>
<param name="assembly">The assembly reference.</param>
</member>
<member name="M:Cake.Core.Scripting.IScriptSession.ImportNamespace(System.String)">
<summary>
Imports a namespace to the session.
</summary>
<param name="namespace">The namespace to import.</param>
</member>
<member name="M:Cake.Core.Scripting.IScriptSession.Execute(Cake.Core.Scripting.Script)">
<summary>
Executes the specified script.
</summary>
<param name="script">The script to execute.</param>
</member>
<member name="T:Cake.Core.Scripting.Script">
<summary>
Represents a script.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Script.Namespaces">
<summary>
Gets the namespaces imported via the <c>using</c> statement.
</summary>
<value>The namespaces.</value>
</member>
<member name="P:Cake.Core.Scripting.Script.ExcludedNamespaces">
<summary>
Gets the namespaces flagged to be excluded by code generation and affected aliases.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Script.Lines">
<summary>
Gets the script lines.
</summary>
<value>
The lines.
</value>
</member>
<member name="P:Cake.Core.Scripting.Script.Aliases">
<summary>
Gets the aliases.
</summary>
<value>The aliases.</value>
</member>
<member name="P:Cake.Core.Scripting.Script.UsingAliasDirectives">
<summary>
Gets the using alias directives.
</summary>
<value>The using alias directives.</value>
</member>
<member name="P:Cake.Core.Scripting.Script.UsingStaticDirectives">
<summary>
Gets the using static directives.
</summary>
<value>The using static directives.</value>
</member>
<member name="P:Cake.Core.Scripting.Script.Defines">
<summary>
Gets the defines.
</summary>
<value>The defines.</value>
</member>
<member name="M:Cake.Core.Scripting.Script.#ctor(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{Cake.Core.Scripting.ScriptAlias},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Scripting.Script" /> class.
</summary>
<param name="namespaces">The namespaces.</param>
<param name="lines">The scrip lines.</param>
<param name="aliases">The script aliases.</param>
<param name="usingAliasDirectives">The using alias directives.</param>
<param name="usingStaticDirectives">The using static directives.</param>
<param name="defines">The defines.</param>
</member>
<member name="T:Cake.Core.Scripting.ScriptAlias">
<summary>
Represents a script alias.
</summary>
</member>
<member name="P:Cake.Core.Scripting.ScriptAlias.Name">
<summary>
Gets the name of the alias.
</summary>
<value>The name.</value>
</member>
<member name="P:Cake.Core.Scripting.ScriptAlias.Method">
<summary>
Gets the method associated with the alias.
</summary>
<value>The method associated with the alias.</value>
</member>
<member name="P:Cake.Core.Scripting.ScriptAlias.Type">
<summary>
Gets the alias type.
</summary>
<value>The alias type.</value>
</member>
<member name="P:Cake.Core.Scripting.ScriptAlias.Namespaces">
<summary>
Gets all namespaces that the alias need to be imported.
</summary>
<value>
The namespaces that the alias need to be imported.
</value>
</member>
<member name="M:Cake.Core.Scripting.ScriptAlias.#ctor(System.Reflection.MethodInfo,Cake.Core.Scripting.ScriptAliasType,System.Collections.Generic.ISet{System.String})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Scripting.ScriptAlias"/> class.
</summary>
<param name="method">The method associated with the alias.</param>
<param name="type">The alias type.</param>
<param name="namespaces">The namespaces that the alias need to be imported.</param>
</member>
<member name="T:Cake.Core.Scripting.ScriptAliasFinder">
<summary>
The script alias finder.
</summary>
</member>
<member name="M:Cake.Core.Scripting.ScriptAliasFinder.#ctor(Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Scripting.ScriptAliasFinder"/> class.
</summary>
<param name="log">The log.</param>
</member>
<member name="M:Cake.Core.Scripting.ScriptAliasFinder.FindAliases(System.Collections.Generic.IEnumerable{System.Reflection.Assembly})">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Scripting.ScriptAliasType">
<summary>
Represents a script alias type.
</summary>
</member>
<member name="F:Cake.Core.Scripting.ScriptAliasType.Unknown">
<summary>
Represents an unknown script alias type.
</summary>
</member>
<member name="F:Cake.Core.Scripting.ScriptAliasType.Method">
<summary>
Represents a script alias method.
</summary>
</member>
<member name="F:Cake.Core.Scripting.ScriptAliasType.Property">
<summary>
Represents a script alias property.
</summary>
</member>
<member name="T:Cake.Core.Scripting.ScriptConventions">
<summary>
The script conventions used by Cake.
</summary>
</member>
<member name="M:Cake.Core.Scripting.ScriptConventions.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.Reflection.IAssemblyLoader,Cake.Core.ICakeRuntime)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Scripting.ScriptConventions"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="loader">The assembly loader.</param>
<param name="runtime">The Cake runtime.</param>
</member>
<member name="M:Cake.Core.Scripting.ScriptConventions.GetDefaultNamespaces">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptConventions.GetDefaultAssemblies(Cake.Core.IO.DirectoryPath)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptConventions.GetDefaultDefines">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Scripting.ScriptHost">
<summary>
The script host works as a context for scripts.
</summary>
</member>
<member name="P:Cake.Core.Scripting.ScriptHost.Engine">
<summary>
Gets the engine.
</summary>
<value>The engine.</value>
</member>
<member name="P:Cake.Core.Scripting.ScriptHost.Context">
<inheritdoc/>
</member>
<member name="P:Cake.Core.Scripting.ScriptHost.Settings">
<summary>
Gets the settings.
</summary>
<value>The settings.</value>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.#ctor(Cake.Core.ICakeEngine,Cake.Core.ICakeContext)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Scripting.ScriptHost"/> class.
</summary>
<param name="engine">The engine.</param>
<param name="context">The context.</param>
</member>
<member name="P:Cake.Core.Scripting.ScriptHost.Tasks">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.Task(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.Setup(System.Action{Cake.Core.ISetupContext})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.Setup``1(System.Func{Cake.Core.ISetupContext,``0})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.Teardown(System.Action{Cake.Core.ITeardownContext})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.Teardown``1(System.Action{Cake.Core.ITeardownContext,``0})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.TaskSetup(System.Action{Cake.Core.ITaskSetupContext})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.TaskSetup``1(System.Action{Cake.Core.ITaskSetupContext,``0})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.TaskTeardown(System.Action{Cake.Core.ITaskTeardownContext})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.TaskTeardown``1(System.Action{Cake.Core.ITaskTeardownContext,``0})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.RunTarget(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.RunTargetAsync(System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Scripting.ScriptProcessor">
<summary>
Implementation of a script processor.
</summary>
</member>
<member name="M:Cake.Core.Scripting.ScriptProcessor.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.Diagnostics.ICakeLog,Cake.Core.Tooling.IToolLocator,System.Collections.Generic.IEnumerable{Cake.Core.Packaging.IPackageInstaller},Cake.Core.Configuration.ICakeConfiguration)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Scripting.ScriptProcessor"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="log">The log.</param>
<param name="tools">The tool locator.</param>
<param name="installers">The available package installers.</param>
<param name="configuration">The configuration.</param>
</member>
<member name="M:Cake.Core.Scripting.ScriptProcessor.InstallAddins(System.Collections.Generic.IReadOnlyCollection{Cake.Core.Packaging.PackageReference},Cake.Core.IO.DirectoryPath)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptProcessor.InstallTools(System.Collections.Generic.IReadOnlyCollection{Cake.Core.Packaging.PackageReference},Cake.Core.IO.DirectoryPath)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptProcessor.InstallModules(System.Collections.Generic.IReadOnlyCollection{Cake.Core.Packaging.PackageReference},Cake.Core.IO.DirectoryPath)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Scripting.ScriptRunner">
<summary>
Responsible for running scripts.
</summary>
</member>
<member name="M:Cake.Core.Scripting.ScriptRunner.#ctor(Cake.Core.ICakeEnvironment,Cake.Core.Diagnostics.ICakeLog,Cake.Core.Configuration.ICakeConfiguration,Cake.Core.Scripting.IScriptEngine,Cake.Core.Scripting.IScriptAliasFinder,Cake.Core.Scripting.Analysis.IScriptAnalyzer,Cake.Core.Scripting.IScriptProcessor,Cake.Core.Scripting.IScriptConventions,Cake.Core.Reflection.IAssemblyLoader)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Scripting.ScriptRunner"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="log">The log.</param>
<param name="configuration">The configuration.</param>
<param name="engine">The session factory.</param>
<param name="aliasFinder">The alias finder.</param>
<param name="analyzer">The script analyzer.</param>
<param name="processor">The script processor.</param>
<param name="conventions">The script conventions.</param>
<param name="assemblyLoader">The assembly loader.</param>
</member>
<member name="M:Cake.Core.Scripting.ScriptRunner.Run(Cake.Core.Scripting.IScriptHost,Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Text.NamespaceDoc">
<summary>
This namespace contain types
related to text processing and transformations.
</summary>
</member>
<member name="T:Cake.Core.Text.ITextTransformationTemplate">
<summary>
Represents a text template.
</summary>
</member>
<member name="M:Cake.Core.Text.ITextTransformationTemplate.Register(System.String,System.Object)">
<summary>
Registers a key and an associated value.
</summary>
<param name="key">The key.</param>
<param name="value">The value.</param>
</member>
<member name="M:Cake.Core.Text.ITextTransformationTemplate.Render">
<summary>
Renders the text template using the registered tokens.
</summary>
<returns>The rendered template.</returns>
</member>
<member name="T:Cake.Core.Text.QuoteAwareStringSplitter">
<summary>
Utility that that respect quotes when splitting a string.
</summary>
</member>
<member name="M:Cake.Core.Text.QuoteAwareStringSplitter.Split(System.String)">
<summary>
Splits the provided string on spaces while respecting quoted strings.
</summary>
<param name="text">The string to split.</param>
<returns>The split, individual parts.</returns>
</member>
<member name="T:Cake.Core.Text.TextTransformationTemplate">
<summary>
Provides template functionality for simple text transformations.
</summary>
</member>
<member name="M:Cake.Core.Text.TextTransformationTemplate.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Text.TextTransformationTemplate"/> class.
</summary>
<param name="template">The template.</param>
</member>
<member name="M:Cake.Core.Text.TextTransformationTemplate.#ctor(System.String,System.Tuple{System.String,System.String})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Text.TextTransformationTemplate"/> class.
</summary>
<param name="template">The template.</param>
<param name="placeholder">The key placeholder.</param>
</member>
<member name="M:Cake.Core.Text.TextTransformationTemplate.Register(System.String,System.Object)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Text.TextTransformationTemplate.Render">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Tooling.NamespaceDoc">
<summary>
This namespace contain base classes
and functionality related to tooling.
</summary>
</member>
<member name="T:Cake.Core.Tooling.IToolLocator">
<summary>
Represents a tool locator.
</summary>
</member>
<member name="M:Cake.Core.Tooling.IToolLocator.RegisterFile(Cake.Core.IO.FilePath)">
<summary>
Registers the specified tool file path.
</summary>
<param name="path">The tool path.</param>
</member>
<member name="M:Cake.Core.Tooling.IToolLocator.Resolve(System.String)">
<summary>
Resolves the path to the specified tool.
</summary>
<param name="tool">The tool.</param>
<returns>A path if the tool was found; otherwise <c>null</c>.</returns>
</member>
<member name="M:Cake.Core.Tooling.IToolLocator.Resolve(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Resolves the path to the specified tool.
</summary>
<param name="toolExeNames">The possible names of the tool executable.</param>
<returns>A path if the tool was found; otherwise <c>null</c>.</returns>
</member>
<member name="T:Cake.Core.Tooling.IToolRepository">
<summary>
Represents a tool repository.
</summary>
</member>
<member name="M:Cake.Core.Tooling.IToolRepository.Register(Cake.Core.IO.FilePath)">
<summary>
Registers the specified path with the repository.
</summary>
<param name="path">The path to register.</param>
</member>
<member name="M:Cake.Core.Tooling.IToolRepository.Resolve(System.String)">
<summary>
Resolves the specified tool.
</summary>
<param name="tool">The tool to resolve.</param>
<returns>The tool's file paths if any; otherwise <c>null</c>.</returns>
</member>
<member name="T:Cake.Core.Tooling.IToolResolutionStrategy">
<summary>
Represents a tool resolution strategy.
</summary>
</member>
<member name="M:Cake.Core.Tooling.IToolResolutionStrategy.Resolve(Cake.Core.Tooling.IToolRepository,System.String)">
<summary>
Resolves the specified tool using the specified tool repository.
</summary>
<param name="repository">The tool repository.</param>
<param name="tool">The tool.</param>
<returns>The path to the tool; otherwise <c>null</c>.</returns>
</member>
<member name="M:Cake.Core.Tooling.IToolResolutionStrategy.Resolve(Cake.Core.Tooling.IToolRepository,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Resolves the specified tool using the specified tool repository.
</summary>
<param name="repository">The tool repository.</param>
<param name="toolExeNames">The possible names of the tool executable.</param>
<returns>The path to the tool; otherwise <c>null</c>.</returns>
</member>
<member name="T:Cake.Core.Tooling.Tool`1">
<summary>
Base class for tools.
</summary>
<typeparam name="TSettings">The settings type.</typeparam>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Tooling.Tool`1"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.Run(`0,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Runs the tool using the specified settings.
</summary>
<param name="settings">The settings.</param>
<param name="arguments">The arguments.</param>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.Run(`0,Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.ProcessSettings,System.Action{Cake.Core.IO.IProcess})">
<summary>
Runs the tool using a custom tool path and the specified settings.
</summary>
<param name="settings">The settings.</param>
<param name="arguments">The arguments.</param>
<param name="processSettings">The process settings.</param>
<param name="postAction">If specified called after process exit.</param>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.ProcessExitCode(System.Int32)">
<summary>
Customized exit code handling.
Standard behavior is to fail when non zero.
</summary>
<param name="exitCode">The process exit code.</param>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.RunProcess(`0,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Runs the tool using a custom tool path and the specified settings.
</summary>
<param name="settings">The settings.</param>
<param name="arguments">The arguments.</param>
<returns>The process that the tool is running under.</returns>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.RunProcess(`0,Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.ProcessSettings)">
<summary>
Runs the tool using a custom tool path and the specified settings.
</summary>
<param name="settings">The settings.</param>
<param name="arguments">The arguments.</param>
<param name="processSettings">The process settings.</param>
<returns>The process that the tool is running under.</returns>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.GetToolExecutableNames(`0)">
<summary>
Gets the possible names of the tool executable.
</summary>
<param name="settings">The settings.</param>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.GetWorkingDirectory(`0)">
<summary>
Gets the working directory.
Defaults to the currently set working directory.
</summary>
<param name="settings">The settings.</param>
<returns>The working directory for the tool.</returns>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.GetAlternativeToolPaths(`0)">
<summary>
Gets alternative file paths which the tool may exist in.
</summary>
<param name="settings">The settings.</param>
<returns>The default tool path.</returns>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.GetEnvironmentVariables(`0)">
<summary>
Gets the environment variables.
</summary>
<param name="settings">The settings.</param>
<returns>The environment variables for the tool.</returns>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.GetToolPath(`0)">
<summary>
Gets the resolved tool path.
</summary>
<param name="settings">The settings.</param>
<returns>The resolved tool path.</returns>
</member>
<member name="T:Cake.Core.Tooling.ToolLocator">
<summary>
Implementation of the tool locator.
</summary>
</member>
<member name="M:Cake.Core.Tooling.ToolLocator.#ctor(Cake.Core.ICakeEnvironment,Cake.Core.Tooling.IToolRepository,Cake.Core.Tooling.IToolResolutionStrategy)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Tooling.ToolLocator"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="repository">The tool repository.</param>
<param name="strategy">The tool resolution strategy.</param>
</member>
<member name="M:Cake.Core.Tooling.ToolLocator.RegisterFile(Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Tooling.ToolLocator.Resolve(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Tooling.ToolLocator.Resolve(System.Collections.Generic.IEnumerable{System.String})">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Tooling.ToolRepository">
<summary>
The tool repository.
</summary>
</member>
<member name="M:Cake.Core.Tooling.ToolRepository.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Tooling.ToolRepository"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Core.Tooling.ToolRepository.Register(Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Tooling.ToolRepository.Resolve(System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Tooling.ToolResolutionStrategy">
<summary>
Implementation of the default tool resolution strategy.
</summary>
</member>
<member name="M:Cake.Core.Tooling.ToolResolutionStrategy.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IGlobber,Cake.Core.Configuration.ICakeConfiguration,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Tooling.ToolResolutionStrategy"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="globber">The globber.</param>
<param name="configuration">The configuration.</param>
<param name="log">The log.</param>
</member>
<member name="M:Cake.Core.Tooling.ToolResolutionStrategy.Resolve(Cake.Core.Tooling.IToolRepository,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Tooling.ToolResolutionStrategy.Resolve(Cake.Core.Tooling.IToolRepository,System.Collections.Generic.IEnumerable{System.String})">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Tooling.ToolSettings">
<summary>
Base class for tool settings.
</summary>
</member>
<member name="P:Cake.Core.Tooling.ToolSettings.ToolPath">
<summary>
Gets or sets the tool path.
</summary>
<value>The tool path.</value>
</member>
<member name="P:Cake.Core.Tooling.ToolSettings.ToolTimeout">
<summary>
Gets or sets optional timeout for tool execution.
</summary>
</member>
<member name="P:Cake.Core.Tooling.ToolSettings.WorkingDirectory">
<summary>
Gets or sets the working directory for the tool process.
</summary>
<value>The working directory for the tool process.</value>
</member>
<member name="P:Cake.Core.Tooling.ToolSettings.NoWorkingDirectory">
<summary>
Gets or sets a value indicating whether or not to opt out of using
an explicit working directory for the process.
</summary>
</member>
<member name="P:Cake.Core.Tooling.ToolSettings.ArgumentCustomization">
<summary>
Gets or sets the argument customization.
Argument customization is a way that lets you add, replace or reuse arguments passed to a tool.
This allows you to support new tool arguments, customize arguments or address potential argument issues.
</summary>
<example>
<para>Combining tool specific settings and tool arguments:</para>
<code>
NuGetAddSource("Cake", "https://www.myget.org/F/cake/api/v3/index.json",
new NuGetSourcesSettings { UserName = "user", Password = "incorrect",
ArgumentCustomization = args=>args.Append("-StorePasswordInClearText")
});
</code>
</example>
<example>
<para>Setting multiple tool arguments:</para>
<code>
MSTest(pathPattern, new MSTestSettings()
{ ArgumentCustomization = args=>args.Append("/detail:errormessage")
.Append("/resultsfile:TestResults.trx") });
</code>
</example>
<value>The delegate used to customize the <see cref="T:Cake.Core.IO.ProcessArgumentBuilder" />.</value>
</member>
<member name="P:Cake.Core.Tooling.ToolSettings.EnvironmentVariables">
<summary>
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
</summary>
<example>
<code>
MSBuild("./src/Cake.sln", new MSBuildSettings {
EnvironmentVariables = new Dictionary<string, string>{
{ "TOOLSPATH", MakeAbsolute(Directory("./tools")).FullPath }
}});
</code>
</example>
</member>
<member name="P:Cake.Core.Tooling.ToolSettings.HandleExitCode">
<summary>
Gets or sets whether the exit code from the tool process causes an exception to be thrown.
<para>
If the delegate is null (the default) or returns false, then an exception is thrown upon a non-zero exit code.
</para>
<para>
If the delegate returns true then no exception is thrown.
</para>
<para>
This can be useful when the exit code should be ignored, or if there is a desire to apply logic that is conditional
on the exit code value.
</para>
</summary>
<example>
Don't throw exceptions if DotNetCoreTest returns non-zero:
<code>
DotNetCoreTest("MyProject.csproj", new DotNetCoreTestSettings {
HandleExitCode = _=> true
});
</code>
</example>
<example>
Use custom logic for exit code:
<code>
DotNetCoreTest("MyProject.csproj", new DotNetCoreTestSettings {
HandleExitCode = exitCode => exitCode switch {
0 => throw new CakeException("ZERO"),
1 => true, // treat 1 and 2 as handled "ok".
2 => true,
_ => false // everything else will throw via default implementation
};
});
</code>
</example>
</member>
<member name="T:Cake.Core.Reflection.AssemblyLoader">
<summary>
Responsible for loading assemblies.
</summary>
</member>
<member name="M:Cake.Core.Reflection.AssemblyLoader.#ctor(Cake.Core.ICakeEnvironment,Cake.Core.IO.IFileSystem,Cake.Core.Reflection.IAssemblyVerifier)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Reflection.AssemblyLoader"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="fileSystem">The file system.</param>
<param name="verifier">The assembly verifier.</param>
</member>
<member name="M:Cake.Core.Reflection.AssemblyLoader.Load(System.Reflection.AssemblyName)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Reflection.AssemblyLoader.Load(Cake.Core.IO.FilePath,System.Boolean)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Reflection.AssemblyVerifier">
<summary>
Responsible for verifying assemblies.
</summary>
</member>
<member name="M:Cake.Core.Reflection.AssemblyVerifier.#ctor(Cake.Core.Configuration.ICakeConfiguration,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Reflection.AssemblyVerifier"/> class.
</summary>
<param name="configuration">The configuration.</param>
<param name="log">The log.</param>
</member>
<member name="M:Cake.Core.Reflection.AssemblyVerifier.Verify(System.Reflection.Assembly)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Reflection.IAssemblyLoader">
<summary>
Represents an assembly loader.
</summary>
</member>
<member name="M:Cake.Core.Reflection.IAssemblyLoader.Load(System.Reflection.AssemblyName)">
<summary>
Loads an assembly from its assembly name.
</summary>
<param name="assemblyName">The assembly name.</param>
<returns>The loaded assembly.</returns>
</member>
<member name="M:Cake.Core.Reflection.IAssemblyLoader.Load(Cake.Core.IO.FilePath,System.Boolean)">
<summary>
Loads an assembly from the specified path.
</summary>
<param name="path">The assembly path to load.</param>
<param name="verify">If the assembly should be verified whether or not it will work properly with Cake or not.</param>
<returns>The loaded assembly.</returns>
</member>
<member name="T:Cake.Core.Reflection.IAssemblyVerifier">
<summary>
Represents an assembly verifier.
</summary>
</member>
<member name="M:Cake.Core.Reflection.IAssemblyVerifier.Verify(System.Reflection.Assembly)">
<summary>
Verifies an assembly.
</summary>
<param name="assembly">The target assembly.</param>
</member>
<member name="T:Cake.Core.SetupContext">
<summary>
Acts as a context providing info about the overall build following its completion.
</summary>
</member>
<member name="P:Cake.Core.SetupContext.TargetTask">
<inheritdoc/>
</member>
<member name="P:Cake.Core.SetupContext.TasksToExecute">
<inheritdoc/>
</member>
<member name="M:Cake.Core.SetupContext.#ctor(Cake.Core.ICakeContext,Cake.Core.ICakeTaskInfo,System.Collections.Generic.IEnumerable{Cake.Core.ICakeTaskInfo})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.SetupContext"/> class.
</summary>
<param name="context">The Cake context.</param>
<param name="targetTask">The target (initiating) task.</param>
<param name="tasksToExecute">The tasks to execute.</param>
</member>
<member name="T:Cake.Core.SetupEventArgs">
<summary>
Event data for the <see cref="E:Cake.Core.ICakeEngine.Setup"/> event.
</summary>
</member>
<member name="P:Cake.Core.SetupEventArgs.Context">
<summary>
Gets the Cake context.
</summary>
</member>
<member name="M:Cake.Core.SetupEventArgs.#ctor(Cake.Core.ICakeContext)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.SetupEventArgs"/> class.
</summary>
<param name="context">The context.</param>
</member>
<member name="T:Cake.Core.TaskSetupContext">
<inheritdoc/>
</member>
<member name="M:Cake.Core.TaskSetupContext.#ctor(Cake.Core.ICakeContext,Cake.Core.ICakeTaskInfo)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.TaskSetupContext"/> class.
</summary>
<param name="context">The Cake Context.</param>
<param name="task">The task.</param>
</member>
<member name="P:Cake.Core.TaskSetupContext.Task">
<inheritdoc/>
</member>
<member name="T:Cake.Core.TaskSetupEventArgs">
<summary>
Event data for the <see cref="E:Cake.Core.ICakeEngine.TaskSetup"/> event.
</summary>
</member>
<member name="P:Cake.Core.TaskSetupEventArgs.TaskSetupContext">
<summary>
Gets the task setup context.
</summary>
</member>
<member name="M:Cake.Core.TaskSetupEventArgs.#ctor(Cake.Core.ITaskSetupContext)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.TaskSetupEventArgs"/> class.
</summary>
<param name="taskSetupContext">The task setup context.</param>
</member>
<member name="T:Cake.Core.TaskTeardownContext">
<inheritdoc/>
</member>
<member name="M:Cake.Core.TaskTeardownContext.#ctor(Cake.Core.ICakeContext,Cake.Core.ICakeTaskInfo,System.TimeSpan,System.Boolean,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.TaskTeardownContext"/> class.
</summary>
<param name="context">The Cake Context.</param>
<param name="task">The task.</param>
<param name="duration">The duration of the task.</param>
<param name="skipped">if set to <c>true</c>, the task was not executed.</param>
<param name="throwException">The exception that was thrown by the task.</param>
</member>
<member name="P:Cake.Core.TaskTeardownContext.Task">
<inheritdoc/>
</member>
<member name="P:Cake.Core.TaskTeardownContext.Duration">
<inheritdoc/>
</member>
<member name="P:Cake.Core.TaskTeardownContext.Skipped">
<inheritdoc/>
</member>
<member name="P:Cake.Core.TaskTeardownContext.Successful">
<inheritdoc/>
</member>
<member name="P:Cake.Core.TaskTeardownContext.ThrownException">
<inheritdoc/>
</member>
<member name="T:Cake.Core.TaskTeardownEventArgs">
<summary>
Event data for the <see cref="E:Cake.Core.ICakeEngine.TaskTeardown"/> event.
</summary>
</member>
<member name="P:Cake.Core.TaskTeardownEventArgs.TaskTeardownContext">
<summary>
Gets the task teardown context.
</summary>
</member>
<member name="M:Cake.Core.TaskTeardownEventArgs.#ctor(Cake.Core.ITaskTeardownContext)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.TaskTeardownEventArgs"/> class.
</summary>
<param name="taskTeardownContext">The task teardown context.</param>
</member>
<member name="T:Cake.Core.TeardownContext">
<inheritdoc/>
</member>
<member name="P:Cake.Core.TeardownContext.Successful">
<inheritdoc/>
</member>
<member name="P:Cake.Core.TeardownContext.ThrownException">
<inheritdoc/>
</member>
<member name="M:Cake.Core.TeardownContext.#ctor(Cake.Core.ICakeContext,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.TeardownContext"/> class.
</summary>
<param name="context">The Cake context.</param>
<param name="throwException">The exception that was thrown by the target.</param>
</member>
<member name="T:Cake.Core.TeardownEventArgs">
<summary>
Event data for the <see cref="E:Cake.Core.ICakeEngine.Teardown"/> event.
</summary>
</member>
<member name="P:Cake.Core.TeardownEventArgs.TeardownContext">
<summary>
Gets the teardown context.
</summary>
</member>
<member name="M:Cake.Core.TeardownEventArgs.#ctor(Cake.Core.ITeardownContext)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.TeardownEventArgs"/> class.
</summary>
<param name="teardownContext">The teardown context.</param>
</member>
</members>
</doc>
md5: 64BDC8297B2CA72E8550B70CB4E13DC4 | sha1: A955D73D4598655AB61F7C033C461A8AE91D936B | sha256: 279F3EDA88062A227473CCEFD863C2A92499B983A1690315822C2218F9A8367C | sha512: 4464073900C76084B1ED49D5FEA2A91116C1CEA25C0F61F9F467C47144375A74CAFB2923269123E180149698BA1B3319BBCA78E2975C3C24829BC78F7FE52F83
<?xml version="1.0"?>
<doc>
<assembly>
<name>Cake.DotNetTool.Module</name>
</assembly>
<members>
<member name="T:Cake.DotNetTool.Module.DotNetToolContentResolver">
<summary>
Locates and lists contents of dotnet Tool Packages.
</summary>
</member>
<member name="M:Cake.DotNetTool.Module.DotNetToolContentResolver.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IGlobber,Cake.Core.Diagnostics.ICakeLog,Cake.Core.Configuration.ICakeConfiguration)">
<summary>
Initializes a new instance of the <see cref="T:Cake.DotNetTool.Module.DotNetToolContentResolver"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="globber">The Globber.</param>
<param name="log">The Log.</param>
<param name="config">the configuration.</param>
</member>
<member name="M:Cake.DotNetTool.Module.DotNetToolContentResolver.GetFiles(Cake.Core.Packaging.PackageReference,Cake.Core.Packaging.PackageType)">
<summary>
Collects all the files for the given dotnet Tool Package.
</summary>
<param name="package">The dotnet Tool Package.</param>
<param name="type">The type of dotnet Tool Package.</param>
<returns>All the files for the Package.</returns>
</member>
<member name="T:Cake.DotNetTool.Module.DotNetToolModule">
<summary>
The module responsible for registering
default types in the Cake.DotNetTool.Module assembly.
</summary>
</member>
<member name="M:Cake.DotNetTool.Module.DotNetToolModule.Register(Cake.Core.Composition.ICakeContainerRegistrar)">
<summary>
Performs custom registrations in the provided registrar.
</summary>
<param name="registrar">The container registrar.</param>
</member>
<member name="T:Cake.DotNetTool.Module.DotNetToolOperation">
<summary>
Represents dotnet tool operation.
</summary>
</member>
<member name="F:Cake.DotNetTool.Module.DotNetToolOperation.Install">
<summary>
Install operation.
</summary>
</member>
<member name="F:Cake.DotNetTool.Module.DotNetToolOperation.Uninstall">
<summary>
Uninstall operation.
</summary>
</member>
<member name="F:Cake.DotNetTool.Module.DotNetToolOperation.Update">
<summary>
Update operation.
</summary>
</member>
<member name="T:Cake.DotNetTool.Module.DotNetToolPackage">
<summary>
Represents a dotnet tool package.
</summary>
</member>
<member name="P:Cake.DotNetTool.Module.DotNetToolPackage.Id">
<summary>
Gets or sets the tool package ID.
</summary>
<value>The tool package ID.</value>
</member>
<member name="P:Cake.DotNetTool.Module.DotNetToolPackage.Version">
<summary>
Gets or sets the tool package version.
</summary>
<value>The tool package version.</value>
</member>
<member name="P:Cake.DotNetTool.Module.DotNetToolPackage.ShortCode">
<summary>
Gets or sets the tool package short code.
</summary>
<value>The tool package short code.</value>
</member>
<member name="T:Cake.DotNetTool.Module.DotNetToolPackageInstaller">
<summary>
Installer for dotnet Tool Packages.
</summary>
</member>
<member name="M:Cake.DotNetTool.Module.DotNetToolPackageInstaller.#ctor(Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Diagnostics.ICakeLog,Cake.DotNetTool.Module.IDotNetToolContentResolver,Cake.Core.Configuration.ICakeConfiguration,Cake.Core.IO.IFileSystem)">
<summary>
Initializes a new instance of the <see cref="T:Cake.DotNetTool.Module.DotNetToolPackageInstaller"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="log">The log.</param>
<param name="contentResolver">The DotNetTool Package Content Resolver.</param>
<param name="config">the configuration.</param>
<param name="fileSystem">The file system.</param>
</member>
<member name="M:Cake.DotNetTool.Module.DotNetToolPackageInstaller.CanInstall(Cake.Core.Packaging.PackageReference,Cake.Core.Packaging.PackageType)">
<summary>
Determines whether this instance can install the specified resource.
</summary>
<param name="package">The package reference.</param>
<param name="type">The package type.</param>
<returns><c>true</c> if this installer can install the specified resource; otherwise <c>false</c>.</returns>
</member>
<member name="M:Cake.DotNetTool.Module.DotNetToolPackageInstaller.Install(Cake.Core.Packaging.PackageReference,Cake.Core.Packaging.PackageType,Cake.Core.IO.DirectoryPath)">
<summary>
Installs the specified resource at the given location.
</summary>
<param name="package">The package reference.</param>
<param name="type">The package type.</param>
<param name="path">The location where to install the package.</param>
<returns>The installed files.</returns>
</member>
<member name="T:Cake.DotNetTool.Module.IDotNetToolContentResolver">
<summary>
Represents a file locator for dotnet Tool packages that returns relevant
files given the resource type.
</summary>
</member>
<member name="M:Cake.DotNetTool.Module.IDotNetToolContentResolver.GetFiles(Cake.Core.Packaging.PackageReference,Cake.Core.Packaging.PackageType)">
<summary>
Gets the relevant files for a dotnet Tool package
given a resource type.
</summary>
<param name="package">The package.</param>
<param name="type">The resource type.</param>
<returns>A collection of files.</returns>
</member>
</members>
</doc>
md5: F24E6E38289DACE087BA8AC6D6127C91 | sha1: 5525EDE2F530969297309FDD0F07448D3D286102 | sha256: 2341C276078A383ED1D3F5A4BD080B088A7C5C38DD59E2C764CC5547153856A8 | sha512: 104A43051F7950D2CFDD94D30CC95466D3B5ADD9DA631FFF205994D704B7DB23050AAA32B3B97714AAEABE3A23E9DE1127C7005921841B51CE4430D20C7BD2EC
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<runtime>
<AppContextSwitchOverrides value="Switch.System.IO.UseLegacyPathHandling=false;Switch.System.IO.BlockLongPaths=false" />
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="Newtonsoft.Json" publicKeyToken="30ad4fe6b2a6aeed" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-13.0.0.0" newVersion="13.0.0.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Memory" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.1.1" newVersion="4.0.1.1" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Runtime.CompilerServices.Unsafe" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-5.0.0.0" newVersion="5.0.0.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Security.Cryptography.Cng" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-5.0.0.0" newVersion="5.0.0.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Security.Cryptography.Pkcs" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-5.0.0.0" newVersion="5.0.0.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Threading.Tasks.Extensions" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.2.0.1" newVersion="4.2.0.1" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Collections.Concurrent" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.11.0" newVersion="4.0.11.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Collections" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.11.0" newVersion="4.0.11.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.ComponentModel" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.1.0" newVersion="4.0.1.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.ComponentModel.EventBasedAsync" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.11.0" newVersion="4.0.11.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Data.Common" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.2.0.0" newVersion="4.2.0.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Diagnostics.Contracts" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.1.0" newVersion="4.0.1.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Diagnostics.Debug" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.11.0" newVersion="4.0.11.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Diagnostics.StackTrace" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.1.0.0" newVersion="4.1.0.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Diagnostics.Tools" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.1.0" newVersion="4.0.1.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Diagnostics.Tracing" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.2.0.0" newVersion="4.2.0.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Dynamic.Runtime" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.11.0" newVersion="4.0.11.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Globalization" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.11.0" newVersion="4.0.11.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Globalization.Extensions" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.1.0.0" newVersion="4.1.0.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.IO.Compression" publicKeyToken="b77a5c561934e089" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.2.0.0" newVersion="4.2.0.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.IO" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.1.2.0" newVersion="4.1.2.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Linq" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.1.2.0" newVersion="4.1.2.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Linq.Expressions" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.1.2.0" newVersion="4.1.2.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Linq.Parallel" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.1.0" newVersion="4.0.1.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Linq.Queryable" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.1.0" newVersion="4.0.1.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Net.Http" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.2.0.0" newVersion="4.2.0.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Net.NetworkInformation" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.1.2.0" newVersion="4.1.2.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Net.Primitives" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.11.0" newVersion="4.0.11.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Net.Requests" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.11.0" newVersion="4.0.11.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Net.Sockets" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.2.0.0" newVersion="4.2.0.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.ObjectModel" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.11.0" newVersion="4.0.11.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Reflection" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.1.2.0" newVersion="4.1.2.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Reflection.Extensions" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.1.0" newVersion="4.0.1.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Reflection.Primitives" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.1.0" newVersion="4.0.1.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Resources.ResourceManager" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.1.0" newVersion="4.0.1.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Runtime" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.1.2.0" newVersion="4.1.2.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Runtime.Extensions" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.1.2.0" newVersion="4.1.2.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Runtime.InteropServices" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.1.2.0" newVersion="4.1.2.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Runtime.InteropServices.RuntimeInformation" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.2.0" newVersion="4.0.2.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Runtime.Numerics" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.1.0" newVersion="4.0.1.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Runtime.Serialization.Json" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.1.0" newVersion="4.0.1.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Runtime.Serialization.Primitives" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.2.0.0" newVersion="4.2.0.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Runtime.Serialization.Xml" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.1.3.0" newVersion="4.1.3.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Security.Cryptography.Algorithms" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.3.0.0" newVersion="4.3.0.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Security.Principal" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.1.0" newVersion="4.0.1.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Security.SecureString" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.1.0.0" newVersion="4.1.0.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Text.Encoding" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.11.0" newVersion="4.0.11.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Text.Encoding.Extensions" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.11.0" newVersion="4.0.11.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Text.RegularExpressions" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.1.1.0" newVersion="4.1.1.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Threading" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.11.0" newVersion="4.0.11.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Threading.Overlapped" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.1.0.0" newVersion="4.1.0.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Threading.Tasks" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.11.0" newVersion="4.0.11.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Threading.Tasks.Parallel" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.1.0" newVersion="4.0.1.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Threading.Timer" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.1.0" newVersion="4.0.1.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.ValueTuple" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.2.0" newVersion="4.0.2.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Xml.ReaderWriter" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.1.1.0" newVersion="4.1.1.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Xml.XDocument" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.11.0" newVersion="4.0.11.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Xml.XmlSerializer" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.11.0" newVersion="4.0.11.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Xml.XPath.XDocument" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.1.0.0" newVersion="4.1.0.0" />
</dependentAssembly>
</assemblyBinding>
</runtime>
<startup>
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.6.1" />
</startup>
</configuration>
md5: BB3B43767F13A6A8B48F3B5AF00D1E4C | sha1: C2FC92A63FB1FB74A7EBBEEEA2707686323A2A46 | sha256: A4C9995E66ACFC0661274D758D97D3F85D92B9AC98004F4ED2713957AC4F117A | sha512: 2E13249483719BE680FB09DE883859915380D4FBE7FB0B4DBDD38785560062A24463C9F986C9840E49C0FBBCC9BD7DDF1ECAB29EF3B728A13515B6011D4AD352
<?xml version="1.0"?>
<doc>
<assembly>
<name>Cake.NuGet</name>
</assembly>
<members>
<member name="F:Cake.NuGet.Constants.NuGet.Source">
<summary>
The config key name for overriding the default NuGet package source.
</summary>
</member>
<member name="F:Cake.NuGet.Constants.NuGet.UseInProcessClient">
<summary>
The config key name for using the in process client for installing packages.
</summary>
</member>
<member name="F:Cake.NuGet.Constants.NuGet.LoadDependencies">
<summary>
The config key name for enabling loading of NuGet package dependencies.
</summary>
</member>
<member name="F:Cake.NuGet.Constants.NuGet.ConfigFile">
<summary>
The config key name for overriding the default NuGet config file.
</summary>
</member>
<member name="M:Cake.NuGet.InProcessInstaller.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.NuGet.INuGetContentResolver,Cake.Core.Diagnostics.ICakeLog,Cake.Core.Configuration.ICakeConfiguration)">
<summary>
Initializes a new instance of the <see cref="T:Cake.NuGet.InProcessInstaller"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="contentResolver">The content resolver.</param>
<param name="log">The log.</param>
<param name="config">the configuration.</param>
</member>
<member name="T:Cake.NuGet.INuGetContentResolver">
<summary>
Represents a file locator for NuGet packages that returns relevant
files for the current framework given the resource type.
</summary>
</member>
<member name="M:Cake.NuGet.INuGetContentResolver.GetFiles(Cake.Core.IO.DirectoryPath,Cake.Core.Packaging.PackageReference,Cake.Core.Packaging.PackageType)">
<summary>
Gets the relevant files for a NuGet package
given a path and a resource type.
</summary>
<param name="path">The path to search.</param>
<param name="package">The package.</param>
<param name="type">The resource type.</param>
<returns>A collection of files.</returns>
</member>
<member name="T:Cake.NuGet.INuGetPackageInstaller">
<summary>
Represents a NuGet package installer.
</summary>
</member>
<member name="T:Cake.NuGet.NuGetModule">
<summary>
The module responsible for registering
default types in the Cake.NuGet assembly.
</summary>
</member>
<member name="M:Cake.NuGet.NuGetModule.Register(Cake.Core.Composition.ICakeContainerRegistrar)">
<inheritdoc/>
</member>
</members>
</doc>
md5: 5220EEFD7753E11B99D73FAF39FBB486 | sha1: 7D8264BE4FCB17F81ACB8B1ADD980CD96A6FD856 | sha256: ED5BC605F7F9FCC382183ABEF06C354DAD946ABB42A07631712077B2157D6BC9 | sha512: 81E483BD76240543704194C0EB0C8A9E7DC46AA535653E7D5590E00C002B2980237ADA793C05C0EEDD5D1A92DE90055867B21BE665FF94FAC038E280939C66C1
md5: D40EBA5F1A6EBFDA08C89EA221C17A76 | sha1: A2A5C493C45CF4AE261FB93CBFBBA28BB19B2BCA | sha256: 817827103FF6600A5121BB8CA89F6E45076C7E91DCBDB3B87A20DE4A575088FB | sha512: D6756698873A09D1D877414FFF2986F1479BAF4FE53611125AF4A8017ECB84D694195839437C7729769EC731CDB88D8B9E06A84877D9A98282E791613A3F57D2
md5: 623141CBCE80842FCDB463857E4ABB25 | sha1: B4911EE34DBE11B045E59F41BC7A14DF5CFCF780 | sha256: 2CB26A9AFF2BFE6767871843FCF924F48171A74EB042B13F021CB271B648CB80 | sha512: 70C7C893A99521883C06FAC56F4ABD69F7ECCD1DBA667599C6EF43436BB4A24A04332B60C91E812206AE51411062438B329E0BAAE08E852C8C1CA476A2BF9DFB
md5: CD60AE1180FB2AE0F96C28D78A85A0D3 | sha1: 36B4E6DA43163E9BFA530DD52CE8CB497321534D | sha256: AC6EDB95284A55DEC4881063F2164BEB1E4CA0E591E7495C7560FE40589DE67A | sha512: 3542F285FED31B9A9F70850576165966C4EF6EF171E370BB09167511591E379C4674ECD047C21787953D78E5BA156DA096E9DADC5B1B8B8749638933F9FBC002
md5: 6FC4A1B5733B8A6A2546CDA9F816EBEC | sha1: 79B31D5C93A23D9BBE1D652089809F6393FA9163 | sha256: 4CAA0B3127857498C49C1BC9A16C4B9337B4EE81855CC6A6B268F43DCFC25486 | sha512: 02178B7F4D028A07F287D877C1B7B758C3DBF8ADEA6D852848AAA1D6DBE87386613FF42369A85871FE465A43C2062769A5DD8917A178A0D321A7E57C8F76CC93
md5: C47F55D1EAE86AECADF6EE927019EDEE | sha1: 9D4CBCF74D573CB2938FD6C6544210B8E67E2F65 | sha256: F0F60C9257297D67D8436868A4DC60A0CB3BE2E6CB9FA48322A2125A05E697A3 | sha512: FD970EECA8A35EDAA7F6EAF43A07ADA52921BA6D0C3980F9CCB287FB2476606264E4E922C293808B306997634C7CD76F2E427593ECF680471A75BBEDAE40EEF3
md5: 76B8D417C2F6416FA81EACC45977CEA2 | sha1: 7B249C6390DFC90EF33F9A697174E363080091EF | sha256: 5EAA2E82A26B0B302280D08F54DC9DA25165DD0E286BE52440A271285D63F695 | sha512: 3B510CDC45C94BE383C91687C2CB01A501BA34E3FBB66346214FC576D6F0E63C77D1D09C6419FC907F5B083387A7046C0670377AD2E00C3EC2E731275739F9C7
md5: 0ADF6F32F4D14F9B0BE9AA94F7EFB279 | sha1: 68E1AF02CDDD57B5581708984C2B4A35074982A3 | sha256: 8BE4A2270F8B2BEA40F33F79869FDCCA34E07BB764E63B81DED49D90D2B720DD | sha512: F81AC2895048333AC50E550D2B03E90003865F18058CE4A1DFBA9455A5BDA2485A2D31B0FDC77F6CBDFB1BB2E32D9F8AB81B3201D96D56E060E4A440719502D6
md5: 081D9558BBB7ADCE142DA153B2D5577A | sha1: 7D0AD03FBDA1C24F883116B940717E596073AE96 | sha256: B624949DF8B0E3A6153FDFB730A7C6F4990B6592EE0D922E1788433D276610F3 | sha512: 2FDF035661F349206F58EA1FEED8805B7F9517A21F9C113E7301C69DE160F184C774350A12A710046E3FF6BAA37345D319B6F47FD24FBBA4E042D54014BEE511
md5: 90A824CFF2535472EDD6118C3BB1FEBE | sha1: BAEF0E5707CB5B0DE1145DA8BD55261E414113FD | sha256: 745659F7A3DF4949F0010BF6D28C1158C4325FB7E148A1CC56E4032920570DD6 | sha512: 918684BC0CEFAF9E249F5088823DE6E9A11143767827C9933240948051B20DBA80F2078839638B78B31B1319D80B46EAC6453078D2765E97CB4E113A8294BC82
md5: 87AC3F38EC14E4AA70CC7BB19A11CB10 | sha1: AA96D9D61D737479FCE8746E8C497F3F148E4731 | sha256: C9A957B0F0E92C46CA06183730C04A06DB153E721B6B915B5ED102E80A0D519D | sha512: CA8C9AC421A692B7F961FFE3586D76EC425293755156B0F4449BB102E9F08CA1883A84E20EDB67B26C72E8FD406858870E8F773F506A30F7FDF7F3BD20BF1312
md5: 29DFC7528F5AC69308152ED9EEEE22C5 | sha1: B806351F5CDD252E69D6CBB6D499D8AC4AC87BD3 | sha256: 7D88384B21617827F08ACAFCF2E875384DB599576C0A6D8165FF9178161369F5 | sha512: E542828BC5EE539DBDAEFBAD889EBC443CF3F85BE585BCDC8E7270F7E443957D829CA9C6146FFB74637D863427EA253B23B1EDC1A4091F408144BB0C375BAD34
# Cake
Cake (C# Make) is a build automation system with a C# DSL to do things like compiling code, copy files/folders, running unit tests, compress files and build NuGet packages.
## Table of Contents
1. [Documentation](https://github.com/cake-build/cake#documentation)
2. [Contributing](https://github.com/cake-build/cake#contributing)
3. [Get in touch](https://github.com/cake-build/cake#get-in-touch)
4. [License](https://github.com/cake-build/cake#license)
## Documentation
You can read the latest documentation at [https://cakebuild.net/](https://cakebuild.net/).
For a simple example to get started see [Setting up a new project](https://cakebuild.net/docs/getting-started/setting-up-a-new-project).
## Contributing
So you’re thinking about contributing to Cake? Great! It’s **really** appreciated.
Make sure you've read the [contribution guidelines](https://cakebuild.net/docs/contributing/contribution-guidelines) before sending that epic pull request. You'll also need to sign the [contribution license agreement](https://cla.dotnetfoundation.org/cake-build/cake) (CLA) for anything other than a trivial change. **NOTE:** The .NET Foundation CLA Bot will provide a link to this CLA within the PR that you submit if it is deemed as required.
* Fork the repository.
* Create a branch to work in.
* Make your feature addition or bug fix.
* Don't forget the unit tests.
* Send a pull request.
## Get in touch
[![Follow @cakebuildnet](https://img.shields.io/badge/Twitter-Follow%20%40cakebuildnet-blue.svg)](https://twitter.com/intent/follow?screen_name=cakebuildnet)
[![Join the chat at https://github.com/cake-build/cake/discussions](https://img.shields.io/badge/discussions-join%20chat-brightgreen)](https://github.com/cake-build/cake/discussions?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
## License
Copyright © .NET Foundation, Patrik Svensson, Mattias Karlsson, Gary Ewan Park, Alistair Chapman, Martin Björkström, Dave Glick, Pascal Berger, Jérémie Desautels, Enrico Campidoglio, C. Augusto Proiete, Nils Andresen, and contributors.
Cake is provided as-is under the MIT license. For more information see [LICENSE](https://github.com/cake-build/cake/blob/develop/LICENSE).
* For Roslyn, see https://github.com/dotnet/roslyn/blob/master/License.txt
* For Autofac, see https://github.com/autofac/Autofac/blob/master/LICENSE
* For NuGet.Core, see https://github.com/NuGet/Home/blob/dev/LICENSE.txt
## Thanks
A big thank you has to go to [JetBrains](https://www.jetbrains.com) who provide each of the Cake Developers with an [Open Source License](https://www.jetbrains.com/community/opensource/#support) for [ReSharper](https://www.jetbrains.com/resharper/) that helps with the development of Cake.
### Sponsors
Our wonderful sponsors:
[![Sponsors](https://opencollective.com/cake/sponsors.svg)](https://opencollective.com/cake)
### Backers
Our wonderful backers:
[![Backers](https://opencollective.com/cake/backers.svg)](https://opencollective.com/cake)
## Code of Conduct
This project has adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/)
to clarify expected behavior in our community.
For more information see the [.NET Foundation Code of Conduct](http://www.dotnetfoundation.org/code-of-conduct).
## Contribution License Agreement
By signing the [CLA](https://cla.dotnetfoundation.org/cake-build/cake), the community is free to use your contribution to .NET Foundation projects.
## .NET Foundation
This project is supported by the [.NET Foundation](http://www.dotnetfoundation.org).
md5: 5070D54879AE7C17A013E05DF9A26FE6 | sha1: CBBB3F55AB254357D3FCDF4974D578C18F008F6C | sha256: E1E55A6EE287CC00C71337B13E9E07395FAB1011FC1E91783958456DC912C3DC | sha512: 3603913F427761AF6C5D16E931589D12A7FDBE225835E95592E3CD610A71F8EBC19EE4030E446EB0C2AC7C275B1C0A6BD9F7E3C371F4BF69189D321445CC8E5B
md5: 4CD17DBAF1C88B36B8988BF88BB12C60 | sha1: BC3D139CA8631B8EAF2918F3216860177CD46E6B | sha256: C3F49CAE687F100C902531B3265C032CD9C0453C3CC5651A31C4DEB48FAD467D | sha512: 9223830244ECD334B89B5F58CE4D0945B19490862700099A6A245C9D69D8D05D86CF5E095283F2DEB6AAA5F45C14085DBBA836B05CEE70734E70BFD5171241F0
md5: E01EC24756FD3DEDEFA2D74F844C75D9 | sha1: 654C0579B1D58DC3A1DD8BDBAE88BC185E1779CB | sha256: 086B96BDA988BB1DCC425452D1E0E81946ADCA0D1720269595FD3294D36E9BF5 | sha512: 551FB3A8654DBA7BE32E953D194C07FCA277FDD285EB7027B09EB591F546D2DD9538D4E249649DC3522CBE21D1B3CCAD8094B946265B14A7D7C5EB7A2F6F3D58
md5: 0FF42273BC5ABBEA18AF045283E222D5 | sha1: 65BAC81D204F5E1B9968F24101D20958D0D7ACEB | sha256: BABEBBD78DF42AD37D9C0D6EF4E10ADE7D101F1A1483BFA977EC916F8F088521 | sha512: 1E988CE91A75A62FC50429CF42A223C19DCF642D58268B5E14E5441C8D2AE0F582C3452BA04160EA3C357C91D526B0C3E14AB9EAC1F170F34EA9BC634C546C5A
md5: D10347F1E976542BD0C307C6749EC575 | sha1: B4EF661F5A4210BB7997C7A2FF9E7D32497F773F | sha256: D02DFB3D9394C7C7A5E3D21124B9623EAFE2FEF16346FD60CECA7BC61652428D | sha512: 1287C1B4FB25508BEA41945751258F956AFA832799AD5E05A2262CA19FB62E7B38383DF4B980EA548BFE2CFFD7E9C691BA7045CBA91D93C8CDD3867DD5DA2E45
md5: 8CC4C7DFEB41B6C227488CE52D1A8E74 | sha1: 93702135DB0646B893BABE030BD8DC15549FF0C2 | sha256: 9DC115AC4AADD6A94D87C7A8A3F61803CC25A3D73501D7534867DF6B0D8A0D39 | sha512: E4DA7E3AE5CA31E566EA0475E83D69D998253FB6D689970703A5AD354A2AAD1BB78D49A2C038F0A3C84A188D091696191B04E4A39253DEB3B6CB310B72F02F97
md5: ECDFE8EDE869D2CCC6BF99981EA96400 | sha1: 2F410A0396BC148ED533AD49B6415FB58DD4D641 | sha256: ACCCCFBE45D9F08FFEED9916E37B33E98C65BE012CFFF6E7FA7B67210CE1FEFB | sha512: 5FC7FEE5C25CB2EEE19737068968E00A00961C257271B420F594E5A0DA0559502D04EE6BA2D8D2AAD77F3769622F6743A5EE8DAE23F8F993F33FB09ED8DB2741
md5: 559C98EB9633C7BA1BC813F8E6E0E9A5 | sha1: 311F52B31611E6DC5FD4C0159BFA452C22980CA7 | sha256: CC62F3B867D50083C2932061F20662C698D2E1A741C4D2F9DF1FD2D435E3EF3C | sha512: E241C16869D1CDBB2C6482A7C5B2AF93DE4BA0CEF8185B8826EEE35ECB174F35F7585C8AE0320F7F4F6B80F3BB5B3EDAE2383760F2F35637F03C3A0E38E0875C
md5: 1D8AAFECA1EA565B257384D3F64864B0 | sha1: 4D923B100142AFA2E0A8B7ACDB3A6DE6FEB91148 | sha256: C2250E9E51B44D8AB8C5B892592766925F6580EE00B95026621D0AFB037C2707 | sha512: 99E4A226E1FABB348E7EF7C6FA56AD0CE4E4CF5D8569CE21881703DCA8D83A1C113FD5F440A4FC9E9B99A04AE8CF4490E17D62FFC09CFAC5A45678A4419EFDBB
md5: C598080FA777D6E63DFD0370E97EC8F3 | sha1: 9D1236DCFB3CAA07278A6D4EC751798D67D73CC2 | sha256: 646D3B52A4898078F46534727BDB06FF23B72523441458B9F49ECC315BF3EF5C | sha512: 8A5B4AFB4363732008C97D53F13EE430401E4A17677AF37123DA035F15F9E9409A2AEB74AE238379291FD5DE07C3CD4E3DE2778DA5EDF83A42649FA5B281CB32
md5: 45FF71114047DBF934C90E17677FA994 | sha1: 526C688E71A7D7410007AD5AA6EA8B83CACE76C5 | sha256: 529943C0CDF24F57E94BF03FAC5F40B94A638625027A02DF79E1E8CB5D9BC696 | sha512: 29684AC5391268EAA276196A6249364F6D23ABFE59BDC304A561CF326CEA6CD662FA04C05E15924FD6D3F9E9D1607992B8DCAD3F817CFE891580F9D9462FE9B7
md5: B52C339601CB264F83DF72D802E98687 | sha1: 8BBB7BADAAA912C1F17775E9ACDCAB389704C772 | sha256: 938DA38561DA54793944E95E94B6E11CF83AACD667487297D428FBCE1C06DC9C | sha512: 287F08AB07827570F9F3EF48A6D7E5C186899A2704FB3DBAF36975F6BE7B29FB6695A69FAB85A6F09BDDEFB60C79052C3A33CF862651F892EB9D773D880B3AF8
md5: 632CC8AD69B76FD9BB5847DE1E1439F7 | sha1: 2E32D50EC33EC6635681485B754F4E58D434A5EE | sha256: 5E61D755616CB10524F5F31E9B70C65A7FFF8E30E25CE711AC8B354D657AB479 | sha512: 9BA5CC82573308E5D995BA05BC660FC1C087EB91D8BD7EFCA6FF838A3C47BD6118D9C92919B2E0DAC11A5A27977318C5C819499DC19CD5D6E57122A0749858C6
md5: 6067ECBAB3C6DDDB6BF7C49C7948CAA8 | sha1: 5F3DA777AF01DBC159BD8D9D97D5DC105918AFC5 | sha256: 22108E32E0B6E42F5F52A4CB17B9B6FA3DFD547ECD9EEF9C67226DBEC54D23E5 | sha512: 9F3E834B8342E0C7AA5CCC993B520D664B03F1F0091066C66067923E1D4991EFA03F63908552538C05F423AA2B696DE7C76993F71A7564F3E87662CB0FC00726
md5: 2F39655CCFC010E32A7240D9BF5D0852 | sha1: 20AEAED12DFB8D71E39687350EB12BC0DE372AF0 | sha256: BFCD867F71C887429DFE008D7EC5D1853D15B3932D4CE8991694293477B5BE37 | sha512: 9769E59279A32F29C2F2C6970C81D3ED76FE3421B819DDFFC8FA98329F1B45300C737FDF71956672F80F69B3A75727D184F8C421E00B84E94163A86CB744A991
md5: D1699287934DA769FC31E07F80762511 | sha1: BFE2384A92B385665689AD5A72F23ABC8C022D82 | sha256: 0DBB92ECD5DFA7FC258BC6DEED4CECF1B37F895457FD06976496926ABDB317BB | sha512: 4FEF3E1535F546FFDDE0683F32A069BEEFFE89096524C7068F1F5CE8377824F82AE530D3990C9DD51BCCAA9E53FDED5613FA1174013325808059276DEE771187
md5: EA9376C17EE0148F0503028AD4501A92 | sha1: 9D5686CBF45E90DF5E11D87E7B90173A1A64B1A0 | sha256: B537313413F80105F143CC144FEEAE2AC93F44747727DE309A71D57D2650034A | sha512: 18D1BB2D5C469644078D75766DBF04ADDF7D0C543F7ED15FF522CEEAEF960900DD8EC68172F5D684B76B0AA6946BB38D641F021EC04C70AD66A6062C10412E0A
md5: D712A5A82A446086443CE00B610D8A5D | sha1: 7ADD96BAA123DB819F2F3D5AA62D6F872CE8FE14 | sha256: 1C7BFF6F16BB618648E699B723AEAFE511515CD6AAD699C25FAAE2A507E22811 | sha512: 225128E58E2F01B5CAADA6FE54B1D32FF6A700542CE22B425649AB22DA2944F796F04D1A2428C542BCAB5348A161CF73F5F9A1E7BBF1F6417C4D507217FE3FD0
md5: 99373AB10858746AAD424F28B48277F5 | sha1: 5042EE630A6C7C2986E8323A14D052C1D83B6F61 | sha256: 9C4AE61E0E8365762EFE3D34C5595029F2C12E0079E6070720E2CEF0882C84E5 | sha512: E96F8FDD6FFB702D344746CE82DE576BBA8636EDE3E39A7DA18CCF8A0178B8346FD31140760B864F1487D7804D931FF1A18DE07A4CAFA0CF79BDB340421FC03F
md5: 8B8C402311D7AB87E588675E736414FD | sha1: EB8C010A35B461402C1C33133F1B61C78BE8425A | sha256: 55A30D92D163CF1807BEA6DC13B4C13E70AEBBB034DC77EAEF4F4394730DCD8E | sha512: D03F450A3A19320DE71145E48CD7C088D9B50D0A683CC9A79D8967DCE085A6F63CBE537FCA1C6208865EB52EAFB10189613C7233047318CAEB2FB2C23C34A269
md5: 444E8AEAC913A963CE467899509D81B1 | sha1: DD72865A845605E828042BB05C97EDFCD8A87C3D | sha256: 7A953C41AEBD1F3E5D7AA32AE20B6773D7481206B61CB6FB8AE03F7A86B55113 | sha512: AEDBF56556F709D4174B796FB4AEA7F957BB03D709769BBF4F9A5C092B831BC90ED9D2BC332AF95D2FB363F1B142461204C1DBBC66FAA12B3B5B809A52F6825D
md5: 0D9A641105098D642567B22101A4DE0B | sha1: 12419C25D1C2EB706A4E4E649EE353CEDA7446A9 | sha256: 7C25A74772E135257235640A0264DDC05235E14F3627896CFE735E9955155F83 | sha512: FD4560CDF01DE237DDF797A33C5DBC220D3FCAE07EDE17D43C39F5562E36E03646676A87E20699D7603FCA6D84F66C8756EB863DD4727B7E1A499619BB88DDE1
md5: D86B0ACA05321569D9383DC7C4E9E934 | sha1: 2EF7D0A222C3A3E564B3C72D5B71A5BE40A7ADEA | sha256: 28B165CDDB82A2507114394AE398995EF8A50C549214F8678AA66054F6927754 | sha512: 5959E1129C983825233A07869DD1B2B1DB32830D2B5F6B7F8D869C39A76A241F88F76D37341FDFBF56F000FC6ACBA19AEB36A7EFB94721494B41B65BF4978651
md5: FA98A0F020248C2BE1DD40C07092F22A | sha1: EF6B3CCFF90BEDDAB5CE6F60B4CC23F75EDFD009 | sha256: CAE99F910874288AFBF810968D13B79D755CD4B2006609EC036EA4934181CBA5 | sha512: 554A25C761102DC41A9E421621E329868D1162AB29F47E59754C8FCFAE0C12BBE8200E1B5975ABF926F1DE0977A5407C43202AC8A2801C69A7F01D95B6A1E959
md5: A964808487E671BB369DBC0E4DC5A947 | sha1: C3848473E42E2F9B4D0A00180EA9ADE654432587 | sha256: 63EAB38EE9F4DCD686C8E6A4F01E1E2A9BB91E52B20AB4DDE0C28061E9261860 | sha512: 7352368B68835ECC9C5943AE2F2BD5CAB775A7FBB018AF7683E74FAD1731A9738AE14EBE0BCCD854A223AB762FCA7EC11411FDAE865C5C6DDD034900FA55CFD0
md5: 27C7D752C11C3F43F28EB31968E73E2B | sha1: 51E466218025126C5E524AFD2086F4AB0BF3660A | sha256: 260C6250EF9B57DCA99B4CECC533F9A34857B5A32B5351202F776163841200AA | sha512: 393D1747911A7F91F4C4F4F363A3782F24E00431478088DA454823A223A4E75E51D9B010FC5D9746E2BF0185BE90071B6CB70C777337D718B39151EEF6B486AA
md5: 37BE4CCE0ED037F8D9A7A3940BD2A2E1 | sha1: 96314EC1A59E4BB53C5B609BF79AD4C998A7A988 | sha256: C81A57D0634C462A6CF49844059E9B170F650CCDF0789519FFD4AE7D28E2718D | sha512: CEDAC24F414CCE5053FDF10779DBD153FCEBAD69B3960F75A5AB1110DA18799C79DC01B30269641022FCD874A331BC2DC7CE1A7D1A60DC90E109DD55B58665DB
md5: 60F59659DB517C2F4DD4C5C583D43097 | sha1: 87ED79D195D8D93AE1155AF08857F751A7ECA245 | sha256: B84B93BE455CC7D14EC0C88CE08DAFAC7B6AAC2E549C969E7126EB48C31F8B1C | sha512: 90BCEA3BAA04146F08013A832633957C6D511D5EB52270575EF9A571153384B5A02C5026361B70940775907B5BC710B2C91627EEACE432744F3B9E5E1ED509D6
md5: 29B0A1554E54611EBBA7911049F26FD3 | sha1: D707745E72D2F39374F2D28AF52AAAB7888B93AB | sha256: 2805A18724A24034AD6ACB315DAC516E479CECC5F3753204052657E560932D5D | sha512: 17558306A611BFAC6982D5650335B05EA407191290B653C028896142EBEE2ABCEB22F7D71926FBBCC3FAB8227C61A5FDA0E770ABFCA021AC7F891C9C7EE42E81
md5: C5CADB1409F25B6A1C7A6DD4C2DF236B | sha1: A994C87352486D433A06943C01329DD721AB343F | sha256: F600ACC811720183C639CEBE5618BAF9C8135B85B9CBDC0758BC9B2DCC6DD7A9 | sha512: 6BD6E482533B9FF8FFF8823F84CDE7191A0FD5575F76891A95E99CD1F5C1122EF92B436745EC9583089445FD5EAC795181759080B1D83CCFA1EED31D9CCE3AF0
md5: AC2F4B435DDF0600D7A866F42F3B40D9 | sha1: 0564FF7F7E6084BD6D02D8E6A4127D1C878B3FA6 | sha256: B56FFB65B842DAAE13F3020B0B04646DB92F89801D2A2F89087D145A996D43F7 | sha512: DC3E9C3B4D732801DCF43CFD6CDD2672F01E03CB99D804A3F4803FDDB9CA9817BCFD2F96FD94B7B33DB0994F5478CE200C048DB5DBB78D3B24E950262EBF4D28
md5: AE023BB0BEEE5189A07C7FD4E0CF3FCA | sha1: 846711D4161A3950FACDEF97037898A71F4EFDA1 | sha256: 56BD0C02C734ABF4D7FD1EF2E8B6A9E4BF5E4BAB4E606CD1023D63B02852FA61 | sha512: 62305027AE8BB5B830630FE54F2CF9E607F9B97FFE28912C2CB15D429252668F17EAF2D7CEECF5601C889D5EA52E0B9100F115173BB11B5D6208171792833C85
md5: C7C93DE0627833900B8379FD181B7351 | sha1: 2CB98F9622F57A0A9E037A378519AA6A271302F6 | sha256: C7E91BD148ED22EE1FF8EBD3E58B199A30AF90AA37499BCF8DA34409672F2ED9 | sha512: 1067BACC4495EACBC27937B54780B97DA62FED1AF66158E2FA492FC82B068D49BB49BC20C3C82C22D8EDD300BD7B097E14AA1E317F1789744E188BCA15D22B4D
md5: 33B8972FA6B00B8922210CA95E5745D1 | sha1: 609F31B98831327677E89E08BFF7D7322BA0F4A4 | sha256: DA18D61BB6B7D35C56CB4F392FAE0844CCA73F72A043A08994BECCB531FF3B77 | sha512: F85F03E20C8CE40BCF28D883CCD80CED755BF75D515FA66986963F0F4F5AD00BB1823D8C100A75323147B28A4916DD6C598102B18999AEB7B358C196AF4206DA
md5: BB1A520F25BB93ACE4DD0A060FBA677D | sha1: 92BF07CCF32EB9FDF06F446A256E0271C4028BF0 | sha256: 7720EE13405EA8A3C204703A181E67DC6D66835E9DF263C09D04D8B48B41EB26 | sha512: 9288148EC879EBEAFD53C225854EE3BD3768BA5C7B829D6AF1251D20AC301FC27A04BEBB603FE2CDE6949BC5968FDE717E8B747337C1AD872450D26F7C36F515
md5: 809FDBD7422A3E02C89244DC530A3367 | sha1: A6999C04B243B034F8EE7AD0D79F3CE24DF9A9D0 | sha256: C191A43029EDD4EB8EEE003356F1FE79AA45071C25433A7A3589590E9089EED9 | sha512: 5232B7EF2B60A99BE2B027112078A7DEBF58BFA4308F4AE53DD9A96FA7BCCBB0927BEB7148E7A3944173F7820F9F519767539D1FDFEF848B6F1D6668BE11FC15
md5: BFCEB4FACA75681137455CD70F8038B6 | sha1: BFA0E27BE1D56BA48918A9B7CA7090AF7779A10E | sha256: 9A4595DBB128E2D8F373B3AC45478E7131F4D181B50EC821EC8CB88BD46BD5B8 | sha512: 58D7E8D6FA237A6EAC018C0A88D6BF76AD9EE49B6A6790B64E68C33EBF80AFCB4223881AAC6821132B877E7D848BC917EB9490590CDB297F362C9B43143D6713
md5: 2FCB2158FC41D97E2BB71953664B99B9 | sha1: 16EB49AFCA84C9E6160B4E5B36F1EC5C98470C86 | sha256: 984575C44CAB17D46587AF6CC8C22C409B79BEC280FD771E6AF93A0A0C20E5B0 | sha512: 1527A426F8EC9931573468929966E102012B630EC4AA370C196B2B87472BCEE696B00355ADAEB39B4151B986470F7DADA415E3F930D9678B68D3C531C8AC9B52
md5: 51B07204081BDE29A1F84A3B48554186 | sha1: FCA2F72C039937357099CA6E167330E540F8335D | sha256: 5C84DD40D67C0E59906511D2B09DA8E28C454B5979EB5FDE74213F9D4BDBC564 | sha512: 099EC1B84FCF6BF07142AD8CD34307C80F19A64C754ADE505AB55707075A764FBE7BFA4CE2FBAEAA09B3E61EBDB6E3D116608DF0CF77BC076C7B3119DB37A324
md5: 3772A3A7E55178EC90ECB607ABA28511 | sha1: 68C240D1A43DE1678EF13107B9300C544E9D5E4E | sha256: C9E2562F1A1B86ACDB6957CF916ACED9C4F8B71EBB16DFA0050252146205AD37 | sha512: 245F12B4926114EBDB39A54628A1DF2501C4A27ABD531172CC63BC96298EE0F4BE5658AE95FE730C063EADFB1B664C7D201C69C2246CFBA23ED5A4FE7EF3D14E
md5: AB8D293BCD7A13E83565B4AFA8438988 | sha1: 48F227C62B2001C441BCBC5B570911F096DDF421 | sha256: 0E80A2E256D16E487BC847D1857ED7CD088F176254BA2A385D675338B836B0FC | sha512: 443DD75234C043DE736423466C1FC2FF2BD9B6B9FE753521C3C225DE99F5A7D3828A470CF8EA54678A86681949E5DCD1DE1EAB35BF0F348F758FA099A9092F54
md5: 34E21101FAF71A27C6819CC051DEBC9D | sha1: D9DF77B4993418337894FF04C6B813224B9F8543 | sha256: 81B6527AC2D18782AC24AE463C11DD1D70AB1BC89F626B7347A592229B371A1D | sha512: AA339F2489CA9BC9EF7F6121C9586DBD8F5AD2CA5A160A3BCAC74B908570EC2FC0BC24E0EC33AE9DE9D6A6C3557EC2816FE8E89FFCA93E310503F6F83A691F6D
md5: 58A2E5AC0510B9223236B9317C505B58 | sha1: A00954217CA326C54A863D451820263A6D7EE1AF | sha256: 80A229B2917FC3A5D941FF9745A6BE0065028AFDF9509300410D2721C71F1198 | sha512: 18736ECFE0EF0C477BF64F89CA97AF4578DEFC996F0A5BAD33D7A29AF6E09745E4B10D6D543243B9664E40169EE550C996E783C5FFBB0FC767DA7FFC63E13FB6
md5: D74405753F829E75E89BBA5EBC296112 | sha1: 474944856DB781A34796BFCCE18ECD4580275AD1 | sha256: 86F1F12E47F260985B08BB966598123578EB5E48BEF9BB086F04E16E9D53BB32 | sha512: CDC5D49FCF0249C539E45C9917C152F130C8FEE975D97C2F62526F474CB779B2BF273195F4AA7A64F76DD2496528C0D021B56E60AAE2635606F9F55092CB47F4
md5: 5E33930FE2E0867CB1F9FABEDDFBD7B1 | sha1: 4D93C7D7E6315CA2195ED73716996ADE8E17FBB2 | sha256: 349C7FBE9AE2B78C2F90239BDDFCEA5B16A0FAAC1FE83553A816C50C3E9089B1 | sha512: 8F87B5013E0CF3A776BFB1F1A68F316A28AF3CB6C74F0ADF3EAD6D5063525C6668B42C077549F66267130959A9CB986BF5F8E4242FC4EF36C356D6927F587A0F
md5: 3B49BF361F3116DE28176B40845BC199 | sha1: 5627E53D15E56868DC9082EDCAE5A653B96B9AF1 | sha256: BF97F67165231C2A42B95F11D80337B082E2B2BE54351DA44C8A10C06194B369 | sha512: 0FE87438ACD6C14401523987BE617A83DDFD2B42938FC52E0DA5F941F7DC70686CC6436EDD41C4998FD56D5F52D64ACFAB5010B96B1E80C084C4AB9F546202A8
md5: 8BE0CAA60074176FA1E7E63C0AEB6C01 | sha1: 4D4AE0D2664025327F28400D917CC59AFD69F33A | sha256: 30A49D16436E3A05569C99A0C2D21755C2FA323C5B925F9F21C10287CC97D9C9 | sha512: 057F21A7E7496343C06CC497A24E46E59218EAE1838885EEEF7391285CDE243AFE853155F52933959B40F40AA7028A289D15D279833208BBA42BF853D4DF91C6
md5: E04CDB6229D83768285ACB08D870F23A | sha1: A181F5CC93E9273D9169A9954A74D73BC1852980 | sha256: 719AC73BB261E0A13574F5A198126CCF40352264958DEFB555280D005134C704 | sha512: 257FB07C0D86E292FE6FA88E03B29994CB9864C17A535CE7B366A728EAA4B3A803D88A23157CAA457D0B681A2C0D97DD7D9A2754300B73030D9A09C4E9004772
md5: 6FB95A357A3F7E88ADE5C1629E2801F8 | sha1: 19BF79600B716523B5317B9A7B68760AE5D55741 | sha256: 8E76318E8B06692ABF7DAB1169D27D15557F7F0A34D36AF6463EFF0FE21213C7 | sha512: 293D8C709BC68D2C980A0DF423741CE06D05FF757077E63986D34CB6459F9623A024D12EF35A280F50D3D516D98ABE193213B9CA71BFDE2A9FE8753B1A6DE2F0
md5: 665E355CBED5FE5F7BEBC3CB23E68649 | sha1: 1C2CEFAFBA48BA7AAAB746F660DEBD34F2F4B14C | sha256: B5D20736F84F335EF4C918A5BA41C3A0D7189397C71B166CCC6C342427A94ECE | sha512: 5300D39365E84A67010AE4C282D7E05172563119AFB84DC1B0610217683C7D110803AEF02945034A939262F6A7ECF629B52C0E93C1CD63D52CA7A3B3E607BB7D
md5: 2EEC710DBAACD32BEDFCA09ECA8DE52D | sha1: 2CB934305D3648FF29FDBC7D92485003F8458848 | sha256: 222BD77C5692C2961E8C3638F6511D6F7CBEB9E0977E2D5C3BCA6739A5311F37 | sha512: 03F132E1BAC629A394A093D59550B22D5FD4C4D6F244697173229282741A9CD6669C4256C024467CE94293C74F304560066711C35620AB4750621502AA67B5B1
md5: F39A35095CFD0019D6D4BB8461750BF0 | sha1: AD55AF22E5479A5ADDF01D698138E5149270E3CF | sha256: 2E2D28A0802D8C8C08C0D422F48733AD8BF1DFAE75F5682A4A3DF8898E7E819F | sha512: 25FC9D4254DE0AFAB9AE3E19B8B225E1D875DCACE6CA2C83F768B62C0E2B331CC9DD2988DFF7994B5819FB0DD7A89A49FD19E653FC2E4EE656182E08A969A93D
md5: 2A459C2C395F54352A16DE4AA0E5407F | sha1: 1BA9ECC598E170D779CEB290163AC88E6993935F | sha256: 4D97E8481B9A27042BB903245625735D82FF627C66797DE619303C1E705D0D6A | sha512: 28DCB8B6E306015D2004EC00443652CE986AB8E09FB09EB82193BFB0604268CA63C527FF64B6364F63C3ADBCDAF5FCDF4D1494243BFC8F6BB629BD213073BD7C
md5: 562F67001889CDBC2531947636418EE5 | sha1: B219DD45550762B54DAB46533D489C4755F55E0E | sha256: 9A8BA725F8E953C933285065228A9409036F9137D03016B127CCEA8A19452466 | sha512: FDE868018D24FD72177EDE58952325B52561F9D44AE02A4A2268E445F47ABF3B81B809F443D362DF83BD6667B5988AC2CA15242B9F76A0B5FB5B444FADA1BF26
md5: 28141960A88365DF6A60B0C6FF831B0B | sha1: B56C3D2E270B1C793A2EE17CAC9C98B178258E94 | sha256: F2E74A3EC2DC753C9A48FA9A677775F949EB1E02FC1BB8BF38C39E8D2AB147EB | sha512: CD44E789A6C04E2BC3B07810B57CC83787F06530065FDCE069D89E42557F40770923CC705E73B7699731166F19FD7133FBDD8EDD578D308A4F72CBB29E76939F
md5: 8D00682E84D1D773D2160B63C0380BA6 | sha1: 5E4158533532A27E03D0CCC9A0AF5E89FFFD8637 | sha256: D0D90152136A0ACF340FB345098F2E5C718BB13F3B5A809D7BE4D9948B8574D4 | sha512: 991FC952B452446255963AEB4F11C74E7116E15B666924452F3C0D15517322EF1D925DC44BC1F003E8483B5C0B34AD71D54ECAEE360FD9E942664FDEC4E37E99
md5: 8C9D9F45B85526E491F6555B1566A41C | sha1: 1420EF91F6E0F6954F373F1AC4079064398AB455 | sha256: 694F4C61B6BAE0AEFAC07A1E861C12C03CB6002F30091E4C8B05BB9C8CCF0D3D | sha512: 38890886C641D7E6E76A3D4D984215C680F5DCF12129BA2EBD560644EDA793335B01C637C1F6744C249DAB1FEFD5AEB8D1B212475221C03DF3CA82413F6670C0
md5: 7DA1FEE108A0750F47B70F25FE2CC55A | sha1: 6523838EF4AAB39D0D3C0DF11C28ADA449EDD592 | sha256: 69B48FF8E6F40B84CDDDB95BCDBB34E1184A2E29CB4CCC0FC9F1A2493648EE37 | sha512: 9C0E69C07B2ED6CAA9BB3FFD9EBA6C82A0B763F2DFB06341F6343C54DBC254505CC0350B96B79DC4062D8D28D47C79824E98BB293C8C85203E827164AF862B5A
md5: E06BAE626965FBDB0BAE5437498B5155 | sha1: 49392F58BE6F5C97C5DE59BFC44F9CFCBE1E5DD7 | sha256: 19766A20B62B038ABC3E863F2D6E7B55FABEE4D9CBCAD3EB1D7BD3EBFE8D023A | sha512: 69C6D8D5F8835DA31D36940F0AE793BD00D87E9CB9380C3A7B21FE3E315F192F95B8E63C8F9D0A3737C73673A0AEAC41FC728FB7B236F12453A953066F9E53E7
md5: 2E6378FEAEEE2F745417FC025C7850F9 | sha1: E0FAD5EF75676B2ED7CF155AF6602B867FCED041 | sha256: 99920CE34A01A0C07EFD86D6E134BB401993515D001B7567A4116AD222993A63 | sha512: 5A8C41F32598BCF8C8E315B18AD5F1BBC377D7B638DC05CAA3CC47E988536AA0EBE4718D73AEE39ED5004328BE3A9DE9722D8759E5DFD500038E7139DADF9638
md5: AAA2CBF14E06E9D3586D8A4ED455DB33 | sha1: 3D216458740AD5CB05BC5F7C3491CDE44A1E5DF0 | sha256: 1D3EF8698281E7CF7371D1554AFEF5872B39F96C26DA772210A33DA041BA1183 | sha512: 0B14A039CA67982794A2BB69974EF04A7FBEE3686D7364F8F4DB70EA6259D29640CBB83D5B544D92FA1D3676C7619CD580FF45671A2BB4753ED8B383597C6DA8
md5: 55D9528D161567A19DBB71244B3AE3CE | sha1: 8A2FB74CF11719708774FC378D8B5BFCC541C986 | sha256: 870EE1141CB61ABFCE44507E39BFDD734F2335E34D89ECFFFB13838195A6B936 | sha512: 5338B067297B8CB157C5389D79D0440A6492841C85794EA15B805B5F71CFED445EFA9099C95E5BDEF8CF3902A6B10F032BFC356B0598DDE4F89FA5B349737907
md5: 1A3DA139180E9FAB380033D8D1FE3995 | sha1: 3CA31DE7F0F0784559E5A73EBD0EFB42C34D18FC | sha256: 63AAF632EE7F3BC852C4D71C742CF1D26F18F784F6C89113E056B2599BA8F514 | sha512: D991298419FB5290D6906A1F9FCCEF56BB3E17506E235C85B4D979EBC49ABD4F4B3123697E675346B57829C3EFDEED6291A155D69348CD55B8B6B2EEC9F804A1
md5: DEFAADD4A92D4D348B0827AB8159D2FE | sha1: F3BD9B4108ACD42ABFB99A3A4760BFFCB84F6C28 | sha256: 3D2551D6458B84566025FDDFE5DAD479CAB5785428EFD6814860D36AD1811C9A | sha512: 1B13C70F05D56871008D5C8752BC93C8FB590D5F89B4E97264F592CDFD772CBBCCE8380D255F8BB305BC25BCDDEA21E422617FA614DFFD3DDCC9A1D4BE6C54A5
md5: CF318475E6A7A56789ABB0F98C37ABE1 | sha1: 33D1EBD7212D747C8723CFB9E4292C99A641B964 | sha256: 0383DC02FDF0B5D4612D8CAAAD13D594CAC1609C8240B73DFD6EA5803F5E17EA | sha512: 5C67456A65FD051147281E14041F5165C1852FD6519DFC8DFCF9C86F20217CDAD9E2D26F815B557B99E2DB3500AF47B2DF8A1225A659FA1069815CD62302458F
md5: F1CC91D25B52C7504DC5BEAB5D0F498C | sha1: 498F0FBBD2712F4F637BDB7370B2302FCC4966F3 | sha256: E3036362506D96C9C00ED6393A2AFCACD9F2E71CD2A35C1D638A61E85D2FB040 | sha512: 4C931389035DF21AE67810D8C8E95CB613D9495E2392B11E34D84F624F90C78C541B14FB0D6FE7F0F89799AAD4B34E91FB6F73978AE38231840F047915E6EB5B
md5: 9E71DFCE86F14BEEB8F3E9F00D0A472E | sha1: BF83A7E98418BDE907DEAE8C0C0F3FB0F6C9DB1A | sha256: 62DCE4679E33C079E11F41B096BC803B30B1D963A1EA79EFA84187CEBBC06AFE | sha512: FF8CDC0287E510F859F46C1E35F9B0FB42EAD907B1EAA42C90C84B31CF6C2D4638CF682777F359B8611DD22062C1A5FA71F7FB667B7A3903783673E678098515
md5: 05D1B950C470EA8B0AA357F9A59CF264 | sha1: B1756DC750ED5CFD5D0BFC70CB899FD590867A0C | sha256: DAAABD07F1B94BE19D72913360286E469F454886850AFCC603506EAAB03150E4 | sha512: 8E65FF1909AC8D65F599062E61AC935A919D43404C357DBC6AD628923B0C7ED7158862DDD272CFC1C2A8CEC393D48A57BC4D69CE7706EEF1BB6838826B1AFAE3
md5: 9A341540899DCC5630886F2D921BE78F | sha1: BAB44612721C3DC91AC3D9DFCA7C961A3A511508 | sha256: 3CADCB6B8A7335141C7C357A1D77AF1FF49B59B872DF494F5025580191D1C0D5 | sha512: 066984C83DE975DF03EEE1C2B5150C6B9B2E852D9CAF90CFD956E9F0F7BD5A956B96EA961B26F7CD14C089BC8A27F868B225167020C5EB6318F66E58113EFA37
md5: 9F31B6954FD453F13B5F39DA36F2E8EB | sha1: 7A6276348D85EAF00AE6958117797045929078CB | sha256: 18A610B8BAD43CF784CDE4D4902A238F2281C2A677DAAE790CAB55F6DA915979 | sha512: D3696D4D60CFC5AA5834F60A0B97A4F3A3F8EC3FB05BEB3C3D927426B72B3E5463C628C7DF950E43FF1344823B8C2D39730BA47BA0F2FEC7A0CFCDC237A5BCC6
md5: 0E35085C130D2D91E5241334BE7EF0DA | sha1: FD622ADE5CAE26353A22B6FA50A83669B72B6C41 | sha256: 50AD612D4CF6113DE26B2870DA099C4817F59E64A2DA98F05803B4A2E2304919 | sha512: 2498811F4AAC308CDC55C3406BEA4FEF5DC9E6F23559B09FB181F7447474EF586F00038282DDC39C241490B5DC2BCA7F41F19BD3E1BB00890DA29DF6489BB151
md5: B0346A4C5FA0FAC135509A0E7D3C4449 | sha1: 7D71B46BB9A28289384AA1EDF5CB03D64B3BCFF0 | sha256: F9FEB277F86241F55425182A26DECF50A210675D4F040EC542AF3FB3DD287DE6 | sha512: 916A465236F11FF6E421800961B20CB80A320176DA8C58002F6742040CE33C5207D378667A584C5D8E35CF8CFC19AC54504B3F6129E489EEABD86A5B4E7D8C77
md5: 65FBBA7A86B3E175200AE44727AB40E5 | sha1: 584B8683943A8E0AE98B10F452C94F6109D1C4EA | sha256: 7A81D2A001B543B2A55C9AFFC845A5DF7EDAB1FD308C6979BBD982B1B826B57C | sha512: 43607AEBBB0A3F2D437C7DE77785CD6C9F49411E1D4EFE41ECCD93D7FCCA197DABD4E15F45FBC4FBFF27C202FEC96B79F82202AFC88B59C20ED5E7912BCDC6D3
md5: D7E74EA95786A02687CE43C356ABDC95 | sha1: 2E6A3047BD3BCEE01F55D139A3C03E6D4D2DB14A | sha256: 383A1F9DAC655C6805C24D4A03BC5FBEB9ABD1536DE5510F5756259EEFCB4871 | sha512: B7E76B65406904F092FE96DED558A94EA53FA40BEC500EFCDCDEBF124921F4526DE2F239CD25BAE1801692DD6DFE5652FFD46B2AA4325133C7127D27F626BB9B
md5: 05AF54A1C6450B98AD0FB0E857B6A523 | sha1: 15349E541122743A5D355946E48380AC1811B52F | sha256: 76432F414458E93B54CEB02FC348E652A84744108102F3A83792D8A804040EB8 | sha512: C763FE0E16079E431CFA13C63706B58637E3BB6E395F3C874F7EC8B1D5D5C16849D30A088E69E4BA798AFAAF7066763DAFFFF6A2880FB6C8AB838D9D721F000D
md5: 6CCCA0BA6A7B9CAF8B8D3B0287DBED8B | sha1: B81FF87B407578EFBF184BDC10D0F101610379DB | sha256: 16E7EFD6C19B2E3E516AE1BC7B3175D0E22F1AD357701F229E353DA348EEE182 | sha512: 8505479031A0A5CAEEEE1A8A60AA35D7E0C332BBFDDE61193B615E242C127780E55F404289F26930E9EC9E53FCCF436B1A991BA2C8A9177163B41AAAF6BE0D32
md5: A42C32F4E98A9656FC2FED72D30E9380 | sha1: B6B8986FC1B5140817DE262AE4102499E37DAFFD | sha256: C343F7BF08A4C97A90BA607A492C721533333173FA63F65F6E5DE9CEEE65FC16 | sha512: 5C2DE8F18CB9B367D7DE88A2AF8A7FD538486B9FFB393972FBDFF42CD2899D6679FD8D7076FE37954D5E8EAB6C5041F19EDAD32659C5CCEEC1C2BA35E6F8982A
md5: E1E2239979B853157BA75310FEA7E65D | sha1: EE1AE416570911282ABDD3745674E58F9D469C9E | sha256: E8D531F0AAA674F794B7F43EC76E4E32AD93F3C136020CF4B6E3433832F9C0DF | sha512: DDF9D6E05D9566C9E02295A061756FF164C408EA211D016023EDBFA91BBA4D0D7DFF293D2BF4D87C25FE923500C7535E4A21B6A8D4B18FD9505F8E5C635F9C95
md5: 3373A24450373CAF0CBB756E10097FD4 | sha1: 87C352153804FF5BD4F8AEF8851546F3CF22461E | sha256: 575E26A455892F1FD77B730E6928F70B760E76094AFE5BCB677D854DAF869AC5 | sha512: 85E005B5BEB7C14BA34C62C38DA635962D1AA4740F91549B8659910EDD10F0FDE1734064B19567BF5BC63DBBBB62399F6CBE0AA323193DA599232DCE22B14A01
md5: 9087373EEE85190DAF8915E614B1E4BD | sha1: F434AF8CE30EAF5511E28C0230211F0D8ED4A154 | sha256: 557858E44A51A74646AD07A85CBA56AF1DA13AD26AC2F74EE5D8C3E8A171C221 | sha512: F728238FA567457D7977FEA667FCCB56C2EFE718A9A362E294934CC752E506E05C5D20C0BE2A309DE2A984DD60C3AE4EA03054185B96C9B5F5F5DE827AF9CEAF
md5: 99604779C668D9B8EF913854B9A24F9D | sha1: 97B62A3DBE2465B4C995E082AD6FF183F6267F59 | sha256: 8270D1248950EE8AEE5C2AC2E321DF07E65C7A94004AE03C857DEACD231A5542 | sha512: BE6DEE6E7030B400EAC68AC289EC9B74BFE0140EE59AF5E68BF43A63A821C6F6AD9CA03C501896A6C92464BF8116D7996FFE640AB51BD9FA96673D9794AC82CD
md5: E4A1681E09AEC6EFB00FB2A9355A1296 | sha1: 95699D187BF150D319CC64F90064301CAC57F338 | sha256: 967DDDBFE7F1CEB933B5875D65C59CDB835BB063F287A361E8B35DD814A9B14D | sha512: 49299C773A4C7CCC235C54A91FD07A000CF547B3EE55272E2EE8B2AA40281DC0AF3C3B5A9EDF5CAEE4BEB3AD0DE5A0DEA07159ACEBA582911B78A6B85DB793B0
md5: 3516D10C723EF0846A42FBF8C75A31D2 | sha1: 397A1CBAFE9BF32832D47EA7FE72EB535DB8AD5E | sha256: 0DE5CF8FE6F9BE9C85F49CF997BC29B51C7E727E9A7D4D78D7D9795BFB4C778D | sha512: ECA00DD675BC3EDE03769089927A3B02A731FAD8F41F92F8C3875356A7B2514443FC32DCF974AFC71F121AEE20A6BE0AB3F3BC410EA3F3E0B3A510391EBC6080
md5: F554762FC38F81CB22D1DC8AB5CD40D5 | sha1: A67FDACEB10E828805A9E24FE0C59E1D73D19A7C | sha256: 566775F5502C3C1FA70ACADE145293DF5D02C1A9F031820D429605E9B4584B44 | sha512: BD23571BF9D0FE62BBF5FDDCAFF6B8F383CCC728AFBCEEBCAD8404D68C02EA1F55D4A22306BFC86C30172E70C6CF5425F2FF8877AAA8758A51C48CF4303BD2AB
md5: 7AB10B31C5CE290672B319D403751E95 | sha1: ED23E654968B3704A82F613B06BE5829E0CAAD70 | sha256: 1F5C1ABE1B2720680170388569354D8CDA9D558B53AFF7CAF175CE0F7E3733E5 | sha512: 65ED3AFF2424E7560FCC44380DC719BF200D444F9B06AF7F916D52152C330D55A7F4B96D0C1D2B291B07D82805C71DD9850F2F5F612F00ADFCA1CDF117C6B14A
md5: 92553808C45C3999BCDDEA4476394383 | sha1: 276AA66A0B64988B7B009D93EB9648C621F4932A | sha256: 0CDC169B1AA735CC8153E1E7AC27F7F4D8AA1B2727A4C855BE69FB4A4B09342A | sha512: 7339A96E3AD2B76F9C9ADEDFEFB5B39C5D740F406C4E3C11F6C1CB257AE8EA08C801BF69733F86464FFF619E469A6116012653B32CE40A34AC520B5CD572E144
md5: A60084F9988C7907F7092C143C8D3818 | sha1: A69238054BEE26063D32B85B797BC4E0C49F79D4 | sha256: B755D0B55A465D07C9DD3FC11822487D1E649B684AEF91A4CE9B935B416A01B9 | sha512: 6147F18BD9C49727251CBEA7A3168E3B19F34056DE5A9898571ECDEC85D424627A72968072449C81F97F95330BAED7E2ED0F6FDBA7E2F79B59B9352AB11003CF
md5: 06D000552ED6785988AE188FC35D1B86 | sha1: B0A8868D459FE0AF34D16C263CFE0202C414DC53 | sha256: 3C8630ACB43C12A6A317227FF2922056ECD991FE945464FDF7EA81F1293A479F | sha512: F3E5E97AAF3D26EA62C64787198CCE6DF703EA3A4EBB389BEBC84B424C8129A0181142A4FA5D965CA3106758A047D0E1A723F181AD293FD389C4F1B8D290B5A5
md5: 6DCD91B6A029794728F4EDEB2BF2E42D | sha1: 82BA1313448B431893C14D866F46D47B620514A9 | sha256: 02416BC542BE82002B8B81ADBBBCDCC8D098104020D09B571DC674B5BC19A177 | sha512: 2566F369EDEE9313E823AA2667CB95977F0DB57B4B47DA62F44850811F524D0598FDE6F5BB082BB3325789E4B256E970603B4297D3586F1C435498430723A38B
md5: 4523F60270149BAD67F6AE63375D2CDB | sha1: FF6E6BCD83A11D40BF53DABD0480A67AECFDCF50 | sha256: 18032D190D0D599823E59C8DD8B588909BEF8888B8BF304723A138B61F1B911F | sha512: 025E33F6927E634FE187491F40D96B36B2DDAF2ACDE97B340C8705BAE58BDED6C02B8BF9199A1B9D4AC75884C69DC665DC03B34571B1BD178CA1784C5F0D5451
md5: 45C0CD520BAB7A8C549CB9B731BBEFD3 | sha1: 9EB22858CEAECD3DC7F6398B7C607B73CF6CE7E2 | sha256: E1091B3AF6CBC71BBA27CB5AB0C9BC204F1AF128FD3681FE60F6EC4A9D3B5345 | sha512: DC039AA59098345FD51F8EA75BA4AB710371E192624B98382818B667DDB3E2D1E41B8C2D28A5A83B78E0774248BC9D2C648301CFEEC3B9A16FBD457C660712B7
md5: 7F65CCBF58C39F3853BB8DC4137DFD12 | sha1: 3946DFF0B68F0CA01689BD44C348559ADF548258 | sha256: 0AB1F7F87B7C2AFCA57D394E4F4E262C82BA3209CB0A750CD66401FB33F21ECA | sha512: FF7D953EC4B82C10E64FC85D3AFC8A1A58582170EF1752D4688FA1D48EFC490DBA5F0A784E748F7902E96FD885EA868B1A84DE44F48CF071975F3CD3F8E52C6A
md5: D40515A84448B91315F956E6D1A6C64B | sha1: 7FE773332D0461A252E52BE720A7794FCAAC7BFB | sha256: CBE29672CD2B6A0EA97B55F3844FBEDE3E591996F39C3AA1F829F2FA50551FA9 | sha512: 322F82AEB9EB9DA22257AC9FE835BF1C54C1BB268D37F0F97A4CA52BB42F6ACCCA9C8DBDB96D6D695FA69C24F5069978A4B6F1E960EE81D9EA671CCD30A348D3
md5: 7D317D88F9860A18ECF7FB90B33995D3 | sha1: C2E4B19CB9A0B48E899512CD121FFE6657D41072 | sha256: C98A52BD017DF01AEA7B955E6F219537D391A62C2C2B976684DA282F9CD7CACF | sha512: 79ED01C6D1CEA3DBA6B3566E03D05A971745E221BE9330F6800A249D1B239E092D3FF704E7403E7ECD6B7709B24B0CDD7E518F2EE5DA38019E7139D80594173E
md5: 11D674CFC81B7102C0BC6FFE58F6AC5E | sha1: DDDA49572D112944EC9AB62B31959AA93A386618 | sha256: 4DC8D588EC63641C28422D648E8DE5E2C030EB7AFEC2071A99DD3BD9A204557F | sha512: FB7C628B796A321AD9ECBF01D165E24F151C99D7E60A65D0AF52F779AD60A3203F47B247D44FC47044A68790D1EA4EE458A7BC8DF7EBE9D42C2275A9C11BC324
md5: 1A890C488CF2ECD406B804E7E3C5B7F0 | sha1: BF2C1287F0EC04223CD17FE20AB2ECFFF18579E3 | sha256: F17FF442B77A6CFE9C118D2F8FAE1AB6C814A0D4F35C5844996BE84F3FCC8592 | sha512: 4EEC61F9245DFF3D468818D6D6CBB8E12A5172658F1027A9AB0ECE03CC1377499833056A0DD4FF20B83B9FF9E47BB2E7F8DC7B641BC63AD78FF96C54BE01F524
md5: 0AD301EE2B7282B87DCD0D862EFE14DC | sha1: F720109A38846E358BDE7C47D9C946A79D2B6B1C | sha256: 0110616DFE870B8BCF25DF8F6CE38EF5AAC39E728DDAA3420EA199F5A7E80A16 | sha512: C66FC92435C399804D8A8C1C836E5648725DDA8A55D7ACD897AE719CA231D89251A0D9A293A67F079E345709CFDA83DCC693AD41A28D13661A55459F94FE33E0
md5: E1E9D7D46E5CD9525C5927DC98D9ECC7 | sha1: 2242627282F9E07E37B274EA36FAC2D3CD9C9110 | sha256: 4F81FFD0DC7204DB75AFC35EA4291769B07C440592F28894260EEA76626A23C6 | sha512: DA7AB8C0100E7D074F0E680B28D241940733860DFBDC5B8C78428B76E807F27E44D1C5EC95EE80C0B5098E8C5D5DA4D48BCE86800164F9734A05035220C3FF11
md5: 9088029E38B2A393F22AFD9E576CE86E | sha1: 05E65EE95F647F38C717C73A0399870912DD374A | sha256: 3468E0C875DB94A8F45D56AB76BBCC677B942CA51A23649BA3C5AD1B20E391F1 | sha512: 23DCF5819996EE0F0C8FE044D6642A12E98A40309CE1F3F74688CF8E3DD6F6ED230AEC391FE7E511E15FBBBF14BFF09F976E923F22F2D68AD816D8FFAD17F101
md5: FDB3A743B2DAE5924CBA88A5C865128D | sha1: C53132EC95A7211C1BB6DCD5AD21CCB150A7B923 | sha256: 9D4FAEA9892D4ECFABF61986687FC6CB30F5F51A6B62819B9571FF58E04C4DD5 | sha512: CBD8370F3CB84CB9EB8BF3A7392245D6A90CE1A324971EA96170974DA092BDFC3DB2196F66958CA5D5000F13B18AFAB44FF82D50C5B9A625AA1B7A4AF17717DE
md5: 18CE4ECC42FC8D999EF091D812472CF0 | sha1: F874903CEA9F08F1A0887949B47722E6BA81B789 | sha256: 3D9EBC81B1BD3234666C8CE403A5F17A726867C68FFA5DE4EC8EE92599335658 | sha512: 0C027440EF6F6C105B0BF9319F4E0EA421FD310699028AF0A159300145C662E74B4B5D969663E3B52CDA7F9934A6AB93BBAE9BCD1BD39AAAC24FCBA7EC451156
md5: 824053272B268C577E9ADF17ED398142 | sha1: 5EA3F290ECDE1BAB983CEEE2417A688B7ED9B7F5 | sha256: 04B9235F64C9C846F8A767230714895DA87C7AE2CD0105E9D14835AE46F0FED8 | sha512: F475DCD2CC23FDFB017688713170FCAF8FEA05869A680613EA4AD84CB358ED0F2442DB0FF0DCBD739E3CC3DB7128A8F4A568AE8E5AF6A8840319B02630E420B9
md5: C8456355B990C6347AB2F3621E2010BE | sha1: 0B7A9EC0DFF6D958C9C64B5F592993372D31C5E9 | sha256: EFD8155CEC6F3683B701FE94F555D225332D283126BB36B36D9A20EA9D7FC724 | sha512: 7EAA67B9F5E0CD5D1F2ADED212721973CE7FC951D6AF554084B1FF82521F9EE85EAACF8881EF58453CF67935289CC68092A8F845506314BDC1249780B46503D8
md5: 090FF56C4FE2EEFF2E16F03099AD71E1 | sha1: EF317CACC230A58A3B2FCC6CC079CC763AFCC7C5 | sha256: 5F560E1DD529BB2529D7052E04008449F58D0439C2BB43437D7B5D39F84F949F | sha512: FDAC43D0A18D9158DB4438349A7A550557A36E6ED0665EFCB65A046A5BEB5C38181996CBF6D860B8AD01C19E35315BB61AE766CAF06B23985E046484DAB45256
md5: 37E21B63959F243A157534133F85C5AF | sha1: DFAD52A9990B2FAFCE7098CEBB174927E8E0BA00 | sha256: 4F6A14E4BA2A2B26B8B8433D5F82F75A96AF5A4F036D9447373B07271493917B | sha512: F59FAA6319FE2AFEBCCBD643E20C1EDB75DB74E9271354BD86DAC3BEA2CC59452EE024DC26B517AE88254A7C90DBE0E6C19A7B5AB3BFE9159D986D6C53CA5521
md5: 328D12AF9613B0F3F25320B85DCCCBF4 | sha1: 09D02B85A094E925AC3C5D8B1ACA096B730C160F | sha256: 8957F0BCEA6AB8A011A53AE62466505199F11A228F87F3809931D974F87078CE | sha512: 16569ECB727ADA36811E72FFC925F07AA21B8A627BE45F1EDA18CF2B759939591DCAFCB2D087596EE903C5ABFFAF19F56F25E9710EF22874C934CAD19537B798
md5: D9F02D9F7DA653F82E75112A2AB99CE6 | sha1: BBBB4C2C3911AE1F5BA7FAF1D632ED0F14D9B6AC | sha256: 21493F7F615A099E795F7FAE7ECCE6082414D1D427790BDF4B103623A3AB34EB | sha512: DE5546FF103CCC6AA38E254039A372697A193F9C44D0A44F0BE3B242D9EEF63023DC3FD0C6E8E0D2363177F9230A4E7200D4C32591B398269A1CEE9BC47A99FC
md5: 415E3AB72F17F10D646B3E2C7A76F612 | sha1: ED25E94D4E88293345A0F28A5B975159C393B050 | sha256: 24DAA1FAEE0478BA58FEBE8EE789EB88BE0A14D350B57AD8B10690C55976B2E1 | sha512: 55B5C22B87F21DF89D0514AE05C9433B65A3C7532845FDFC4C2C5C5E2C3929D70143D84698FDB4DC13EC01895B1022CF0E5E76E12102739530B54150932A7B07
md5: A5F541655A9EDC24F4B5184A40E40227 | sha1: 90E196DCD76168F770ABE30098399BC5866ADF1B | sha256: B33D08149A756A401628D11BFDDFEEACA1F03C0578395BB061DAE44F8A12CE5D | sha512: C4D13E95114E232300B36ED7B7A72CE786F66D0F68B0ED9D54FEF788A831B39C893DAA3C2DE982B376A56A539C23E8F314CE8552ED7094E6826D5F70BFBE2D4B
VERIFICATION
Verification is intended to assist the Chocolatey moderators and community
in verifying that this package's contents are trustworthy.
This package is published by the Cake Project itself. The binaries are
identical to other package types published by the project, in particular
the Cake nuget package.
md5: 33061C86850EB06D07DC37BD2DBE70ED | sha1: CF79376750E6E31824868967CE2DE438BEE780D0 | sha256: 06E8863F853E4CD924F5451F517A16C2ADBDF0EB0830EF4D05EB67CE76A9CEE5 | sha512: 37B9B5EE27A46C7766D01F7AEDD27D20202EC81B74DC6F07FEA0C0176CC59F1CFB76546B4DCA014CB48B14CB16859A0FA7CD6728A6F46D7C1C594F2773F28001
Log in or click on link to see number of positives.
- Microsoft.Win32.Primitives.dll (5eaa2e82a26b) - ## / 72
- System.AppContext.dll (9dc115ac4aad) - ## / 73
- System.Collections.Concurrent.dll (cc62f3b867d5) - ## / 72
- System.Collections.dll (c2250e9e51b4) - ## / 73
- System.Collections.NonGeneric.dll (529943c0cdf2) - ## / 72
- System.Collections.Specialized.dll (938da38561da) - ## / 71
- System.ComponentModel.dll (5e61d755616c) - ## / 72
- System.ComponentModel.EventBasedAsync.dll (22108e32e0b6) - ## / 71
- System.ComponentModel.Primitives.dll (bfcd867f71c8) - ## / 72
- System.ComponentModel.TypeConverter.dll (0dbb92ecd5df) - ## / 72
- System.Console.dll (b537313413f8) - ## / 73
- System.Diagnostics.Contracts.dll (9c4ae61e0e83) - ## / 73
- System.Diagnostics.Debug.dll (55a30d92d163) - ## / 72
- System.Diagnostics.FileVersionInfo.dll (7c25a74772e1) - ## / 73
- System.Diagnostics.Process.dll (28b165cddb82) - ## / 68
- System.Diagnostics.TextWriterTraceListener.dll (63eab38ee9f4) - ## / 71
- System.Diagnostics.Tools.dll (260c6250ef9b) - ## / 72
- System.Diagnostics.TraceSource.dll (c81a57d0634c) - ## / 72
- System.Drawing.Primitives.dll (2805a18724a2) - ## / 73
- System.Dynamic.Runtime.dll (f600acc81172) - ## / 62
- System.Globalization.Calendars.dll (b56ffb65b842) - ## / 72
- System.Globalization.dll (56bd0c02c734) - ## / 72
- System.IO.Compression.ZipFile.dll (7720ee13405e) - ## / 72
- System.IO.dll (c191a43029ed) - ## / 72
- System.IO.FileSystem.dll (9a4595dbb128) - ## / 73
- System.IO.FileSystem.DriveInfo.dll (984575c44cab) - ## / 72
- System.IO.FileSystem.Primitives.dll (5c84dd40d67c) - ## / 72
- System.IO.FileSystem.Watcher.dll (c9e2562f1a1b) - ## / 73
- System.IO.IsolatedStorage.dll (0e80a2e256d1) - ## / 71
- System.IO.MemoryMappedFiles.dll (81b6527ac2d1) - ## / 73
- System.IO.Pipes.dll (80a229b2917f) - ## / 72
- System.IO.UnmanagedMemoryStream.dll (86f1f12e47f2) - ## / 71
- System.Linq.dll (349c7fbe9ae2) - ## / 73
- System.Linq.Expressions.dll (bf97f6716523) - ## / 72
- System.Linq.Parallel.dll (30a49d16436e) - ## / 72
- System.Linq.Queryable.dll (719ac73bb261) - ## / 73
- System.Net.NameResolution.dll (222bd77c5692) - ## / 73
- System.Net.NetworkInformation.dll (2e2d28a0802d) - ## / 73
- System.Net.Ping.dll (4d97e8481b9a) - ## / 71
- System.Net.Primitives.dll (9a8ba725f8e9) - ## / 73
- System.Net.Requests.dll (f2e74a3ec2dc) - ## / 73
- System.Net.Security.dll (d0d90152136a) - ## / 72
- System.Net.WebHeaderCollection.dll (69b48ff8e6f4) - ## / 73
- System.Net.WebSockets.Client.dll (19766a20b62b) - ## / 72
- System.Net.WebSockets.dll (99920ce34a01) - ## / 73
- System.ObjectModel.dll (870ee1141cb6) - ## / 73
- System.Reflection.dll (63aaf632ee7f) - ## / 73
- System.Reflection.Extensions.dll (3d2551d6458b) - ## / 72
- System.Reflection.Primitives.dll (0383dc02fdf0) - ## / 71
- System.Resources.Reader.dll (e3036362506d) - ## / 72
- System.Resources.ResourceManager.dll (62dce4679e33) - ## / 73
- System.Resources.Writer.dll (daaabd07f1b9) - ## / 70
- System.Runtime.CompilerServices.VisualC.dll (18a610b8bad4) - ## / 72
- System.Runtime.dll (50ad612d4cf6) - ## / 73
- System.Runtime.Extensions.dll (f9feb277f862) - ## / 72
- System.Runtime.Handles.dll (7a81d2a001b5) - ## / 72
- System.Runtime.InteropServices.dll (383a1f9dac65) - ## / 72
- System.Runtime.Numerics.dll (16e7efd6c19b) - ## / 72
- System.Runtime.Serialization.Formatters.dll (c343f7bf08a4) - ## / 73
- System.Runtime.Serialization.Json.dll (e8d531f0aaa6) - ## / 72
- System.Security.Claims.dll (8270d1248950) - ## / 72
- System.Security.Cryptography.Csp.dll (566775f5502c) - ## / 71
- System.Security.Cryptography.Encoding.dll (1f5c1abe1b27) - ## / 73
- System.Security.Cryptography.Primitives.dll (b755d0b55a46) - ## / 71
- System.Security.Cryptography.X509Certificates.dll (3c8630acb43c) - ## / 73
- System.Security.Principal.dll (02416bc542be) - ## / 72
- System.Text.Encoding.dll (0ab1f7f87b7c) - ## / 68
- System.Text.Encoding.Extensions.dll (cbe29672cd2b) - ## / 72
- System.Text.RegularExpressions.dll (c98a52bd017d) - ## / 72
- System.Threading.dll (4dc8d588ec63) - ## / 72
- System.Threading.Tasks.dll (0110616dfe87) - ## / 72
- System.Threading.Tasks.Parallel.dll (3468e0c875db) - ## / 70
- System.Threading.Thread.dll (9d4faea9892d) - ## / 72
- System.Threading.ThreadPool.dll (3d9ebc81b1bd) - ## / 72
- System.Threading.Timer.dll (04b9235f64c9) - ## / 72
- System.Xml.ReaderWriter.dll (5f560e1dd529) - ## / 72
- System.Xml.XDocument.dll (4f6a14e4ba2a) - ## / 72
- System.Xml.XmlDocument.dll (8957f0bcea6a) - ## / 72
- System.Xml.XmlSerializer.dll (21493f7f615a) - ## / 62
- System.Xml.XPath.dll (24daa1faee04) - ## / 55
- netstandard.dll (8be4a2270f8b) - ## / 70
- System.Data.Common.dll (1c7bff6f16bb) - ## / 72
- System.Diagnostics.StackTrace.dll (cae99f910874) - ## / 72
- System.Diagnostics.Tracing.dll (b84b93be455c) - ## / 73
- System.Globalization.Extensions.dll (c7e91bd148ed) - ## / 73
- System.IO.Compression.dll (da18d61bb6b7) - ## / 73
- System.Net.Http.dll (b5d20736f84f) - ## / 73
- System.Net.Sockets.dll (694f4c61b6ba) - ## / 72
- System.Runtime.InteropServices.RuntimeInformation.dll (76432f414458) - ## / 70
- System.Runtime.Serialization.Primitives.dll (575e26a45589) - ## / 73
- System.Runtime.Serialization.Xml.dll (557858e44a51) - ## / 72
- System.Security.Cryptography.Algorithms.dll (967dddbfe7f1) - ## / 75
- System.Security.SecureString.dll (18032d190d0d) - ## / 72
- System.Threading.Overlapped.dll (f17ff442b77a) - ## / 72
- System.ValueTuple.dll (efd8155cec6f) - ## / 72
- System.Xml.XPath.XDocument.dll (b33d08149a75) - ## / 72
- System.Numerics.Vectors.dll (1d3ef8698281) - ## / 73
- System.Text.Encoding.CodePages.dll (e1091b3af6cb) - ## / 68
- System.Buffers.dll (accccfbe45d9) - ## / 73
- System.Memory.dll (8e76318e8b06) - ## / 75
- System.Threading.Tasks.Extensions.dll (4f81ffd0dc72) - ## / 70
- Microsoft.Bcl.AsyncInterfaces.dll (ed5bc605f7f9) - ## / 67
- Microsoft.DotNet.PlatformAbstractions.dll (f0f60c925729) - ## / 70
- System.Diagnostics.DiagnosticSource.dll (7a953c41aebd) - ## / 70
- Wcwidth.dll (06e8863f853e) - ## / 69
- System.Runtime.CompilerServices.Unsafe.dll (3cadcb6b8a73) - ## / 70
- System.Collections.Immutable.dll (646d3b52a489) - ## / 70
- System.Reflection.Metadata.dll (46451e1168dd) - ## / 75
- System.Security.Cryptography.Cng.dll (0de5cf8fe6f9) - ## / 67
- System.Security.Cryptography.Pkcs.dll (0cdc169b1aa7) - ## / 70
- Newtonsoft.Json.dll (b624949df8b0) - ## / 73
- Autofac.dll (429b5e05e811) - ## / 66
- NuGet.Common.dll (745659f7a3df) - ## / 66
- NuGet.Configuration.dll (c9a957b0f0e9) - ## / 65
- NuGet.Frameworks.dll (7d88384b2161) - ## / 62
- NuGet.Packaging.dll (e1e55a6ee287) - ## / 63
- NuGet.Protocol.dll (c3f49cae687f) - ## / 65
- NuGet.Resolver.dll (086b96bda988) - ## / 65
- NuGet.Versioning.dll (babebbd78df4) - ## / 67
- Cake.Cli.dll (52953ea8db0c) - ## / 67
- Cake.Common.dll (3149fd4469b7) - ## / 67
- Cake.Core.dll (930c3a8e204e) - ## / 67
- Cake.DotNetTool.Module.dll (279f3eda8806) - ## / 67
- Cake.exe (2341c276078a) - ## / 68
- Cake.NuGet.dll (a4c9995e66ac) - ## / 67
- cake.portable.1.3.0.nupkg (5d44604fc95f) - ## / 61
- Microsoft.CodeAnalysis.CSharp.dll (817827103ff6) - ## / 67
- Microsoft.CodeAnalysis.CSharp.Scripting.dll (2cb26a9aff2b) - ## / 67
- Microsoft.CodeAnalysis.dll (ac6edb95284a) - ## / 66
- Microsoft.CodeAnalysis.Scripting.dll (4caa0b312785) - ## / 67
- Spectre.Console.dll (d02dfb3d9394) - ## / 65
In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).
Chocolatey Pro provides runtime protection from possible malware.
Add to Builder | Version | Downloads | Last Updated | Status |
---|---|---|---|---|
Cake.Portable 1.3.0 | 3816 | Thursday, October 7, 2021 | Approved | |
Cake.Portable 1.2.0 | 1219 | Sunday, August 29, 2021 | Approved | |
Cake.Portable 1.1.0 | 1010 | Saturday, March 6, 2021 | Approved | |
Cake.Portable 1.0.0 | 261 | Sunday, February 7, 2021 | Approved | |
Cake.Portable 1.0.0-rc0003 | 113 | Friday, January 29, 2021 | Approved | |
Cake.Portable 1.0.0-rc0002 | 127 | Sunday, December 20, 2020 | Approved | |
Cake.Portable 1.0.0-rc0001 | 130 | Thursday, November 5, 2020 | Approved | |
Cake.Portable 0.38.5 | 672 | Sunday, September 20, 2020 | Approved | |
Cake.Portable 0.38.4 | 494 | Friday, June 26, 2020 | Approved | |
Cake.Portable 0.38.3 | 116 | Friday, June 26, 2020 | Approved | |
Cake.Portable 0.38.2 | 286 | Tuesday, June 9, 2020 | Approved | |
Cake.Portable 0.38.1 | 197 | Saturday, May 30, 2020 | Approved | |
Cake.Portable 0.38.0 | 155 | Saturday, May 30, 2020 | Approved | |
Cake.Portable 0.37.0 | 2066 | Saturday, February 1, 2020 | Approved | |
Cake.Portable 0.36.0 | 277 | Saturday, January 11, 2020 | Approved | |
Cake.Portable 0.35.0 | 821 | Saturday, September 28, 2019 | Approved | |
Cake.Portable 0.34.1 | 12381 | Wednesday, July 17, 2019 | Approved | |
Cake.Portable 0.34.0 | 175 | Tuesday, July 16, 2019 | Approved | |
Cake.Portable 0.33.0 | 1055 | Monday, April 1, 2019 | Approved | |
Cake.Portable 0.32.1 | 814 | Friday, January 4, 2019 | Approved | |
Cake.Portable 0.32.0 | 225 | Friday, January 4, 2019 | Approved | |
Cake.Portable 0.31.0 | 379 | Friday, December 14, 2018 | Approved | |
Cake.Portable 0.30.0 | 10380 | Wednesday, August 22, 2018 | Approved | |
Cake.Portable 0.29.0 | 1033 | Friday, July 6, 2018 | Approved | |
Cake.Portable 0.28.1 | 477 | Tuesday, June 19, 2018 | Approved | |
Cake.Portable 0.28.0 | 563 | Thursday, May 31, 2018 | Approved | |
Cake.Portable 0.27.2 | 457 | Tuesday, May 15, 2018 | Approved | |
Cake.Portable 0.27.1 | 553 | Saturday, April 21, 2018 | Approved | |
Cake.Portable 0.27.0 | 299 | Thursday, April 19, 2018 | Approved | |
Cake.Portable 0.26.1 | 852 | Saturday, March 3, 2018 | Approved | |
Cake.Portable 0.26.0 | 337 | Monday, February 26, 2018 | Approved | |
Cake.Portable 0.25.0 | 3462 | Wednesday, January 17, 2018 | Approved | |
Cake.Portable 0.24.0 | 583 | Friday, December 29, 2017 | Approved | |
Cake.Portable 0.23.0 | 1271 | Wednesday, October 11, 2017 | Approved | |
Cake.Portable 0.22.2 | 331 | Friday, November 3, 2017 | Approved | |
Cake.Portable 0.22.1 | 334 | Friday, November 3, 2017 | Approved | |
Cake.Portable 0.22.0 | 300 | Friday, November 3, 2017 | Approved | |
Cake.Portable 0.21.1 | 5228 | Saturday, July 15, 2017 | Approved | |
Cake.Portable 0.21.0 | 332 | Friday, July 14, 2017 | Approved | |
Cake.Portable 0.20.0 | 724 | Monday, June 12, 2017 | Approved | |
Cake.Portable 0.19.5 | 690 | Thursday, May 4, 2017 | Approved | |
Cake.Portable 0.19.4 | 588 | Tuesday, April 18, 2017 | Approved | |
Cake.Portable 0.19.3 | 438 | Tuesday, April 4, 2017 | Approved | |
Cake.Portable 0.19.2 | 330 | Saturday, April 1, 2017 | Approved | |
Cake.Portable 0.19.1 | 417 | Friday, March 24, 2017 | Approved | |
Cake.Portable 0.19.0 | 293 | Thursday, March 23, 2017 | Approved | |
Cake.Portable 0.18.0 | 695 | Tuesday, March 7, 2017 | Approved | |
Cake.Portable 0.17.0 | 1294 | Wednesday, November 9, 2016 | Approved | |
Cake.Portable 0.16.2 | 423 | Tuesday, October 11, 2016 | Approved | |
Cake.Portable 0.16.1 | 414 | Sunday, September 25, 2016 | Approved | |
Cake.Portable 0.16.0 | 383 | Thursday, September 15, 2016 | Approved | |
Cake.Portable 0.15.2 | 422 | Friday, July 29, 2016 | Approved | |
Cake.Portable 0.15.1 | 324 | Thursday, July 28, 2016 | Approved | |
Cake.Portable 0.15.0 | 327 | Tuesday, July 26, 2016 | Approved | |
Cake.Portable 0.14.0 | 430 | Monday, July 11, 2016 | Approved | |
Cake.Portable 0.13.0 | 373 | Tuesday, June 7, 2016 | Approved | |
Cake.Portable 0.12.0 | 330 | Wednesday, May 25, 2016 | Approved | |
Cake.Portable 0.11.0 | 338 | Sunday, May 1, 2016 | Approved | |
Cake.Portable (Install) 0.10.1 | 330 | Thursday, April 7, 2016 | Approved | |
Cake.Portable (Install) 0.10.0 | 299 | Wednesday, March 16, 2016 | Approved | |
Cake.Portable (Install) 0.9.0 | 292 | Tuesday, February 23, 2016 | Approved | |
Cake.Portable (Install) 0.8.0 | 351 | Monday, January 18, 2016 | Approved | |
Cake.Portable (Install) 0.7.0 | 389 | Wednesday, December 23, 2015 | Approved | |
Cake.Portable (Install) 0.6.4 | 275 | Wednesday, December 9, 2015 | Approved | |
Cake.Portable (Install) 0.6.3 | 373 | Monday, December 7, 2015 | Approved | |
Cake.Portable (Install) 0.6.2 | 275 | Thursday, December 3, 2015 | Approved | |
Cake.Portable (Install) 0.6.1 | 283 | Thursday, December 3, 2015 | Approved |
Copyright (c) .NET Foundation and contributors
3469 Add support for .NET 6
3493 .NET CLI Build Binary log filenames aren't quoted correctly
3477 parsing of solution files with absolute paths to projects throws exception
3455 NuGet Resolver native dependencies fails on latest macOS
3352 Cake Frosting Parent DirectoryPath Fails To Combine with Slash
3291 Unable to retrieve target argument with Frosting
2048 DotNetCoreToolSettings.WorkingDirectory is not respected when running DotNetCoreTool
3521 Update Microsoft.NETCore.Platforms to 6.0.0-rc.1.21451.13
3519 Update Spectre.Console to 0.42.0
3503 Add NuGet Sources argument to DotNetCoreTestSettings
3502 Add NuGet Sources argument to DotNetCoreRunSettings
3501 Add NuGet Sources argument to DotNetCorePackSettings
3464 Support MSBuild version 17
3452 Missing option in InspectCodeSettings: --build
and --no-build
flags
3449 Add Version, AssemblyVersion, FileVersion, and AssemblyInformationalVersion properties to DotNetCoreMSBuildSettings
3447 Add ContinuousIntegrationBuild to DotNetCoreMSBuildSettings
3445 Highlight failed tasks on summary when Error handler is defined
3237 Allow setting MSBuildToolVersion using custom string - Part 1
3065 Add DOTNET_ROLL_FORWARD setting to DotNetCoreSettings
2165 DotNetCore Build misses Sources settings
2104 Make possibility to set Process Exit Code
1882 DeleteDirectory throws exception if directory doesn't exist
3515 Add a simple README to the packages to be shown on NuGet.org
3466 Fix two typos in GitReleaseManagerAliases documentation
This package has no dependencies.
Ground Rules:
- This discussion is only about Cake.Portable and the Cake.Portable package. If you have feedback for Chocolatey, please contact the Google Group.
- This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
- The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
- Tell us what you love about the package or Cake.Portable, or tell us what needs improvement.
- Share your experiences with the package, or extra configuration or gotchas that you've found.
- If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.