AppVeyorRepositoryInfo Class

Summary

Provides AppVeyor repository information for a current build.
Namespace
Cake.Common.Build.AppVeyor.Data
Base Types
graph BT Type-->Base0["AppVeyorInfo"] click Base0 "/api/Cake.Common.Build.AppVeyor/AppVeyorInfo" Base0-->Base1["object"] Type["AppVeyorRepositoryInfo"] class Type type-node

Syntax

public sealed class AppVeyorRepositoryInfo : AppVeyorInfo

Constructors

Name Summary
AppVeyorRepositoryInfo(ICakeEnvironment) Initializes a new instance of the AppVeyorRepositoryInfo class.

Properties

Name Value Summary
Branch string
Gets the build branch. For pull request commits it is base branch PR is merging into.
Commit AppVeyorCommitInfo
Gets the commit information for the build.
Name string
Gets the repository name in format owner-name/repo-name.
Provider string
Gets the repository provider.
  • github
  • bitbucket
  • kiln
  • vso
  • gitlab
Scm string
Gets the revision control system.
  • git
  • mercurial
Tag AppVeyorTagInfo
Gets the tag information for the build.

Methods

Name Value Summary
GetEnvironmentBoolean(string) bool
Gets an environment variable as a bool.
Inherited from AppVeyorInfo
GetEnvironmentInteger(string) int
Gets an environment variable as a int.
Inherited from AppVeyorInfo
GetEnvironmentString(string) string
Gets an environment variable as a string.
Inherited from AppVeyorInfo

Extension Methods

Name Value Summary
Dump<AppVeyorRepositoryInfo>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<AppVeyorRepositoryInfo>(AppVeyorRepositoryInfo[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<AppVeyorRepositoryInfo>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<AppVeyorRepositoryInfo>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<AppVeyorRepositoryInfo>(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
ThrowIfNull<AppVeyorRepositoryInfo>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin