Create annotations in GitHub Actions

This example shows how to report issues as annotations to a GitHub Actions build.

To report issues as annotations to a GitHub Actions build you need to import the core addin, the core pull request addin, the GitHub Actions support and one or more issue providers, in this example for JetBrains InspectCode:

#addin "Cake.Issues"
#addin "Cake.Issues.InspectCode"
#addin "Cake.Issues.PullRequests"
#addin "Cake.Issues.PullRequests.GitHubActions"

Please note that you always should pin addins to a specific version to make sure your builds are deterministic and won't break due to updates to one of the addins.

See pinning addin versions for details.

In the following task we'll first determine the remote repository URL and source branch of the pull request and with this information call the GitHubActionsBuilds alias:

Task("ReportIssuesToGitHubActions").Does(() =>
{
    var repoRootFolder = MakeAbsolute(Directory("./"));

    ReportIssuesToPullRequest(
        InspectCodeIssuesFromFilePath(
            @"C:\build\inspectcode.log"),
        GitHubActionsBuilds(),
        repoRootFolder);
});

The output will show up in the build log grouped by issue provider / run:

Log output

Additionally the issues show up as annotations:

Annotations

Having issues available as annotations also means that they will be shown in pull requests on the related file / position:

Pull request integration

GitHub