Interface ICheckPrForBreakingChanges

Namespace

Invex.RepoUtils.Atom.Module.Targets

Assembly

Invex.RepoUtils.Atom.Module.dll

Provides a build target that checks a pull request for breaking changes to the public API surface and reports the result back to GitHub as a check run.

public interface ICheckPrForBreakingChanges : IPrBreakingChangeHelper, IApiSurfaceHelper, ISetupBuildInfo, IBuildInfo, IVariablesHelper, IReportsHelper, IGitHubHelper, IGithubPrHelper, IBuildAccessor

Inherited Members

IPrBreakingChangeHelper.PerformPrBreakingChangeCheck(SemVer, int, IEnumerable<RootedPath>, string, CancellationToken)

IPrBreakingChangeHelper.FindLatestReleaseInfo(SemVer)

IApiSurfaceHelper.IdentifyBreakingChanges(SemVer, string, SemVer, string, params IEnumerable<RootedPath>)

ISetupBuildInfo.SetupBuildInfo

IBuildInfo.BuildName

IBuildInfo.BuildId

IBuildInfo.BuildVersion

IBuildInfo.BuildTimestamp

IBuildInfo.BuildSlice

IVariablesHelper.WriteVariable(string, string, CancellationToken)

IReportsHelper.AddReportData(IReportData)

IGitHubHelper.GitHubToken

IGithubPrHelper.GithubPullRequestNumber

IBuildAccessor.GetService<T>()

IBuildAccessor.GetServices<T>()

IBuildAccessor.GetParam<T>(Expression<Func<T>>, T, Func<string, T>)

IBuildAccessor.Services

IBuildAccessor.Logger

IBuildAccessor.RootedFileSystem

IBuildAccessor.ProcessRunner

Properties

BreakingChangeFilesToCheck

The set of API definition files whose changes should be analyzed for breaking changes. Implementers should override this to point at their public API surface files; defaults to an empty set, which effectively disables the check.

IEnumerable<RootedPath> BreakingChangeFilesToCheck { get; }

Property Value

IEnumerable<RootedPath>

CheckPrForBreakingChanges

Runs the breaking change analysis for the current pull request using the build version produced by Invex.Atom.Build.ISetupBuildInfo and publishes the resulting GitHub check run.

Target CheckPrForBreakingChanges { get; }

Property Value

Target