MarkdownlintIssuesAliases.

MarkdownlintIssues(ICakeContext, MarkdownlintIssuesSettings) Method

Summary

Gets an instance of a provider for code analysis issues reported by Markdownlint using specified settings.

Syntax

public static ICodeAnalysisProvider MarkdownlintIssues(this ICakeContext context, MarkdownlintIssuesSettings settings)

Examples

Report code analysis issues reported by Markdownlint to a TFS pull request:

 var repoRoot = new DirectoryPath("c:\repo");
     var settings =
         new MarkdownlintIssuesSettings(
             new FilePath("C:\build\Markdownlint.log"));

     ReportIssuesToPullRequest(
         MarkdownlintIssues(settings),
         TfsPullRequests(
             new Uri("http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository"),
             "refs/heads/feature/myfeature",
             TfsAuthenticationNtlm()),
         repoRoot);

Attributes

Type Description
CakeMethodAliasAttribute
CakeAliasCategoryAttribute

Parameters

Name Type Description
context ICakeContext The context.
settings MarkdownlintIssuesSettings Settings for reading the Markdownlint log.

Return Value

Type Description
ICodeAnalysisProvider Instance of a provider for code analysis issues reported by Markdownlint.
GitHub