@Html.Raw(Model.String(DocsKeys.Description))
+ ++ Support for analyzing Git repositories is implemented in the Cake.Issues.GitRepository addin. +
+ +@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/issue-providers/gitrepository/requirements.md b/docs/input/docs/issue-providers/gitrepository/requirements.md new file mode 100644 index 000000000..e491db400 --- /dev/null +++ b/docs/input/docs/issue-providers/gitrepository/requirements.md @@ -0,0 +1,9 @@ +--- +Order: 10 +Title: Requirements +Description: Requirements for the Cake.Issues.GitRepository addin. +--- +The requirements for using the [Cake.Issues.GitRepository addin] are listed in the [release notes] for any specific version. + +[Cake.Issues.GitRepository addin]: https://www.nuget.org/packages/Cake.Issues.GitRepository +[release notes]: release-notes diff --git a/docs/input/docs/issue-providers/gitrepository/rules/BinaryFileNotTrackedByLfs.md b/docs/input/docs/issue-providers/gitrepository/rules/BinaryFileNotTrackedByLfs.md new file mode 100644 index 000000000..ccf4197bb --- /dev/null +++ b/docs/input/docs/issue-providers/gitrepository/rules/BinaryFileNotTrackedByLfs.md @@ -0,0 +1,33 @@ +--- +Title: BinaryFileNotTrackedByLfs +Description: A binary file is not tracked by Git LFS. +--- + + + + + +## Cause + +A binary file in the repository is not tracked by [Git Large File System]. + +## Rule description + +By its nature Git repositories cannot handle binary files well and will keep a full copy of that file in the repository every time a change to that file is committed. +Considering that you always clone the full history of a repository, and not only the latest version, using binary files in a repository considerably slow downs the operation. +[Git Large File System] replaces large files with small text pointers inside the Git repository, while storing the file contents on a remote server. + +:::{.alert .alert-info} +The rule assumes that all files, which are not text files are binary files. +This also includes for example empty files. +::: + +## How to fix violations + +Track the file with [Git Large File System]. + +[Git Large File System]: https://git-lfs.github.com/ diff --git a/docs/input/docs/issue-providers/gitrepository/rules/FilePathTooLong.md b/docs/input/docs/issue-providers/gitrepository/rules/FilePathTooLong.md new file mode 100644 index 000000000..e3eb20e67 --- /dev/null +++ b/docs/input/docs/issue-providers/gitrepository/rules/FilePathTooLong.md @@ -0,0 +1,25 @@ +--- +Title: FilePathTooLong +Description: The path of a file is too long. +--- + + + + + +## Cause + +The path of a file in the repository is too long. + +## Rule description + +Some operating systems and applications have a limitation of maximum path length which they can handle. +To guarantee proper building this length should not be exceeded. + +## How to fix violations + +Rename the name of the file or shorten the path name. diff --git a/docs/input/docs/issue-providers/gitrepository/rules/index.cshtml b/docs/input/docs/issue-providers/gitrepository/rules/index.cshtml new file mode 100644 index 000000000..31e0d52d1 --- /dev/null +++ b/docs/input/docs/issue-providers/gitrepository/rules/index.cshtml @@ -0,0 +1,7 @@ +--- +Title: Rules +Description: Rules of the Cake.Issues.GitRepository provider. +--- +@Html.Raw(Model.String(DocsKeys.Description))
+ +@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/issue-providers/terraform/features.md b/docs/input/docs/issue-providers/terraform/features.md new file mode 100644 index 000000000..dbb414f25 --- /dev/null +++ b/docs/input/docs/issue-providers/terraform/features.md @@ -0,0 +1,37 @@ +--- +Order: 20 +Title: Features +Description: Features of the Cake.Issues.Terraform addin. +--- +The [Cake.Issues.Terraform addin] provides the following features: + +# Basic features + +* Reads warnings from [Terraform validate command]. + +# Supported IIssue properties + +| | Property | Remarks | +|--------------------------------------------------------------------|-----------------------------------|----------------------------------| +| | `IIssue.ProviderType` | | +| | `IIssue.ProviderName` | | +| | `IIssue.Run` | Can be set while reading issues | +| | `IIssue.Identifier` | Set to `IIssue.MessageText` | +| | `IIssue.ProjectName` | | +| | `IIssue.ProjectFileRelativePath` | | +| | `IIssue.AffectedFileRelativePath` | | +| | `IIssue.Line` | | +| | `IIssue.EndLine` | | +| | `IIssue.Column` | | +| | `IIssue.EndColumn` | | +| | `IIssue.FileLink` | Can be set while reading issues | +| | `IIssue.MessageText` | | +| | `IIssue.MessageHtml` | | +| | `IIssue.MessageMarkdown` | | +| | `IIssue.Priority` | | +| | `IIssue.PriorityName` | | +| | `IIssue.Rule` | | +| | `IIssue.RuleUrl` | | + +[Terraform validate command]: https://www.terraform.io/docs/cli/commands/validate.html +[Cake.Issues.Terraform addin]: https://cakebuild.net/extensions/cake-issues-terraform/ diff --git a/docs/input/docs/issue-providers/terraform/index.cshtml b/docs/input/docs/issue-providers/terraform/index.cshtml new file mode 100644 index 000000000..184598ebb --- /dev/null +++ b/docs/input/docs/issue-providers/terraform/index.cshtml @@ -0,0 +1,12 @@ +--- +Title: Terraform +Description: Issue provider which allows you to read issues from Terraform validate command. +--- +@Html.Raw(Model.String(DocsKeys.Description))
+ ++ Support for reading issues reported by Terraform validate command + is implemented in the Cake.Issues.Terraform addin. +
+ +@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/issue-providers/terraform/requirements.md b/docs/input/docs/issue-providers/terraform/requirements.md new file mode 100644 index 000000000..4b7a408f3 --- /dev/null +++ b/docs/input/docs/issue-providers/terraform/requirements.md @@ -0,0 +1,9 @@ +--- +Order: 10 +Title: Requirements +Description: Requirements for the Cake.Issues.Terraform addin. +--- +The requirements for using the [Cake.Issues.Terraform addin] are listed in the [release notes] for any specific version. + +[Cake.Issues.Terraform addin]: https://cakebuild.net/extensions/cake-issues-terraform/ +[release notes]: release-notes diff --git a/docs/input/docs/pull-request-systems/appveyor/appveyor-messages.png b/docs/input/docs/pull-request-systems/appveyor/appveyor-messages.png new file mode 100644 index 000000000..1487681a3 Binary files /dev/null and b/docs/input/docs/pull-request-systems/appveyor/appveyor-messages.png differ diff --git a/docs/input/docs/pull-request-systems/appveyor/examples/github-pullrequest-integration.md b/docs/input/docs/pull-request-systems/appveyor/examples/github-pullrequest-integration.md new file mode 100644 index 000000000..2620901b5 --- /dev/null +++ b/docs/input/docs/pull-request-systems/appveyor/examples/github-pullrequest-integration.md @@ -0,0 +1,24 @@ +--- +Order: 20 +Title: GitHub pull request integration +Description: Example how to write AppVeyor message to GitHub pull requests. +--- +This example shows how to write AppVeyor messages created by Cake.Issues to GitHub pull requests. + +Issues reported as messages to AppVeyor builds can be written to a GitHub pull request using [GitHub Pull Request Notification] +in your `appveyor.yml` file. + +The following example will write a comment to the GitHub pull request containing all issues which were posted as message to the +AppVeyor build: + +```yml +notifications: +- provider: GitHubPullRequest + template: "{{#passed}}:white_check_mark:{{/passed}}{{#failed}}:x:{{/failed}} [Build {{&projectName}} {{buildVersion}} {{status}}]({{buildUrl}}) (commit {{commitUrl}} by @{{&commitAuthorUsername}})Build messages:
@Html.Raw(Model.String(DocsKeys.Description))
+ ++ Support for AppVeyor is implemented in the + Cake.Issues.PullRequests.AppVeyor addin. +
+ +@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/pull-request-systems/appveyor/requirements.md b/docs/input/docs/pull-request-systems/appveyor/requirements.md new file mode 100644 index 000000000..446b03b69 --- /dev/null +++ b/docs/input/docs/pull-request-systems/appveyor/requirements.md @@ -0,0 +1,9 @@ +--- +Order: 10 +Title: Requirements +Description: Requirements for the Cake.Issues.PullRequests.AppVeyor addin. +--- +The requirements for using the [Cake.Issues.PullRequests.AppVeyor addin] are listed in the [release notes] for any specific version. + +[Cake.Issues.PullRequests.AppVeyor addin]: https://www.nuget.org/packages/Cake.Issues.PullRequests.AppVeyor +[release notes]: release-notes \ No newline at end of file diff --git a/docs/input/docs/pull-request-systems/azure-devops/cake.issues.pullrequests.azuredevops.png b/docs/input/docs/pull-request-systems/azure-devops/cake.issues.pullrequests.azuredevops.png new file mode 100644 index 000000000..af5eda3c0 Binary files /dev/null and b/docs/input/docs/pull-request-systems/azure-devops/cake.issues.pullrequests.azuredevops.png differ diff --git a/docs/input/docs/pull-request-systems/azure-devops/examples/azure-pipelines.md b/docs/input/docs/pull-request-systems/azure-devops/examples/azure-pipelines.md new file mode 100644 index 000000000..6078ba5ac --- /dev/null +++ b/docs/input/docs/pull-request-systems/azure-devops/examples/azure-pipelines.md @@ -0,0 +1,83 @@ +--- +Order: 30 +Title: Using with Azure Pipelines +Description: Example how to use the Cake.Issues.PullRequests.AzureDevOps addin from an Azure Pipelines build. +--- +This example shows how to write issues as comments to an Azure DevOps pull request from an Azure Pipelines build. + +To write issues as comments to Azure DevOps pull requests you need to import the core addin, +the core pull request addin, the Azure DevOps support including the Cake.AzureDevOps addin, and one or more issue providers, +in this example for JetBrains InspectCode: + +```csharp +#addin "Cake.Issues" +#addin "Cake.Issues.InspectCode" +#addin "Cake.Issues.PullRequests" +#addin "Cake.Issues.PullRequests.AzureDevOps" +#addin "Cake.AzureDevOps" +``` + +:::{.alert .alert-warning} +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](https://cakebuild.net/docs/tutorials/pinning-cake-version#pinning-addin-version) for details. +::: + +In the following task we'll first determine if the build is running on Azure DevOps and for a pull request, +then read the remote repository URL and pull request id from environment variables set by the Azure Pipelines build +and finally call the [AzureDevOpsPullRequests] alias using the OAuth token provided by the Azure Pipeline build. + +:::{.alert .alert-info} +Please note that you'll need to setup your Azure Pipelines build to allow scripts to +access the OAuth token and need to setup proper permissions. + +See [OAuth authentication from Azure Pipelines] for details. +::: + +```csharp +Task("ReportIssuesToPullRequest").Does(() => +{ + var isRunningOnAzureDevOps = + !string.IsNullOrWhiteSpace(context.EnvironmentVariable("TF_BUILD")) && + !string.IsNullOrWhiteSpace(context.EnvironmentVariable("SYSTEM_COLLECTIONURI")) && + ( + new Uri(context.EnvironmentVariable("SYSTEM_COLLECTIONURI")).Host == "dev.azure.com" || + new Uri(context.EnvironmentVariable("SYSTEM_COLLECTIONURI")).Host.EndsWith("visualstudio.com") + ); + + var isPullRequestBuild = + !string.IsNullOrWhiteSpace(context.EnvironmentVariable("SYSTEM_PULLREQUEST_PULLREQUESTID")); + + if (isRunningOnAzureDevOps) + { + var repositoryUrl = new Uri(context.EnvironmentVariable("BUILD_REPOSITORY_URI")); + + if (isPullRequestBuild) + { + var pullRequestIdVariable = context.EnvironmentVariable("SYSTEM_PULLREQUEST_PULLREQUESTID"); + if (!Int32.TryParse(pullRequestIdVariable, out var pullRequestId)) + { + throw new Exception($"Invalid pull request ID: {pullRequestIdVariable}"); + } + else + { + var repoRootFolder = MakeAbsolute(Directory("./")); + + ReportIssuesToPullRequest( + InspectCodeIssuesFromFilePath( + @"C:\build\inspectcode.log"), + AzureDevOpsPullRequests( + repositoryUrl, + pullRequestId, + AzureDevOpsAuthenticationOAuth(EnvironmentVariable("SYSTEM_ACCESSTOKEN"))), + repoRootFolder); + } + } + } +}); +``` + +[AzureDevOpsPullRequests]: ../../../../api/Cake.Issues.PullRequests.AzureDevOps/AzureDevOpsPullRequestSystemAliases/64912B0A +[Allow scripts to access the OAuth token]: https://docs.microsoft.com/en-us/azure/devops/pipelines/build/options#allow-scripts-to-access-the-oauth-token +[OAuth authentication from Azure Pipelines]: ../setup#oauth-authentication-from-azure-pipelines diff --git a/docs/input/docs/pull-request-systems/azure-devops/examples/index.cshtml b/docs/input/docs/pull-request-systems/azure-devops/examples/index.cshtml new file mode 100644 index 000000000..17e2702db --- /dev/null +++ b/docs/input/docs/pull-request-systems/azure-devops/examples/index.cshtml @@ -0,0 +1,12 @@ +--- +Title: Examples +Description: Examples for using the Cake.Issues.PullRequests.AzureDevOps addin. +--- +@Html.Raw(Model.String(DocsKeys.Description))
+ ++ Support for Azure DevOps is implemented in the + Cake.Issues.PullRequests.AzureDevOps addin. +
+ +@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/pull-request-systems/azure-devops/requirements.md b/docs/input/docs/pull-request-systems/azure-devops/requirements.md new file mode 100644 index 000000000..9c245110d --- /dev/null +++ b/docs/input/docs/pull-request-systems/azure-devops/requirements.md @@ -0,0 +1,9 @@ +--- +Order: 10 +Title: Requirements +Description: Requirements for the Cake.Issues.PullRequests.AzureDevOps addin. +--- +The requirements for using the [Cake.Issues.PullRequests.AzureDevOps addin] are listed in the [release notes] for any specific version. + +[Cake.Issues.PullRequests.AzureDevOps addin]: https://www.nuget.org/packages/Cake.Issues.PullRequests.AzureDevOps +[release notes]: release-notes diff --git a/docs/input/docs/pull-request-systems/azure-devops/setup.md b/docs/input/docs/pull-request-systems/azure-devops/setup.md new file mode 100644 index 000000000..ac9f128bb --- /dev/null +++ b/docs/input/docs/pull-request-systems/azure-devops/setup.md @@ -0,0 +1,78 @@ +--- +Order: 30 +Title: Setup +Description: Instructions how to setup the Cake.Issues.PullRequests.AzureDevOps addin. +--- +This page describes the different ways how the [Cake.Issues.PullRequests.AzureDevOps addin] can be setup. + +# NTLM authentication + +:::{.alert .alert-info} +NTLM authentication is only available for on-premise Azure DevOps Server. +::: + +To authenticate with NTLM you can use the [AzureDevOpsAuthenticationNtlm] alias from the [Cake.AzureDevOps addin]. + +The user needs to have `Contribute to pull requests` permission for the specific repository to +allow [Cake.Issues.PullRequests.AzureDevOps addin] to post issues as comments to pull requests. + +# Basic authentication + +:::{.alert .alert-info} +Basic authentication is only available for on-premise Azure DevOps Server. +::: + +To authenticate with basic authentication you can use the [AzureDevOpsAuthenticationBasic] alias from the [Cake.AzureDevOps addin] and +need to [Configure AzureDevOps Server to use Basic Authentication]. + +The user needs to have `Contribute to pull requests` permission for the specific repository to +allow [Cake.Issues.PullRequests.AzureDevOps addin] to post issues as comments to pull requests. + +# Personal access token + +To authenticate with an personal access token you can use the [AzureDevOpsAuthenticationPersonalAccessToken] alias from the [Cake.AzureDevOps addin]. + +If you want to use the [Cake.Issues.PullRequests.AzureDevOps addin] with an personal access token see +[Authenticate access with personal access tokens for Azure DevOps] for instructions how to create +a personal access token. + +The access token needs to have the scope `Code (read and write)` set and the user needs to have `Contribute to pull requests` +permission for the specific repository to allow [Cake.Issues.PullRequests.AzureDevOps addin] to post issues as comments to pull requests. + +# OAuth authentication from Azure Pipelines + +:::{.alert .alert-info} +OAuth authentication is only available for Azure DevOps Service. +::: + +If you want to use the [Cake.Issues.PullRequests.AzureDevOps addin] from an Azure Pipelines you can authenticate using the +OAuth token provided to the build. +For this you need to enable the [Allow scripts to access the OAuth token] option on the build definition. + +To authenticate you can use the [AzureDevOpsAuthenticationOAuth] alias from the [Cake.AzureDevOps addin]. + +The user under which the build runs, named `@Html.Raw(Model.String(DocsKeys.Description))
+ +@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/pull-request-systems/github-actions/examples/write-annotations.md b/docs/input/docs/pull-request-systems/github-actions/examples/write-annotations.md new file mode 100644 index 000000000..719a51917 --- /dev/null +++ b/docs/input/docs/pull-request-systems/github-actions/examples/write-annotations.md @@ -0,0 +1,54 @@ +--- +Order: 10 +Title: Create annotations in GitHub Actions +Description: Example how to write issues as annotations to a GitHub Actions build. +--- +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: + +```csharp +#addin "Cake.Issues" +#addin "Cake.Issues.InspectCode" +#addin "Cake.Issues.PullRequests" +#addin "Cake.Issues.PullRequests.GitHubActions" +``` + +:::{.alert .alert-warning} +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](https://cakebuild.net/docs/tutorials/pinning-cake-version#pinning-addin-version) 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: + +```csharp +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: + + + +Additionally the issues show up as annotations: + + + +Having issues available as annotations also means that they will be shown in pull requests on the related file / position: + + + +[GitHubActionsBuilds]: ../../../../api/Cake.Issues.PullRequests.GitHubActions/GitHubActionsBuildsAliases/ diff --git a/docs/input/docs/pull-request-systems/github-actions/features.md b/docs/input/docs/pull-request-systems/github-actions/features.md new file mode 100644 index 000000000..91dea5e3c --- /dev/null +++ b/docs/input/docs/pull-request-systems/github-actions/features.md @@ -0,0 +1,25 @@ +--- +Order: 20 +Title: Features +Description: Features of the Cake.Issues.PullRequests.GitHubActions addin. +--- +The [Cake.Issues.PullRequests.GitHubActions addin] creates annotations from issues when running on GitHub actions. + + + +# Basic features + +* Reports issues as annotations to GitHub Actions builds. +* Group issues in log output by provider and run information. + +# Supported capabilities + +The [Cake.Issues.PullRequests.GitHubActions addin] doesn't support any additional capabilities. + +| | Capability | Remarks | +|--------------------------------------------------------------------|--------------------------------|--------------------------------| +| | Checking commit ID | | +| | Discussion threads | | +| | Filtering by modified files | | + +[Cake.Issues.PullRequests.GitHubActions addin]: https://www.nuget.org/packages/Cake.Issues.PullRequests.GitHubActions diff --git a/docs/input/docs/pull-request-systems/github-actions/githubactions-annotations.png b/docs/input/docs/pull-request-systems/github-actions/githubactions-annotations.png new file mode 100644 index 000000000..d9c8bb693 Binary files /dev/null and b/docs/input/docs/pull-request-systems/github-actions/githubactions-annotations.png differ diff --git a/docs/input/docs/pull-request-systems/github-actions/githubactions-log-output.png b/docs/input/docs/pull-request-systems/github-actions/githubactions-log-output.png new file mode 100644 index 000000000..779bc0b9b Binary files /dev/null and b/docs/input/docs/pull-request-systems/github-actions/githubactions-log-output.png differ diff --git a/docs/input/docs/pull-request-systems/github-actions/githubactions-pullrequest-integration.png b/docs/input/docs/pull-request-systems/github-actions/githubactions-pullrequest-integration.png new file mode 100644 index 000000000..def6f8cb0 Binary files /dev/null and b/docs/input/docs/pull-request-systems/github-actions/githubactions-pullrequest-integration.png differ diff --git a/docs/input/docs/pull-request-systems/github-actions/index.cshtml b/docs/input/docs/pull-request-systems/github-actions/index.cshtml new file mode 100644 index 000000000..aba361913 --- /dev/null +++ b/docs/input/docs/pull-request-systems/github-actions/index.cshtml @@ -0,0 +1,10 @@ +--- +Title: GitHub Actions +Description: Support for GitHub Actions. +--- ++ Support for GitHub Actions is implemented in the + Cake.Issues.PullRequests.GitHubActions addin. +
+ +@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/pull-request-systems/github-actions/requirements.md b/docs/input/docs/pull-request-systems/github-actions/requirements.md new file mode 100644 index 000000000..e1e66947a --- /dev/null +++ b/docs/input/docs/pull-request-systems/github-actions/requirements.md @@ -0,0 +1,9 @@ +--- +Order: 10 +Title: Requirements +Description: Requirements for the Cake.Issues.PullRequests.GitHubActions addin. +--- +The requirements for using the [Cake.Issues.PullRequests.GitHubActions addin] are listed in the [release notes] for any specific version. + +[Cake.Issues.PullRequests.GitHubActions addin]: https://www.nuget.org/packages/Cake.Issues.PullRequests.GitHubActions +[release notes]: release-notes diff --git a/docs/input/docs/report-formats/console/examples.md b/docs/input/docs/report-formats/console/examples.md new file mode 100644 index 000000000..ea9f76c5d --- /dev/null +++ b/docs/input/docs/report-formats/console/examples.md @@ -0,0 +1,57 @@ +--- +Order: 30 +Title: Examples +Description: Examples for using the Cake.Issues.Reporting.Console addin. +--- +The following example will print issues logged as warnings by MsBuild to the console. + +:::{.alert .alert-warning} +Please note that you always should pin addins and tools to a specific version to make sure your builds are deterministic and +won't break due to updates to one of the packages. + +See [pinning addin versions](https://cakebuild.net/docs/tutorials/pinning-cake-version#pinning-addin-version) for details. +::: + +```csharp +#tool "nuget:?package=MSBuild.Extension.Pack" +#addin "Cake.Issues" +#addin "Cake.Issues.MsBuild" +#addin "Cake.Issues.Reporting" +#addin "Cake.Issues.Reporting.Console" + +Task("Create-IssueReport").Does(() => +{ + var repoRootFolder = new DirectoryPath(@"c:\repo"); + + // Build MySolution.sln solution in the repository root folder and log issues + // using XmlFileLogger from MSBuild Extension Pack. + FilePath msBuildLogFile = @"c:\build\msbuild.log"; + var settings = new MsBuildSettings() + .WithLogger( + Context.Tools.Resolve("MSBuild.ExtensionPack.Loggers.dll").FullPath, + "XmlFileLogger", + string.Format( + "logfile=\"{0}\";verbosity=Detailed;encoding=UTF-8", + msBuildLogFile) + ); + MSBuild(repoRootFolder.CombineWithFilePath("MySolution.sln"), settings); + + // Write issues to console. + CreateIssueReport( + new List@Html.Raw(Model.String(DocsKeys.Description))
+ ++ Support for printing issues to the console is implemented in the + Cake.Issues.Reporting.Console addin. +
+ +@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/report-formats/console/requirements.md b/docs/input/docs/report-formats/console/requirements.md new file mode 100644 index 000000000..469d4c60c --- /dev/null +++ b/docs/input/docs/report-formats/console/requirements.md @@ -0,0 +1,9 @@ +--- +Order: 10 +Title: Requirements +Description: Requirements for the Cake.Issues.Reporting.Console addin. +--- +The requirements for using the [Cake.Issues.Reporting.Console addin] are listed in the [release notes] for any specific version. + +[Cake.Issues.Reporting.Console addin]: https://www.nuget.org/packages/Cake.Issues.Reporting.Console +[release notes]: release-notes \ No newline at end of file diff --git a/docs/input/docs/report-formats/generic/examples/custom-template.md b/docs/input/docs/report-formats/generic/examples/custom-template.md new file mode 100644 index 000000000..8f3bbf242 --- /dev/null +++ b/docs/input/docs/report-formats/generic/examples/custom-template.md @@ -0,0 +1,116 @@ +--- +Order: 20 +Title: Custom template +Description: Example how to create a report using a custom template +--- +:::{.alert .alert-info} +If you create a universally usable custom template we're happy to package it with the addin. +To have it included in the addin please [create a pull request] with your contribution. +::: + +The following example will create a HTML report for issues logged as warnings by MsBuild using a custom template. + +:::{.alert .alert-warning} +Please note that you always should pin addins and tools to a specific version to make sure your builds are deterministic and +won't break due to updates to one of the packages. + +See [pinning addin versions](https://cakebuild.net/docs/tutorials/pinning-cake-version#pinning-addin-version) for details. +::: + +```csharp +#tool "nuget:?package=MSBuild.Extension.Pack" +#addin "Cake.Issues" +#addin "Cake.Issues.MsBuild" +#addin "Cake.Issues.Reporting" +#addin "Cake.Issues.Reporting.Generic" + +Task("Create-IssueReport").Does(() => +{ + var repoRootFolder = new DirectoryPath(@"c:\repo"); + + // Build MySolution.sln solution in the repository root folder and log issues + // using XmlFileLogger from MSBuild Extension Pack. + FilePath msBuildLogFile = @"c:\build\msbuild.log"; + var settings = new MsBuildSettings() + .WithLogger( + Context.Tools.Resolve("MSBuild.ExtensionPack.Loggers.dll").FullPath, + "XmlFileLogger", + string.Format( + "logfile=\"{0}\";verbosity=Detailed;encoding=UTF-8", + msBuildLogFile) + ); + MSBuild(repoRootFolder.CombineWithFilePath("MySolution.sln"), settings); + + // Create HTML report using Diagnostic template. + CreateIssueReport( + new List| AffectedFileRelativePath | +Line | +Message | +Priority | +Rule | +RuleUrl | +ProviderType | +
|---|---|---|---|---|---|---|
| @issue.AffectedFileRelativePath | +@issue.Line | +@issue.MessageText | +@issue.Priority | +@issue.RuleId | +@issue.RuleUrl | +@issue.ProviderType | +
@Html.Raw(Model.String(DocsKeys.Description))
+ +@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/report-formats/generic/features.md b/docs/input/docs/report-formats/generic/features.md new file mode 100644 index 000000000..247752c6e --- /dev/null +++ b/docs/input/docs/report-formats/generic/features.md @@ -0,0 +1,20 @@ +--- +Order: 20 +Title: Features +Description: Features of the Cake.Issues.Reporting.Generic addin. +--- +The [Cake.Issues.Reporting.Generic addin] provides the following features: + +* Creates reports in any text based format like HTML or Markdown. +* Provides out of the box templates +* Possibility to use custom templates using Razor +* File linking support for different hosting providers (e.g. [GitHub], [Azure DevOps]) + +:::{.alert .alert-info} +See [Template Gallery] for a list of available out of the box and 3rd party templates. +::: + +[Cake.Issues.Reporting.Generic addin]: https://www.nuget.org/packages/Cake.Issues.Reporting.Generic +[Template Gallery]: templates/ +[GitHub]: ../../../api/Cake.Issues.Reporting.Generic/GenericIssueReportFormatAliases/025FE825 +[Azure DevOps]: ../../../api/Cake.Issues.Reporting.Generic/GenericIssueReportFormatAliases/61E51241 diff --git a/docs/input/docs/report-formats/generic/index.cshtml b/docs/input/docs/report-formats/generic/index.cshtml new file mode 100644 index 000000000..801250351 --- /dev/null +++ b/docs/input/docs/report-formats/generic/index.cshtml @@ -0,0 +1,12 @@ +--- +Title: Generic +Description: Report format to create reports in any text based format (HTML, Markdown, ...). +--- +@Html.Raw(Model.String(DocsKeys.Description))
+ ++ Support for creating reports in any text based format like HTML or Markdown is implemented in the + Cake.Issues.Reporting.Generic addin. +
+ +@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/report-formats/generic/requirements.md b/docs/input/docs/report-formats/generic/requirements.md new file mode 100644 index 000000000..e5c917073 --- /dev/null +++ b/docs/input/docs/report-formats/generic/requirements.md @@ -0,0 +1,9 @@ +--- +Order: 10 +Title: Requirements +Description: Requirements for the Cake.Issues.Reporting.Generic addin. +--- +The requirements for using the [Cake.Issues.Reporting.Generic addin] are listed in the [release notes] for any specific version. + +[Cake.Issues.Reporting.Generic addin]: https://www.nuget.org/packages/Cake.Issues.Reporting.Generic +[release notes]: release-notes \ No newline at end of file diff --git a/docs/input/docs/report-formats/generic/templates/.artifactignore b/docs/input/docs/report-formats/generic/templates/.artifactignore new file mode 100644 index 000000000..3c8fd7f2d --- /dev/null +++ b/docs/input/docs/report-formats/generic/templates/.artifactignore @@ -0,0 +1,2 @@ +**/* +!*.html \ No newline at end of file diff --git a/docs/input/docs/report-formats/generic/templates/htmldatatable-demo-default.html b/docs/input/docs/report-formats/generic/templates/htmldatatable-demo-default.html new file mode 100644 index 000000000..0990eedaf --- /dev/null +++ b/docs/input/docs/report-formats/generic/templates/htmldatatable-demo-default.html @@ -0,0 +1,495 @@ + + + + + + + +| Severity | +Project | +Directory | +File | +Location | +Rule | +Message | +
|---|---|---|---|---|---|---|
| Warning | +ClassLibrary1 | +src/ClassLibrary1 | +CSC | ++ | + CA9998 + | +FxCopAnalyzers package has been deprecated in favor of 'Microsoft.CodeAnalysis.NetAnalyzers', that ships with the .NET SDK. Please refer to https://docs.microsoft.com/visualstudio/code-quality/migrate-from-fxcop-analyzers-to-net-analyzers to migrate to .NET analyzers. | +
| Warning | +ClassLibrary1 | +src/ClassLibrary1 | +CSC | ++ | + CA9998 + | +FxCopAnalyzers package has been deprecated in favor of 'Microsoft.CodeAnalysis.NetAnalyzers', that ships with the .NET SDK. Please refer to https://docs.microsoft.com/visualstudio/code-quality/migrate-from-fxcop-analyzers-to-net-analyzers to migrate to .NET analyzers. | +
| Warning | +ClassLibrary1 | +src/ClassLibrary1 | +Class1.cs | +1:1 | ++ SA1633 + | +The file header is missing or not located at the top of the file. | +
| Warning | +ClassLibrary1 | +src/ClassLibrary1 | +CSC | ++ | + CA9998 + | +FxCopAnalyzers package has been deprecated in favor of 'Microsoft.CodeAnalysis.NetAnalyzers', that ships with the .NET SDK. Please refer to https://docs.microsoft.com/visualstudio/code-quality/migrate-from-fxcop-analyzers-to-net-analyzers to migrate to .NET analyzers. | +
| Warning | +ClassLibrary1 | +src/ClassLibrary1 | +Class1.cs | +1:1 | ++ SA1200 + | +Using directive should appear within a namespace declaration | +
| Warning | +ClassLibrary1 | +src/ClassLibrary1 | +Class1.cs | +2:1 | ++ SA1200 + | +Using directive should appear within a namespace declaration | +
| Warning | +ClassLibrary1 | +src/ClassLibrary1 | +Class1.cs | +3:1 | ++ SA1200 + | +Using directive should appear within a namespace declaration | +
| Warning | +ClassLibrary1 | +src/ClassLibrary1 | +Class1.cs | +4:1 | ++ SA1200 + | +Using directive should appear within a namespace declaration | +
| Warning | +ClassLibrary1 | +src/ClassLibrary1 | +Class1.cs | +5:1 | ++ SA1200 + | +Using directive should appear within a namespace declaration | +
| Warning | +ClassLibrary1 | +src/ClassLibrary1 | +Class1.cs | +11:21 | ++ CA1822 + | +Member 'Foo' does not access instance data and can be marked as static | +
| Warning | +ClassLibrary1 | +src/ClassLibrary1 | +Class1.cs | +21:21 | ++ CA1822 + | +Member 'Bar' does not access instance data and can be marked as static | +
| Warning | +ClassLibrary1 | +src/ClassLibrary1 | +CSC | ++ | + SA0001 + | +XML comment analysis is disabled due to project configuration | +
| Severity | +Project | +Directory | +File | +Location | +Rule | +Message | +
|---|---|---|---|---|---|---|
| Warning | ++ | src/ClassLibrary1 | +Class1.cs | +12-19 | ++dupFinder | +Possible duplicate detected (cost 76). The following fragments were found that might be duplicates: "src\ClassLibrary1\Class1.cs" (Line 22 to 29) | +
| Warning | ++ | src/ClassLibrary1 | +Class1.cs | +22-29 | ++dupFinder | +Possible duplicate detected (cost 76). The following fragments were found that might be duplicates: "src\ClassLibrary1\Class1.cs" (Line 12 to 19) | +
| Severity | +Project | +Directory | +File | +Location | +Rule | +Message | +
|---|---|---|---|---|---|---|
| Warning | +ClassLibrary1 | +src/ClassLibrary1 | +Class1.cs | +1 | ++ RedundantUsingDirective + | +Using directive is not required by the code and can be safely removed | +
| Warning | +ClassLibrary1 | +src/ClassLibrary1 | +Class1.cs | +2 | ++ RedundantUsingDirective + | +Using directive is not required by the code and can be safely removed | +
| Warning | +ClassLibrary1 | +src/ClassLibrary1 | +Class1.cs | +3 | ++ RedundantUsingDirective + | +Using directive is not required by the code and can be safely removed | +
| Warning | +ClassLibrary1 | +src/ClassLibrary1 | +Class1.cs | +4 | ++ RedundantUsingDirective + | +Using directive is not required by the code and can be safely removed | +
| Warning | +ClassLibrary1 | +src/ClassLibrary1 | +Class1.cs | +5 | ++ RedundantUsingDirective + | +Using directive is not required by the code and can be safely removed | +
| Warning | +ClassLibrary1 | +src/ClassLibrary1 | +Class1.cs | +17 | ++ UnusedVariable + | +Local variable 'foobar' is never used | +
| Warning | +ClassLibrary1 | +src/ClassLibrary1 | +Class1.cs | +27 | ++ UnusedVariable + | +Local variable 'foobar' is never used | +
| Suggestion | +ClassLibrary1 | +src/ClassLibrary1 | +Class1.cs | +9 | ++ UnusedType.Global + | +Class 'Class1' is never used | +
| Suggestion | +ClassLibrary1 | +src/ClassLibrary1 | +Class1.cs | +11 | ++ UnusedMember.Global + | +Method 'Foo' is never used | +
| Suggestion | +ClassLibrary1 | +src/ClassLibrary1 | +Class1.cs | +21 | ++ UnusedMember.Global + | +Method 'Bar' is never used | +
| Severity | +Project | +Directory | +File | +Location | +Rule | +Message | +
|---|---|---|---|---|---|---|
| Warning | ++ | docs | +index.md | +1 | ++ MD022 + | +Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "# foo"] | +
| Warning | ++ | docs | +index.md | +2:811 | ++ MD009 + | +Trailing spaces [Expected: 0 or 2; Actual: 1] | +
| Warning | ++ | docs | +index.md | +2:101 | ++ MD013 + | +Line length [Expected: 100; Actual: 811] | +
| Warning | ++ | docs | +index.md | +4 | ++ MD022 + | +Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "# bar"] | +
| Warning | ++ | docs | +index.md | +4 | ++ MD025 + | +Multiple top-level headings in the same document [Context: "# bar"] | +
| Warning | ++ | docs | +index.md | +5 | ++ MD031 + | +Fenced code blocks should be surrounded by blank lines [Context: "```"] | +
| Warning | ++ | docs | +index.md | +5 | ++ MD040 + | +Fenced code blocks should have a language specified [Context: "```"] | +
| Warning | ++ | docs | +index.md | +7:3 | ++ MD047 + | +Files should end with a single newline character | +
| Severity | +Project | +Directory | +File | +Location | +Rule | +Message | +
|---|---|---|---|---|---|---|
| Warning | ++ | + | myfile.txt | +42 | ++ | +Something went wrong | +
| ProjectFileRelativePath | +ProjectName | +AffectedFileRelativePath | +Line | +EndLine | +Column | +EndColumn | +MessageText | +MessageHtml | +MessageMarkdown | +Priority | +PriorityName | +RuleId | +RuleName | +RuleUrl | +Run | +ProviderType | +ProviderName | +
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| src/ClassLibrary1/ClassLibrary1.csproj | +ClassLibrary1 | +src/ClassLibrary1/CSC | ++ | + | + | + | FxCopAnalyzers package has been deprecated in favor of 'Microsoft.CodeAnalysis.NetAnalyzers', that ships with the .NET SDK. Please refer to https://docs.microsoft.com/visualstudio/code-quality/migrate-from-fxcop-analyzers-to-net-analyzers to migrate to .NET analyzers. | ++ | + | 300 | +Warning | +CA9998 | ++ | https://www.google.com/search?q="CA9998:"+site:learn.microsoft.com | ++ | Cake.Issues.MsBuild.MsBuildIssuesProvider | +MSBuild | +
| src/ClassLibrary1/ClassLibrary1.csproj | +ClassLibrary1 | +src/ClassLibrary1/CSC | ++ | + | + | + | FxCopAnalyzers package has been deprecated in favor of 'Microsoft.CodeAnalysis.NetAnalyzers', that ships with the .NET SDK. Please refer to https://docs.microsoft.com/visualstudio/code-quality/migrate-from-fxcop-analyzers-to-net-analyzers to migrate to .NET analyzers. | ++ | + | 300 | +Warning | +CA9998 | ++ | https://www.google.com/search?q="CA9998:"+site:learn.microsoft.com | ++ | Cake.Issues.MsBuild.MsBuildIssuesProvider | +MSBuild | +
| src/ClassLibrary1/ClassLibrary1.csproj | +ClassLibrary1 | +src/ClassLibrary1/Class1.cs | +1 | ++ | 1 | ++ | The file header is missing or not located at the top of the file. | ++ | + | 300 | +Warning | +SA1633 | ++ | https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1633.md | ++ | Cake.Issues.MsBuild.MsBuildIssuesProvider | +MSBuild | +
| src/ClassLibrary1/ClassLibrary1.csproj | +ClassLibrary1 | +src/ClassLibrary1/CSC | ++ | + | + | + | FxCopAnalyzers package has been deprecated in favor of 'Microsoft.CodeAnalysis.NetAnalyzers', that ships with the .NET SDK. Please refer to https://docs.microsoft.com/visualstudio/code-quality/migrate-from-fxcop-analyzers-to-net-analyzers to migrate to .NET analyzers. | ++ | + | 300 | +Warning | +CA9998 | ++ | https://www.google.com/search?q="CA9998:"+site:learn.microsoft.com | ++ | Cake.Issues.MsBuild.MsBuildIssuesProvider | +MSBuild | +
| src/ClassLibrary1/ClassLibrary1.csproj | +ClassLibrary1 | +src/ClassLibrary1/Class1.cs | +1 | ++ | 1 | ++ | Using directive should appear within a namespace declaration | ++ | + | 300 | +Warning | +SA1200 | ++ | https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1200.md | ++ | Cake.Issues.MsBuild.MsBuildIssuesProvider | +MSBuild | +
| src/ClassLibrary1/ClassLibrary1.csproj | +ClassLibrary1 | +src/ClassLibrary1/Class1.cs | +2 | ++ | 1 | ++ | Using directive should appear within a namespace declaration | ++ | + | 300 | +Warning | +SA1200 | ++ | https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1200.md | ++ | Cake.Issues.MsBuild.MsBuildIssuesProvider | +MSBuild | +
| src/ClassLibrary1/ClassLibrary1.csproj | +ClassLibrary1 | +src/ClassLibrary1/Class1.cs | +3 | ++ | 1 | ++ | Using directive should appear within a namespace declaration | ++ | + | 300 | +Warning | +SA1200 | ++ | https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1200.md | ++ | Cake.Issues.MsBuild.MsBuildIssuesProvider | +MSBuild | +
| src/ClassLibrary1/ClassLibrary1.csproj | +ClassLibrary1 | +src/ClassLibrary1/Class1.cs | +4 | ++ | 1 | ++ | Using directive should appear within a namespace declaration | ++ | + | 300 | +Warning | +SA1200 | ++ | https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1200.md | ++ | Cake.Issues.MsBuild.MsBuildIssuesProvider | +MSBuild | +
| src/ClassLibrary1/ClassLibrary1.csproj | +ClassLibrary1 | +src/ClassLibrary1/Class1.cs | +5 | ++ | 1 | ++ | Using directive should appear within a namespace declaration | ++ | + | 300 | +Warning | +SA1200 | ++ | https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1200.md | ++ | Cake.Issues.MsBuild.MsBuildIssuesProvider | +MSBuild | +
| src/ClassLibrary1/ClassLibrary1.csproj | +ClassLibrary1 | +src/ClassLibrary1/Class1.cs | +11 | ++ | 21 | ++ | Member 'Foo' does not access instance data and can be marked as static | ++ | + | 300 | +Warning | +CA1822 | ++ | https://www.google.com/search?q="CA1822:"+site:learn.microsoft.com | ++ | Cake.Issues.MsBuild.MsBuildIssuesProvider | +MSBuild | +
| src/ClassLibrary1/ClassLibrary1.csproj | +ClassLibrary1 | +src/ClassLibrary1/Class1.cs | +21 | ++ | 21 | ++ | Member 'Bar' does not access instance data and can be marked as static | ++ | + | 300 | +Warning | +CA1822 | ++ | https://www.google.com/search?q="CA1822:"+site:learn.microsoft.com | ++ | Cake.Issues.MsBuild.MsBuildIssuesProvider | +MSBuild | +
| src/ClassLibrary1/ClassLibrary1.csproj | +ClassLibrary1 | +src/ClassLibrary1/CSC | ++ | + | + | + | XML comment analysis is disabled due to project configuration | ++ | + | 300 | +Warning | +SA0001 | ++ | https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA0001.md | ++ | Cake.Issues.MsBuild.MsBuildIssuesProvider | +MSBuild | +
| + | + | src/ClassLibrary1/Class1.cs | +12 | +19 | ++ | + | Possible duplicate detected (cost 76). The following fragments were found that might be duplicates: "src\ClassLibrary1\Class1.cs" (Line 22 to 29) | +Possible duplicate detected (cost 76).<br/>The following fragments were found that might be duplicates:<br/><a href='https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/src/ClassLibrary1/Class1.cs#L22-L29'>src\ClassLibrary1\Class1.cs</a> (Line 22 to 29) | +Possible duplicate detected (cost 76). The following fragments were found that might be duplicates: [src\ClassLibrary1\Class1.cs](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/src/ClassLibrary1/Class1.cs#L22-L29) (Line 22 to 29) | +300 | +Warning | +dupFinder | ++ | + | + | Cake.Issues.DupFinder.DupFinderIssuesProvider | +DupFinder | +
| + | + | src/ClassLibrary1/Class1.cs | +22 | +29 | ++ | + | Possible duplicate detected (cost 76). The following fragments were found that might be duplicates: "src\ClassLibrary1\Class1.cs" (Line 12 to 19) | +Possible duplicate detected (cost 76).<br/>The following fragments were found that might be duplicates:<br/><a href='https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/src/ClassLibrary1/Class1.cs#L12-L19'>src\ClassLibrary1\Class1.cs</a> (Line 12 to 19) | +Possible duplicate detected (cost 76). The following fragments were found that might be duplicates: [src\ClassLibrary1\Class1.cs](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/src/ClassLibrary1/Class1.cs#L12-L19) (Line 12 to 19) | +300 | +Warning | +dupFinder | ++ | + | + | Cake.Issues.DupFinder.DupFinderIssuesProvider | +DupFinder | +
| + | ClassLibrary1 | +src/ClassLibrary1/Class1.cs | +1 | ++ | + | + | Using directive is not required by the code and can be safely removed | ++ | + | 300 | +Warning | +RedundantUsingDirective | +Redundant using directive | +https://www.jetbrains.com/resharperplatform/help?Keyword=RedundantUsingDirective | ++ | Cake.Issues.InspectCode.InspectCodeIssuesProvider | +InspectCode | +
| + | ClassLibrary1 | +src/ClassLibrary1/Class1.cs | +2 | ++ | + | + | Using directive is not required by the code and can be safely removed | ++ | + | 300 | +Warning | +RedundantUsingDirective | +Redundant using directive | +https://www.jetbrains.com/resharperplatform/help?Keyword=RedundantUsingDirective | ++ | Cake.Issues.InspectCode.InspectCodeIssuesProvider | +InspectCode | +
| + | ClassLibrary1 | +src/ClassLibrary1/Class1.cs | +3 | ++ | + | + | Using directive is not required by the code and can be safely removed | ++ | + | 300 | +Warning | +RedundantUsingDirective | +Redundant using directive | +https://www.jetbrains.com/resharperplatform/help?Keyword=RedundantUsingDirective | ++ | Cake.Issues.InspectCode.InspectCodeIssuesProvider | +InspectCode | +
| + | ClassLibrary1 | +src/ClassLibrary1/Class1.cs | +4 | ++ | + | + | Using directive is not required by the code and can be safely removed | ++ | + | 300 | +Warning | +RedundantUsingDirective | +Redundant using directive | +https://www.jetbrains.com/resharperplatform/help?Keyword=RedundantUsingDirective | ++ | Cake.Issues.InspectCode.InspectCodeIssuesProvider | +InspectCode | +
| + | ClassLibrary1 | +src/ClassLibrary1/Class1.cs | +5 | ++ | + | + | Using directive is not required by the code and can be safely removed | ++ | + | 300 | +Warning | +RedundantUsingDirective | +Redundant using directive | +https://www.jetbrains.com/resharperplatform/help?Keyword=RedundantUsingDirective | ++ | Cake.Issues.InspectCode.InspectCodeIssuesProvider | +InspectCode | +
| + | ClassLibrary1 | +src/ClassLibrary1/Class1.cs | +9 | ++ | + | + | Class 'Class1' is never used | ++ | + | 200 | +Suggestion | +UnusedType.Global | +Type is never used: Non-private accessibility | +https://www.jetbrains.com/resharperplatform/help?Keyword=UnusedType.Global | ++ | Cake.Issues.InspectCode.InspectCodeIssuesProvider | +InspectCode | +
| + | ClassLibrary1 | +src/ClassLibrary1/Class1.cs | +11 | ++ | + | + | Method 'Foo' is never used | ++ | + | 200 | +Suggestion | +UnusedMember.Global | +Type member is never used: Non-private accessibility | +https://www.jetbrains.com/resharperplatform/help?Keyword=UnusedMember.Global | ++ | Cake.Issues.InspectCode.InspectCodeIssuesProvider | +InspectCode | +
| + | ClassLibrary1 | +src/ClassLibrary1/Class1.cs | +17 | ++ | + | + | Local variable 'foobar' is never used | ++ | + | 300 | +Warning | +UnusedVariable | +Unused local variable | +https://www.jetbrains.com/resharperplatform/help?Keyword=UnusedVariable | ++ | Cake.Issues.InspectCode.InspectCodeIssuesProvider | +InspectCode | +
| + | ClassLibrary1 | +src/ClassLibrary1/Class1.cs | +21 | ++ | + | + | Method 'Bar' is never used | ++ | + | 200 | +Suggestion | +UnusedMember.Global | +Type member is never used: Non-private accessibility | +https://www.jetbrains.com/resharperplatform/help?Keyword=UnusedMember.Global | ++ | Cake.Issues.InspectCode.InspectCodeIssuesProvider | +InspectCode | +
| + | ClassLibrary1 | +src/ClassLibrary1/Class1.cs | +27 | ++ | + | + | Local variable 'foobar' is never used | ++ | + | 300 | +Warning | +UnusedVariable | +Unused local variable | +https://www.jetbrains.com/resharperplatform/help?Keyword=UnusedVariable | ++ | Cake.Issues.InspectCode.InspectCodeIssuesProvider | +InspectCode | +
| + | + | docs/index.md | +1 | ++ | + | + | Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "# foo"] | ++ | + | 300 | +Warning | +MD022 | ++ | https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md022 | +Demos documentation | +Cake.Issues.Markdownlint.MarkdownlintIssuesProvider | +markdownlint | +
| + | + | docs/index.md | +2 | ++ | 811 | ++ | Trailing spaces [Expected: 0 or 2; Actual: 1] | ++ | + | 300 | +Warning | +MD009 | ++ | https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md009 | +Demos documentation | +Cake.Issues.Markdownlint.MarkdownlintIssuesProvider | +markdownlint | +
| + | + | docs/index.md | +2 | ++ | 101 | ++ | Line length [Expected: 100; Actual: 811] | ++ | + | 300 | +Warning | +MD013 | ++ | https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md013 | +Demos documentation | +Cake.Issues.Markdownlint.MarkdownlintIssuesProvider | +markdownlint | +
| + | + | docs/index.md | +4 | ++ | + | + | Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "# bar"] | ++ | + | 300 | +Warning | +MD022 | ++ | https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md022 | +Demos documentation | +Cake.Issues.Markdownlint.MarkdownlintIssuesProvider | +markdownlint | +
| + | + | docs/index.md | +4 | ++ | + | + | Multiple top-level headings in the same document [Context: "# bar"] | ++ | + | 300 | +Warning | +MD025 | ++ | https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md025 | +Demos documentation | +Cake.Issues.Markdownlint.MarkdownlintIssuesProvider | +markdownlint | +
| + | + | docs/index.md | +5 | ++ | + | + | Fenced code blocks should be surrounded by blank lines [Context: "```"] | ++ | + | 300 | +Warning | +MD031 | ++ | https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md031 | +Demos documentation | +Cake.Issues.Markdownlint.MarkdownlintIssuesProvider | +markdownlint | +
| + | + | docs/index.md | +5 | ++ | + | + | Fenced code blocks should have a language specified [Context: "```"] | ++ | + | 300 | +Warning | +MD040 | ++ | https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md040 | +Demos documentation | +Cake.Issues.Markdownlint.MarkdownlintIssuesProvider | +markdownlint | +
| + | + | docs/index.md | +7 | ++ | 3 | ++ | Files should end with a single newline character | ++ | + | 300 | +Warning | +MD047 | ++ | https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md047 | +Demos documentation | +Cake.Issues.Markdownlint.MarkdownlintIssuesProvider | +markdownlint | +
| + | + | myfile.txt | +42 | ++ | + | + | Something went wrong | +Something went <b>wrong</b> | +Something went **wrong** | +300 | +Warning | ++ | + | + | + | MyCakeScript | +My Cake Script | +
@Html.Raw(Model.String(DocsKeys.Description))
+ +@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/report-formats/sarif/examples.md b/docs/input/docs/report-formats/sarif/examples.md new file mode 100644 index 000000000..31b231753 --- /dev/null +++ b/docs/input/docs/report-formats/sarif/examples.md @@ -0,0 +1,51 @@ +--- +Order: 30 +Title: Examples +Description: Examples for using the Cake.Issues.Reporting.Sarif addin. +--- +The following example will create a SARIF report for issues logged as warnings by MsBuild. + +:::{.alert .alert-warning} +Please note that you always should pin addins and tools to a specific version to make sure your builds are deterministic and +won't break due to updates to one of the packages. + +See [pinning addin versions](https://cakebuild.net/docs/tutorials/pinning-cake-version#pinning-addin-version) for details. +::: + +```csharp +#tool "nuget:?package=MSBuild.Extension.Pack" +#addin "Cake.Issues" +#addin "Cake.Issues.MsBuild" +#addin "Cake.Issues.Reporting" +#addin "Cake.Issues.Reporting.Sarif" + +Task("Create-IssueReport").Does(() => +{ + var repoRootFolder = new DirectoryPath(@"c:\repo"); + + // Build MySolution.sln solution in the repository root folder and log issues + // using XmlFileLogger from MSBuild Extension Pack. + FilePath msBuildLogFile = @"c:\build\msbuild.log"; + var settings = new MsBuildSettings() + .WithLogger( + Context.Tools.Resolve("MSBuild.ExtensionPack.Loggers.dll").FullPath, + "XmlFileLogger", + string.Format( + "logfile=\"{0}\";verbosity=Detailed;encoding=UTF-8", + msBuildLogFile) + ); + MSBuild(repoRootFolder.CombineWithFilePath("MySolution.sln"), settings); + + // Create SARIF report. + CreateIssueReport( + new List@Html.Raw(Model.String(DocsKeys.Description))
+ ++ Support for creating SARIF compatible reports is implemented in the + Cake.Issues.Reporting.Sarif addin. +
+ +@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/report-formats/sarif/requirements.md b/docs/input/docs/report-formats/sarif/requirements.md new file mode 100644 index 000000000..ab7342854 --- /dev/null +++ b/docs/input/docs/report-formats/sarif/requirements.md @@ -0,0 +1,9 @@ +--- +Order: 10 +Title: Requirements +Description: Requirements for the Cake.Issues.Reporting.Sarif addin. +--- +The requirements for using the [Cake.Issues.Reporting.Sarif addin] are listed in the [release notes] for any specific version. + +[Cake.Issues.Reporting.Sarif addin]: https://www.nuget.org/packages/Cake.Issues.Reporting.Sarif +[release notes]: release-notes \ No newline at end of file diff --git a/nuspec/nuget/Cake.Frosting.Issues.DocFx.nuspec b/nuspec/nuget/Cake.Frosting.Issues.DocFx.nuspec new file mode 100644 index 000000000..317591ecd --- /dev/null +++ b/nuspec/nuget/Cake.Frosting.Issues.DocFx.nuspec @@ -0,0 +1,59 @@ + +
+ ///
+ ///
+ /// {file} is not tracked by Git LFS")
+ .WithMessageInMarkdownFormat($"The binary file `{file}` is not tracked by Git LFS")
+ .InFile(file)
+ .OfRule(ruleDescription)
+ .Create());
+ }
+
+ return result;
+ }
+
+ /// {file} is too long. Maximum allowed path length is {this.IssueProviderSettings.MaxFilePathLength}, actual path length is {file.Length}.")
+ .WithMessageInMarkdownFormat($"The path for the file `{file}` is too long. Maximum allowed path length is {this.IssueProviderSettings.MaxFilePathLength}, actual path length is {file.Length}.")
+ .InFile(file)
+ .OfRule(ruleDescription)
+ .Create());
+ }
+ }
+
+ return result;
+ }
+
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ /// http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository.
+ /// Supported URL schemes are HTTP, HTTPS and SSH.
+ /// URLs using SSH scheme are converted to HTTPS.
+ /// Branch for which the pull request is made.
+ /// Credentials to use to authenticate against Azure DevOps.
+ ///
+ ///
+ ///
+ /// http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository.
+ /// Supported URL schemes are HTTP, HTTPS and SSH.
+ /// URLs using SSH scheme are converted to HTTPS.
+ /// ID of the pull request.
+ /// Credentials to use to authenticate against Azure DevOps.
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ /// http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository.
+ /// Supported URL schemes are HTTP, HTTPS and SSH.
+ /// URLs using SSH scheme are converted to HTTPS.
+ /// Branch for which the pull request is made.
+ /// Credentials to use to authenticate against Azure DevOps.
+ public AzureDevOpsPullRequestSystemSettings(Uri repositoryUrl, string sourceBranch, IAzureDevOpsCredentials credentials)
+ : base(repositoryUrl, sourceBranch, credentials)
+ {
+ }
+
+ /// http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository.
+ /// Supported URL schemes are HTTP, HTTPS and SSH.
+ /// URLs using SSH scheme are converted to HTTPS.
+ /// ID of the pull request.
+ /// Credentials to use to authenticate against Azure DevOps.
+ public AzureDevOpsPullRequestSystemSettings(Uri repositoryUrl, int pullRequestId, IAzureDevOpsCredentials credentials)
+ : base(repositoryUrl, pullRequestId, credentials)
+ {
+ }
+
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ /// src\\ClassLibrary1\\Class1.cs (Line 22 to 29)","Priority":300,"PriorityName":"Warning","Rule":"dupFinder","RuleUrl":null,"ProviderType":"Cake.Issues.DupFinder.DupFinderIssuesProvider","ProviderName":"DupFinder","Run":null,"AdditionalInformation":{"cost":"76"}},{"Version":4,"Identifier":"src\\ClassLibrary1\\Class1.cs-76-src\\ClassLibrary1\\Class1.cs","ProjectFileRelativePath":null,"ProjectName":null,"AffectedFileRelativePath":"src/ClassLibrary1/Class1.cs","Line":22,"EndLine":29,"Column":null,"EndColumn":null,"FileLink":null,"MessageText":"Possible duplicate detected (cost 76).\r\nThe following fragments were found that might be duplicates:\r\n\"src\\ClassLibrary1\\Class1.cs\" (Line 12 to 19)","MessageMarkdown":"Possible duplicate detected (cost 76).\r\nThe following fragments were found that might be duplicates:\r\n`src\\ClassLibrary1\\Class1.cs` (Line 12 to 19)","MessageHtml":"Possible duplicate detected (cost 76).src\\ClassLibrary1\\Class1.cs (Line 12 to 19)","Priority":300,"PriorityName":"Warning","Rule":"dupFinder","RuleUrl":null,"ProviderType":"Cake.Issues.DupFinder.DupFinderIssuesProvider","ProviderName":"DupFinder","Run":null,"AdditionalInformation":{"cost":"76"}},{"Version":4,"Identifier":"Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: \"# foo\"]","ProjectFileRelativePath":null,"ProjectName":null,"AffectedFileRelativePath":"docs/index.md","Line":1,"EndLine":null,"Column":null,"EndColumn":null,"FileLink":null,"MessageText":"Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: \"# foo\"]","MessageMarkdown":null,"MessageHtml":null,"Priority":300,"PriorityName":"Warning","Rule":"MD022","RuleUrl":"https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md022","ProviderType":"Cake.Issues.Markdownlint.MarkdownlintIssuesProvider","ProviderName":"markdownlint","Run":null,"AdditionalInformation":{}},{"Version":4,"Identifier":"Trailing spaces [Expected: 0 or 2; Actual: 1]","ProjectFileRelativePath":null,"ProjectName":null,"AffectedFileRelativePath":"docs/index.md","Line":2,"EndLine":null,"Column":null,"EndColumn":null,"FileLink":null,"MessageText":"Trailing spaces [Expected: 0 or 2; Actual: 1]","MessageMarkdown":null,"MessageHtml":null,"Priority":300,"PriorityName":"Warning","Rule":"MD009","RuleUrl":"https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md009","ProviderType":"Cake.Issues.Markdownlint.MarkdownlintIssuesProvider","ProviderName":"markdownlint","Run":null,"AdditionalInformation":{}},{"Version":4,"Identifier":"Line length [Expected: 80; Actual: 811]","ProjectFileRelativePath":null,"ProjectName":null,"AffectedFileRelativePath":"docs/index.md","Line":2,"EndLine":null,"Column":null,"EndColumn":null,"FileLink":null,"MessageText":"Line length [Expected: 80; Actual: 811]","MessageMarkdown":null,"MessageHtml":null,"Priority":300,"PriorityName":"Warning","Rule":"MD013","RuleUrl":"https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md013","ProviderType":"Cake.Issues.Markdownlint.MarkdownlintIssuesProvider","ProviderName":"markdownlint","Run":null,"AdditionalInformation":{}},{"Version":4,"Identifier":"Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: \"# bar\"]","ProjectFileRelativePath":null,"ProjectName":null,"AffectedFileRelativePath":"docs/index.md","Line":4,"EndLine":null,"Column":null,"EndColumn":null,"FileLink":null,"MessageText":"Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: \"# bar\"]","MessageMarkdown":null,"MessageHtml":null,"Priority":300,"PriorityName":"Warning","Rule":"MD022","RuleUrl":"https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md022","ProviderType":"Cake.Issues.Markdownlint.MarkdownlintIssuesProvider","ProviderName":"markdownlint","Run":null,"AdditionalInformation":{}},{"Version":4,"Identifier":"Multiple top-level headings in the same document [Context: \"# bar\"]","ProjectFileRelativePath":null,"ProjectName":null,"AffectedFileRelativePath":"docs/index.md","Line":4,"EndLine":null,"Column":null,"EndColumn":null,"FileLink":null,"MessageText":"Multiple top-level headings in the same document [Context: \"# bar\"]","MessageMarkdown":null,"MessageHtml":null,"Priority":300,"PriorityName":"Warning","Rule":"MD025","RuleUrl":"https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md025","ProviderType":"Cake.Issues.Markdownlint.MarkdownlintIssuesProvider","ProviderName":"markdownlint","Run":null,"AdditionalInformation":{}},{"Version":4,"Identifier":"Fenced code blocks should be surrounded by blank lines [Context: \"```\"]","ProjectFileRelativePath":null,"ProjectName":null,"AffectedFileRelativePath":"docs/index.md","Line":5,"EndLine":null,"Column":null,"EndColumn":null,"FileLink":null,"MessageText":"Fenced code blocks should be surrounded by blank lines [Context: \"```\"]","MessageMarkdown":null,"MessageHtml":null,"Priority":300,"PriorityName":"Warning","Rule":"MD031","RuleUrl":"https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md031","ProviderType":"Cake.Issues.Markdownlint.MarkdownlintIssuesProvider","ProviderName":"markdownlint","Run":null,"AdditionalInformation":{}},{"Version":4,"Identifier":"Fenced code blocks should have a language specified [Context: \"```\"]","ProjectFileRelativePath":null,"ProjectName":null,"AffectedFileRelativePath":"docs/index.md","Line":5,"EndLine":null,"Column":null,"EndColumn":null,"FileLink":null,"MessageText":"Fenced code blocks should have a language specified [Context: \"```\"]","MessageMarkdown":null,"MessageHtml":null,"Priority":300,"PriorityName":"Warning","Rule":"MD040","RuleUrl":"https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md040","ProviderType":"Cake.Issues.Markdownlint.MarkdownlintIssuesProvider","ProviderName":"markdownlint","Run":null,"AdditionalInformation":{}},{"Version":4,"Identifier":"Line length [Expected: 80; Actual: 840]","ProjectFileRelativePath":null,"ProjectName":null,"AffectedFileRelativePath":"docs/index.md","Line":6,"EndLine":null,"Column":null,"EndColumn":null,"FileLink":null,"MessageText":"Line length [Expected: 80; Actual: 840]","MessageMarkdown":null,"MessageHtml":null,"Priority":300,"PriorityName":"Warning","Rule":"MD013","RuleUrl":"https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md013","ProviderType":"Cake.Issues.Markdownlint.MarkdownlintIssuesProvider","ProviderName":"markdownlint","Run":null,"AdditionalInformation":{}},{"Version":4,"Identifier":"Files should end with a single newline character","ProjectFileRelativePath":null,"ProjectName":null,"AffectedFileRelativePath":"docs/index.md","Line":7,"EndLine":null,"Column":null,"EndColumn":null,"FileLink":null,"MessageText":"Files should end with a single newline character","MessageMarkdown":null,"MessageHtml":null,"Priority":300,"PriorityName":"Warning","Rule":"MD047","RuleUrl":"https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md047","ProviderType":"Cake.Issues.Markdownlint.MarkdownlintIssuesProvider","ProviderName":"markdownlint","Run":null,"AdditionalInformation":{}}]
\ No newline at end of file
diff --git a/src/Cake.Issues.Reporting.Console/Cake.Issues.Reporting.Console.csproj b/src/Cake.Issues.Reporting.Console/Cake.Issues.Reporting.Console.csproj
new file mode 100644
index 000000000..f89d95700
--- /dev/null
+++ b/src/Cake.Issues.Reporting.Console/Cake.Issues.Reporting.Console.csproj
@@ -0,0 +1,48 @@
+
+
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ /// x.WithOption(HtmlDxDataGridOption.Title, "My Issue Report")),
+ /// @"c:\repo",
+ /// @"c:\report.html");
+ /// ]]>
+ ///
+ ///
+ ///
+ ///
+ ///
+ /// x.WithOption("Title", "My Issue Report")),
+ /// @"c:\repo",
+ /// @"c:\report.html");
+ /// ]]>
+ ///
+ ///
+ /// @foreach(var issue in Model){@issue.Message }";
+ /// CreateIssueReport(
+ /// issues,
+ /// GenericIssueReportFormatFromContent(template),
+ /// @"c:\repo",
+ /// @"c:\report.html");
+ /// ]]>
+ ///
+ ///
+ /// @ViewBag.Title@foreach(var issue in Model){- @issue.Message
}
";
+ /// CreateIssueReport(
+ /// issues,
+ /// GenericIssueReportFormatFromContent(
+ /// template,
+ /// x => x.WithOption("Title", "My Issue Report")),
+ /// @"c:\repo",
+ /// @"c:\report.html");
+ /// ]]>
+ ///
+ ///
+ ///
+ ///
+ /// | Severity | +Project | +Directory | +File | +Location | +Rule | +Message | +
|---|---|---|---|---|---|---|
| @issue.PriorityName | +@issue.ProjectName | +@issue.FileDirectory() | +@issue.FileName() | +@issue.LineRange() | ++ @if (issue.RuleUrl != null) + { + @issue.RuleId + } + else + { + @issue.RuleId; + } + | +@issue.MessageText | +
| ProjectFileRelativePath | +ProjectName | +AffectedFileRelativePath | +Line | +EndLine | +Column | +EndColumn | +MessageText | +MessageHtml | +MessageMarkdown | +Priority | +PriorityName | +RuleId | +RuleName | +RuleUrl | +Run | +ProviderType | +ProviderName | +
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @issue.ProjectFileRelativePath | +@issue.ProjectName | +@issue.AffectedFileRelativePath | +@issue.Line | +@issue.EndLine | +@issue.Column | +@issue.EndColumn | +@issue.MessageText | +@issue.MessageHtml | +@issue.MessageMarkdown | +@issue.Priority | +@issue.PriorityName | +@issue.RuleId | +@issue.RuleName | +@issue.RuleUrl | +@issue.Run | +@issue.ProviderType | +@issue.ProviderName | +