Examples

The following example will call DocFx to generate the documentation and report any warnings from the build as comments to the Team Foundation Server pull request.

To call DocFx from a Cake script you can use the Cake.DocFx addin.

#addin "Cake.DocFx"
#addin "Cake.Prca"
#addin "Cake.Prca.Issues.MsBuild"
#addin "Cake.Prca.PullRequests.Tfs"

Task("prca").Does(() =>
{
    // Run DocFx.
    var logPath = @"c:\build\docfx.log";
    DocFxBuild(new DocFxBuildSettings()
    {
        LogPath = logPath
    });

    // Run PRCA.
    var repoRootFolder = new DirectoryPath(@"c:\repo");
    ReportIssuesToPullRequest(
        DocFxIssuesFromFilePath(
            logPath,
            @"c:\repo\docs"),
        TfsPullRequests(
            new Uri("http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository"),
            "refs/heads/feature/myfeature",
            TfsAuthenticationNtlm()),
        repoRootFolder);
});