This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.AzureDevOps.
Summary
Class for writing issues to Azure DevOps pull requests.
- Assembly
- Cake
.AzureDevOps .dll - Namespace
- Cake
.AzureDevOps .Pipelines - Base Types
-
- Object
graph BT
Type-->Base0["Object"]
Type["AzureDevOpsBuild"]
class Type type-node
Syntax
public sealed class AzureDevOpsBuild
Constructors
| Name | Summary |
|---|---|
| AzureDevOpsBuild |
Initializes a new instance of the AzureDevOpsBuild class.
|
Properties
| Name | Value | Summary |
|---|---|---|
| BuildId | int |
Gets the ID of the build.
Returns 0 if no build could be found and
ThrowExceptionIfBuildCouldNotBeFound is set to false.
|
| CollectionUrl | Uri |
Gets the URL for accessing the web portal of the Azure DevOps collection.
|
| FinishTime | Nullable |
Gets the finish time of the build.
Returns
null if no build could be found and
ThrowExceptionIfBuildCouldNotBeFound is set to false.
|
| HasBuildLoaded | bool |
Gets a value indicating whether a build has been successfully loaded.
|
| Parameters | IDictionary |
Gets the parameters passed to the build.
Returns an empty dictionary if no build could be found and
ThrowExceptionIfBuildCouldNotBeFound is set to false.
|
| ProjectId | Guid |
Gets the id of the Azure DevOps project.
Returns
System.Guid.Empty if no build could be found and
ThrowExceptionIfBuildCouldNotBeFound is set to false.
|
| ProjectName | string |
Gets the name of the Azure DevOps project.
Returns empty string if no build could be found and
ThrowExceptionIfBuildCouldNotBeFound is set to false.
|
| RepositoryId | Guid |
Gets the ID of the repository.
Returns
System.Guid.Empty if no build could be found and
ThrowExceptionIfBuildCouldNotBeFound is set to false.
|
| RepositoryName | string |
Gets the name of the Git repository.
Returns
System.String.Empty if no build could be found and
ThrowExceptionIfBuildCouldNotBeFound is set to false.
|
| Result | Nullable |
Gets the result of the build.
Returns 0 if no build could be found and
ThrowExceptionIfBuildCouldNotBeFound is set to false.
|
| Status | Nullable |
Gets the status of the build.
Returns 0 if no build could be found and
ThrowExceptionIfBuildCouldNotBeFound is set to false.
|
Methods
| Name | Value | Summary |
|---|---|---|
| GetArtifacts |
IEnumerable |
Gets the artifacts associated with a build.
|
| GetChanges |
IEnumerable |
Gets the changes associated with a build.
|
| GetTestRuns |
IEnumerable |
Gets the test runs of the build including test results.
|
| GetTestRuns |
IEnumerable |
Gets the test runs of the build including test results.
|
| GetTestRuns |
IEnumerable |
Gets the test runs of the build including test results.
|
| GetTimelineRecords |
IEnumerable |
Gets the timeline entries for a build.
|
| GetWorkItemIds |
IEnumerable |
Gets the work item ids associated with a build.
|
| GetWorkItems |
IEnumerable |
Gets the work items associated with a build.
|
| IsBuildFailing |
bool |
Checks if the build is failing.
|
| LinkArtifact |
Azure |
Create an artifact link, such as a file or folder path or a version control path.
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| To |
string |
Returns the string value or a
Not set> markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|
