AppVeyorProvider Class

Summary

Responsible for communicating with AppVeyor.
Namespace
Cake.Common.Build.AppVeyor
Interfaces
Base Types
  • object
graph BT Type-->Base0["object"] Type-.->Interface0["IAppVeyorProvider"] click Interface0 "/api/Cake.Common.Build.AppVeyor/IAppVeyorProvider" Type["AppVeyorProvider"] class Type type-node

Syntax

public sealed class AppVeyorProvider : IAppVeyorProvider

Constructors

Name Summary
AppVeyorProvider(ICakeEnvironment, IProcessRunner, ICakeLog) Initializes a new instance of the AppVeyorProvider class.

Properties

Name Value Summary
Environment AppVeyorEnvironmentInfo
Gets the AppVeyor environment.
IsRunningOnAppVeyor bool
Gets a value indicating whether the current build is running on AppVeyor.

Methods

Name Value Summary
AddMessage(string, AppVeyorMessageCategoryType, string) void
Adds a message to the AppVeyor build. Messages can be categorised as: Information, Warning or Error
UpdateBuildVersion(string) void
Updates the build version.
UploadArtifact(FilePath) void
Uploads an AppVeyor artifact.
UploadArtifact(FilePath, Action<AppVeyorUploadArtifactsSettings>) void
Uploads an AppVeyor artifact.
UploadArtifact(FilePath, AppVeyorUploadArtifactsSettings) void
Uploads an AppVeyor artifact.
UploadTestResults(FilePath, AppVeyorTestResultsType) void
Uploads test results XML file to AppVeyor. Results type can be one of the following: mstest, xunit, nunit, nunit3, junit.

Extension Methods

Name Value Summary
AddErrorMessage(string, Exception) void
Adds a warning message to the AppVeyor build log
AddErrorMessage(string, object[]) void
Adds a warning message to the AppVeyor build log
AddInformationalMessage(string, object[]) void
Adds an informational message to the AppVeyor build log
AddWarningMessage(string, object[]) void
Adds a warning message to the AppVeyor build log
Dump<AppVeyorProvider>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<AppVeyorProvider>(AppVeyorProvider[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<AppVeyorProvider>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<AppVeyorProvider>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<AppVeyorProvider>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<AppVeyorProvider>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin