IIssuesState Interface

Summary

Description of the mutable state of the build run.
Assembly
Cake.Frosting.Issues.Recipe.dll
Namespace
Cake.Frosting.Issues.Recipe
Implementing Types
graph BT Type["IIssuesState"] class Type type-node Implementing0["IssuesState"]-.->Type click Implementing0 "/api/Cake.Frosting.Issues.Recipe/IssuesState"

Syntax

public interface IIssuesState

Properties

Name Value Summary
BuildRootDirectory DirectoryPath
Gets the root directory of the build script.
BuildServer IIssuesBuildServer
Gets the build server under which the build is running. Returns null if running locally or on an unsupported build server.
CommitId string
Gets the SHA ID of the current commit.
FullIssuesReport FilePath
Gets or sets the path to the full issues report.
IssueProvidersAndRuns IList<ValueTuple<IIssueProvider, string>>
Gets the list of issue providers and runs for which issues are read.
Issues IEnumerable<IIssue>
Gets the list of reported issues.
ProjectRootDirectory DirectoryPath
Gets or sets the root directory of the project. Default value is the parent directory of the BuildRootDirectory.
PullRequestSystem IIssuesPullRequestSystem
Gets the pull request system used for the code. Returns null if not running a pull request build or on an unsupported build server.
RepositoryInfo IRepositoryInfoProvider
Gets the provider to read information about the Git repository.
RepositoryRemoteUrl Uri
Gets the remote URL of the repository.
RepositoryRootDirectory DirectoryPath
Gets the root directory of the repository.
SummaryIssuesReport FilePath
Gets or sets the path to the summary issues report.

Methods

Name Value Summary
AddIssue(IIssue) void
Adds an issue to Issues. To read issues from an issue provider use AddIssues(IIssueProvider, IReadIssuesSettings).
AddIssues(IEnumerable<IIssue>) void
Adds a list of issues to Issues. To read issues from an issue provider use AddIssues(IIssueProvider, IReadIssuesSettings).
AddIssues(IIssueProvider, IReadIssuesSettings) IEnumerable<IIssue>
Reads issues from an issue provider and adds the issues to Issues.

Extension Methods

Name Value Summary
NotNull<IIssuesState>(string) void
Throws an exception if the specified parameter's value is null.
GitHub