Documentation

We gladly accept your contributions. If there is something that you would like to add then you can edit the content directly on GitHub.

Overview

Overview about features and requirements of the Cake Issues Addin.

Introduction Introduction
Features Overview about core features.
Release Notes Release notes for the Cake Issues core addins.
Requirements Requirements for using Cake.Issues.

Fundamentals

Basic concepts of the Cake Issues Addin.

Architecture Architecture overview.
Versioning Compatible versions.
Recipe Pre-made recipe script.
Issue Provider Overview about issue providers.
Report Format Overview about report format implementations.
Pull Request System Overview about pull request system implementations.

Usage

How to obtain, configure, and use Cake.Issues.

Recipe How to use the pre-made recipe script.
Creating Issues How to create issues using Cake.Issues.
Reading Issues How to read issues using Cake.Issues.
Creating Reports How to create reports using Cake.Issues.Reporting.
Reporting Issues To Pull Requests How to report issues to pull requests using Cake.Issues.PullRequests.

Recipe

Using Cake.Issues addins with a pre-made recipe script.

Overview Overview about Cake.Issues recipes.
Usage How to use Cake.Issues recipes in your build script.
Supported tools Tools supported by Cake.Issues recipes.
Demos Demo setups for Cake.Issues recipes.
Configuration Available parameters to configure Cake.Issues recipes.
Tasks Tasks provided by Cake.Issues recipes.
Cake.Issues.Recipe Release Notes Release notes for Cake.Issues.Recipe

Issue Providers

Documentation of the different issue provider addins.

DocFx Issue provider which allows you to read warnings logged by DocFx.
dupFinder Issue provider which allows you to read issues logged by JetBrains dupFinder.
ESLint Issue provider which allows you to read issues logged by ESLint.
Git Repository Issue provider which allows you to analyzing Git repositories and create issues resulting from it.
InspectCode Issue provider which allows you to read issues logged by JetBrains Inspect Code.
markdownlint Issue provider which allows you to read issues logged by markdownlint.
MsBuild Issue provider which allows you to read warnings logged by MsBuild.
Terraform Issue provider which allows you to read issues from Terraform validate command.

Report Formats

Documentation of the different report format addins.

Console Report format to print issues to the console.
Generic Report format to create reports in any text based format (HTML, Markdown, ...).
Sarif Report format to create SARIF compatible reports.

Pull Request Systems

Documentation of the different pull request system implementations.

AppVeyor Support for AppVeyor.
Azure DevOps Support for Azure DevOps.
GitHub Actions Support for GitHub Actions.

Extending

Instructions how to add support for additional analyzers, report formats and pull request system to the Cake Issues Addin.

Fundamentals Fundamentals to extend Cake Issues ecosystem.
Issue Provider Instructions how to add support for additional analyzers to the Cake Issues addin.
Report Format Instructions how to additional report formats to the Cake Issues addin.
Pull Request System Instructions how to add support for additional pull request system to the Cake Issues addin.
Testing Instructions how to write test cases for Cake Issues addins.

Resources

Resources about Cake.Issues.

Blog posts Blog posts about the Cake Issues addins.
Presentations Presentations about the Cake Issues addins.

Contributing

Instructions how to contribute to the Cake Issues Addin.

How to contribute Instructions how to contribute to Cake Issues addins.
How to build addins Instructions how to build individual Cake Issues addins.
How to release addins Instructions how to release individual Cake Issues addins.

Thanks

People who brought you Cake Issues

GitHub