-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for Cake.Issues.FrostingRecipe (#174)
- Loading branch information
1 parent
b12e722
commit 52c3088
Showing
6 changed files
with
63 additions
and
55 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,50 +1,50 @@ | ||
| --- | ||
| Order: 50 | ||
| Title: Configuration | ||
| Description: Available parameters to configure Cake.Issues.Recipe. | ||
| Description: Available parameters to configure Cake.Issues recipes. | ||
| --- | ||
|
|
||
| This page lists configuration properties which can be used to define the functionality | ||
| and behavior of Cake.Issues.Recipe. | ||
| and behavior of Cake.Issues recipes. | ||
|
|
||
| # General | ||
|
|
||
| | Property | Default Value | Description | | ||
| |----------------------------------------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `IssuesParameters.OutputDirectory` | `BuildArtifacts` | Path to the output directory. A relative path will be relative to the current working directory. | | ||
| | `IssuesParameters.BuildIdentifier` | `string.Empty` | Identifier for the build run. If set this identifier will be used to identify to artifacts provided by the build if building on multiple configurations. | | ||
| | Cake.Issues.Recipe Property | Cake.Frosting.Issues.Recipe Property | Default Value | Description | | ||
| |------------------------------------|--------------------------------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `IssuesParameters.OutputDirectory` | `IssuesContext.Parameters.OutputDirectory` | `BuildArtifacts` | Path to the output directory. A relative path will be relative to the current working directory. | | ||
| | `IssuesParameters.BuildIdentifier` | `IssuesContext.Parameters.BuildIdentifier` | `string.Empty` | Identifier for the build run. If set this identifier will be used to identify to artifacts provided by the build if building on multiple configurations. | | ||
|
|
||
| # Input files | ||
|
|
||
| | Property | Default Value | Description | | ||
| |---------------------------------------------------------------|---------------|-----------------------------------------------------------------------| | ||
| | `IssuesParameters.InputFiles.MsBuildXmlFileLoggerLogFilePath` | `null` | Path to the MSBuild log file created by XmlFileLogger. | | ||
| | `IssuesParameters.InputFiles.MsBuildBinaryLogFilePath` | `null` | Path to the MSBuild binary log file. | | ||
| | `IssuesParameters.InputFiles.InspectCodeLogFilePath` | `null` | Path to the JetBrains InspectCode log file. | | ||
| | `IssuesParameters.InputFiles.DupFinderLogFilePath` | `null` | Path to the JetBrains dupFinder log file. | | ||
| | `IssuesParameters.InputFiles.MarkdownlintCliLogFilePath` | `null` | Path to the markdownlint-cli log file. | | ||
| | `IssuesParameters.InputFiles.MarkdownlintV1LogFilePath` | `null` | Path to the markdownlint log file in version 1. | | ||
| | `IssuesParameters.InputFiles.EsLintJsonLogFilePath` | `null` | Path to the ESLint log file generated by the [ESLint json formatter]. | | ||
| | Cake.Issues.Recipe Methods | Cake.Frosting.Issues.Recipe Methods | Description | | ||
| |----------------------------------------------------------------|------------------------------------------------------------------------|----------------------------------------------------------------------------| | ||
| | `IssuesParameters.InputFiles.AddMsBuildXmlFileLoggerLogFile()` | `IssuesContext.Parameters.InputFiles.AddMsBuildXmlFileLoggerLogFile()` | Adds a path to a MSBuild log file created by XmlFileLogger. | | ||
| | `IssuesParameters.InputFiles.AddMsBuildBinaryLogFile()` | `IssuesContext.Parameters.InputFiles.AddMsBuildBinaryLogFile()` | Adds a path to a MSBuild binary log file. | | ||
| | `IssuesParameters.InputFiles.AddInspectCodeLogFile()` | `IssuesContext.Parameters.InputFiles.AddInspectCodeLogFile()` | Adds a path to a JetBrains InspectCode log file. | | ||
| | `IssuesParameters.InputFiles.AddDupFinderLogFile()` | `IssuesContext.Parameters.InputFiles.AddDupFinderLogFile()` | Adds a path to a JetBrains dupFinder log file. | | ||
| | `IssuesParameters.InputFiles.AddMarkdownlintCliLogFile()` | `IssuesContext.Parameters.InputFiles.AddMarkdownlintCliLogFile()` | Adds a path to a markdownlint-cli log file. | | ||
| | `IssuesParameters.InputFiles.AddMarkdownlintV1LogFile()` | `IssuesContext.Parameters.InputFiles.AddMarkdownlintV1LogFile()` | Adds a path to a markdownlint log file in version 1. | | ||
| | `IssuesParameters.InputFiles.AddEsLintJsonLogFile()` | `IssuesContext.Parameters.InputFiles.AddEsLintJsonLogFile()` | Adds a path to a ESLint log file generated by the [ESLint json formatter]. | | ||
|
|
||
| [ESLint json formatter]: https://eslint.org/docs/user-guide/formatters/#json | ||
|
|
||
| # Report creation | ||
|
|
||
| | Property | Default Value | Description | | ||
| |------------------------------------------------------------|---------------|---------------------------------------------------------| | ||
| | `IssuesParameters.Reporting.ShouldCreateFullIssuesReport` | `true` | Indicates whether full issues report should be created. | | ||
| | Cake.Issues.Recipe Property | Cake.Frosting.Issues.Recipe Property | Default Value | Description | | ||
| |------------------------------------------------------------|-------------------------------------------------------------------|---------------|---------------------------------------------------------| | ||
| | `IssuesParameters.Reporting.ShouldCreateFullIssuesReport` | `IssuesContext.Parameters.Reporting.ShouldCreateFullIssuesReport` | `true` | Indicates whether full issues report should be created. | | ||
|
|
||
| # Build server integration | ||
|
|
||
| | Property | Default Value | Description | | ||
| |----------------------------------------------------------------|---------------|-------------------------------------------------------------------------------------------| | ||
| | `IssuesParameters.BuildServer.ShouldReportIssuesToBuildServer` | `true` | Indicates whether issues should be reported to the build server. | | ||
| | `IssuesParameters.BuildServer.ShouldPublishFullIssuesReport` | `true` | Indicates whether full issues report should be published as artifact to the build system. | | ||
| | `IssuesParameters.BuildServer.ShouldCreateSummaryIssuesReport` | `true` | Indicates whether summary issues report should be created. | | ||
| | Cake.Issues.Recipe Property | Cake.Frosting.Issues.Recipe Property | Default Value | Description | | ||
| |----------------------------------------------------------------|------------------------------------------------------------------------|---------------|-------------------------------------------------------------------------------------------| | ||
| | `IssuesParameters.BuildServer.ShouldReportIssuesToBuildServer` | `IssuesContext.Parameters.BuildServer.ShouldReportIssuesToBuildServer` | `true` | Indicates whether issues should be reported to the build server. | | ||
| | `IssuesParameters.BuildServer.ShouldPublishFullIssuesReport` | `IssuesContext.Parameters.BuildServer.ShouldPublishFullIssuesReport` | `true` | Indicates whether full issues report should be published as artifact to the build system. | | ||
| | `IssuesParameters.BuildServer.ShouldCreateSummaryIssuesReport` | `IssuesContext.Parameters.BuildServer.ShouldCreateSummaryIssuesReport` | `true` | Indicates whether summary issues report should be created. | | ||
|
|
||
| # Pull request integration | ||
|
|
||
| | Property | Default Value | Description | | ||
| |----------------------------------------------------------------|---------------|-------------------------------------------------------------------------| | ||
| | `IssuesParameters.PullRequest.ShouldReportIssuesToPullRequest` | `true` | Indicates whether issues should be reported to the pull request system. | | ||
| | `IssuesParameters.PullRequest.ShouldSetPullRequestStatus` | `true` | Indicates whether a status on the pull request should be set. | | ||
| | Cake.Issues.Recipe Property | Cake.Frosting.Issues.Recipe Property | Default Value | Description | | ||
| |----------------------------------------------------------------------|------------------------------------------------------------------------------|---------------|-------------------------------------------------------------------------| | ||
| | `IssuesParameters.PullRequestSystem.ShouldReportIssuesToPullRequest` | `IssuesContext.Parameters.PullRequestSystem.ShouldReportIssuesToPullRequest` | `true` | Indicates whether issues should be reported to the pull request system. | | ||
| | `IssuesParameters.PullRequestSystem.ShouldSetPullRequestStatus` | `IssuesContext.Parameters.PullRequestSystem.ShouldSetPullRequestStatus` | `true` | Indicates whether a status on the pull request should be set. | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,12 @@ | ||
| --- | ||
| Order: 40 | ||
| Title: Demos | ||
| Description: Demo setups for Cake.Issues.Recipe. | ||
| Description: Demo setups for Cake.Issues recipes. | ||
| --- | ||
|
|
||
| There are demo setups available for different combinations of build servers and repositories which you can fork and to which you can create pull requests | ||
| to test the recipe functionality. | ||
|
|
||
| | Build Server | Repository | | ||
| |-------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| | ||
| | [Azure Pipelines](https://dev.azure.com/pberger/Cake.Issues.Recipe-Demo/_build/latest?definitionId=6) | [Azure Repos](https://dev.azure.com/pberger/_git/Cake.Issues.Recipe-Demo) | | ||
| | Recipe | Build Server | Repository | | ||
| |--------------------|-------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| | ||
| | Cake.Issues.Recipe | [Azure Pipelines](https://dev.azure.com/pberger/Cake.Issues.Recipe-Demo/_build/latest?definitionId=6) | [Azure Repos](https://dev.azure.com/pberger/_git/Cake.Issues.Recipe-Demo) | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,24 @@ | ||
| --- | ||
| Order: 10 | ||
| Title: Overview | ||
| Description: Overview about Cake.Issues.Recipe. | ||
| Description: Overview about Cake.Issues recipes. | ||
| --- | ||
| [Cake.Issues.Recipe] provides a build script, delivered as a NuGet package, which can be used inside your projects Cake build script to add issue management. | ||
| Cake.Issues recipes provide build scripts, delivered as a NuGet package, which can be used inside your projects Cake build to add issue management. | ||
|
|
||
| Integration of code analyzing and linting tools into a build pipeline often looks the similar, and differentiates mainly on the used linters, build and pull request systems. | ||
| Cake.Issues.Recipe contains code to do all the parsing, integration with build and pull request systems for you, using the individual Cake.Issues addins. | ||
| It supports different linters based on the linting log files you pass it and integrates automatically with different build and pull request systems. | ||
| Cake.Issues recipes contain code to do all the parsing, integration with build and pull request systems for you, using the individual Cake.Issues addins. | ||
| They support different linters based on the linting log files you pass it and integrate automatically with different build and pull request systems. | ||
|
|
||
| There are two flavors available: | ||
|
|
||
| * [Cake.Issues.Recipe]: For [Cake .NET Tool], [Cake runner for .NET Framework] or [Cake runner for .NET Core] | ||
| * [Cake.Frosting.Issues.Recipe]: For [Cake Frosting] | ||
|
|
||
| See [supported tools] for a list of supported linters, build servers and pull request systems. | ||
|
|
||
| [Cake.Issues.Recipe]: https://www.nuget.org/packages/Cake.Issues.Recipe | ||
| [Cake .NET Tool]: https://cakebuild.net/docs/running-builds/runners/dotnet-tool | ||
| [Cake runner for .NET Framework]: https://cakebuild.net/docs/running-builds/runners/cake-runner-for-dotnet-framework | ||
| [Cake runner for .NET Core]: https://cakebuild.net/docs/running-builds/runners/cake-runner-for-dotnet-core | ||
| [Cake Frosting]: https://cakebuild.net/docs/running-builds/runners/cake-frosting | ||
| [supported tools]: supported-tools |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,18 @@ | ||
| --- | ||
| Order: 60 | ||
| Title: Tasks | ||
| Description: Tasks provided by Cake.Issues.Recipe. | ||
| Description: Tasks provided by Cake.Issues recipes. | ||
| --- | ||
|
|
||
| Cake.Issues.Recipe provides the following tasks to your build script: | ||
| Cake.Issues recipes provide the following tasks to your build script: | ||
|
|
||
| | Task | Description | Task instance | | ||
| |------------------------------|----------------------------------------------|--------------------------------------------------| | ||
| | `Issues` | Main tasks for issue management integration. | `IssuesBuildTasks.IssuesTask` | | ||
| | `Read-Issues` | Reads issues from the provided log files. | `IssuesBuildTasks.ReadIssuesTask` | | ||
| | `Create-FullIssuesReport` | Creates issue report. | `IssuesBuildTasks.CreateFullIssuesReportTask` | | ||
| | `Publish-IssuesArtifacts` | Publish artifacts to build server. | `IssuesBuildTasks.PublishIssuesArtifactsTask` | | ||
| | `Report-IssuesToBuildServer` | Report issues to build server. | `IssuesBuildTasks.ReportIssuesToBuildServerTask` | | ||
| | `Create-SummaryIssuesReport` | Creates a summary issue report. | `IssuesBuildTasks.CreateSummaryIssuesReportTask` | | ||
| | `Report-IssuesToPullRequest` | Report issues to pull request. | `IssuesBuildTasks.ReportIssuesToPullRequestTask` | | ||
| | `Set-PullRequestIssuesState` | Set pull request status. | `IssuesBuildTasks.SetPullRequestIssuesStateTask` | | ||
| | Task | Description | Cake.Issues.Recipe task instance | Cake.Frosting.Issues.Recipe task type | | ||
| |------------------------------|----------------------------------------------|--------------------------------------------------|-------------------------------------------------------------| | ||
| | `Issues` | Main tasks for issue management integration. | `IssuesBuildTasks.IssuesTask` | `Cake.Frosting.Issues.Recipe.IssuesTask` | | ||
| | `Read-Issues` | Reads issues from the provided log files. | `IssuesBuildTasks.ReadIssuesTask` | `Cake.Frosting.Issues.Recipe.ReadIssuesTask` | | ||
| | `Create-FullIssuesReport` | Creates issue report. | `IssuesBuildTasks.CreateFullIssuesReportTask` | `Cake.Frosting.Issues.Recipe.CreateFullIssuesReportTask` | | ||
| | `Publish-IssuesArtifacts` | Publish artifacts to build server. | `IssuesBuildTasks.PublishIssuesArtifactsTask` | `Cake.Frosting.Issues.Recipe.PublishIssuesArtifactsTask` | | ||
| | `Report-IssuesToBuildServer` | Report issues to build server. | `IssuesBuildTasks.ReportIssuesToBuildServerTask` | `Cake.Frosting.Issues.Recipe.ReportIssuesToBuildServerTask` | | ||
| | `Create-SummaryIssuesReport` | Creates a summary issue report. | `IssuesBuildTasks.CreateSummaryIssuesReportTask` | `Cake.Frosting.Issues.Recipe.CreateSummaryIssuesReportTask` | | ||
| | `Report-IssuesToPullRequest` | Report issues to pull request. | `IssuesBuildTasks.ReportIssuesToPullRequestTask` | `Cake.Frosting.Issues.Recipe.ReportIssuesToPullRequestTask` | | ||
| | `Set-PullRequestIssuesState` | Set pull request status. | `IssuesBuildTasks.SetPullRequestIssuesStateTask` | `Cake.Frosting.Issues.Recipe.SetPullRequestIssuesStateTask` | |
Oops, something went wrong.