Downloads:
65,177
Downloads of v 1.3.0:
3,695
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,177
Downloads of v 1.3.0:
3,695
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 18 Sep 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.AssemblyNam