Cake.Issues 5.0.0-beta0001

Addin for reading code analyzer or linter issues for the Cake build automation system

The issues addin for Cake allows you to read issue from any code analyzer or linter.

Cake.Issues redefines issue management within the Cake build system by offering a comprehensive, universal, and extensible solution. The unique capabilities of the addins empower development teams to enforce coding standards, generate insightful reports, seamlessly incorporate various linting tools, and streamlining the integration with pull requests. With its modular architecture and extensive set of aliases, Cake.Issues provides a future-proof infrastructure for issue management in Cake builds, fostering a more efficient and adaptable development process.

For more information and extensive documentation see the Cake.Issues website. For general information about the Cake build automation system see the Cake website.

How to use

Integrating Cake.Issues into your Cake build is straightforward. With minimal setup, teams can enjoy the benefits of enhanced code quality management seamlessly integrated into their existing build pipeline.

NOTE: Cake.Issues.Recipe for Cake .NET Tool and Cake.Frosting.Issues.Recipe provide a single NuGet package, which can be used inside your projects build to add fully flavored issue management, including parsing of linter outputs, integration with build systems and pull requests and creation of different reports.

Reading issues

The addin provides the ReadIssues alias to read issues. It needs an additional NuGet package to provide the specific issue provider implementation:

See Issue Providers for a list of available issue providers and detailed documentation.

Creating issues

To create issues directly in the build script the NewIssue alias can be used:

[TaskName("Create-Issue")]
public sealed class CreateIssueTask : FrostingTask<BuildContext>
{
    public override void Run(BuildContext context)
    {
        var issue =
            context
                .NewIssue(
                    "Something went wrong",
                    "MyCakeScript",
                    "My Cake Script")
                .WithMessageInHtmlFormat("Something went <b>wrong</b>")
                .WithMessageInMarkdownFormat("Something went **wrong**")
                .InFile("myfile.txt", 42)
                .WithPriority(IssuePriority.Warning)
                .Create();

        context.Information("Issue created with message: {0}", issues.MessageText);
    }
}

Creating reports

Issue reports can be created using any of the available Report Format addin together with the Cake.Issues.Reporting addin for Cake .NET Tool or Cake.Frosting.Issues.Reporting addin for Cake Frosting.

Reporting issues to pull requests and build systems

Issues can be written as comments to pull requests or reported to build systems using any of the available Pull Request System addin together with the Cake.Issues.PullRequests addin for Cake .NET Tool or Cake.Frosting.Issues.PullRequests addin for Cake Frosting.

Support & Discussion

For questions and to discuss ideas & feature requests, use the GitHub discussions on the Cake GitHub repository, under the Extension Q&A category.

Contributing

Contributions are welcome. See Contribution Guidelines.

License

MIT License - Copyright © Cake Issues contributors

Binary distributions for some addins contain third-party code which is licensed under its own respective license. See LICENSE for details.