From 5d6692af3f9dd67f3752f66a5f6ce0c8666e28e8 Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Sat, 14 Dec 2024 09:13:08 +0100 Subject: [PATCH] Move website to Material for MkDocs --- .../integration-tests-reporting-generic.yml | 4 +- .gitignore | 11 +- .vscode/settings.json | 14 +- docs/docs/blog/index.md | 2 + .../2020-08-22-cake-issues-v0.9.0-released.md | 71 +- .../2020-09-19-cake-issues-v0.9.1-released.md | 16 +- .../blog/posts}/2020-09-24-annotations.png | Bin ...9-24-cake-issues-recipe-v0.4.2-released.md | 17 +- .../blog/posts}/2020-09-24-log-output.png | Bin .../2020-09-24-pullrequest-integration.png | Bin .../posts}/2020-09-27-github-actions-addin.md | 14 +- ...ake-issues-pullrequests-v0.9.1-released.md | 12 +- ...-20-cake-issues-msbuild-v0.9.1-released.md | 19 +- ...2-01-cake-issues-recipe-v0.4.4-released.md | 14 +- .../blog/posts}/2021-07-27-terraform-addin.md | 8 +- .../2021-07-28-cake-issues-v1.0.0-released.md | 59 +- ...7-30-cake-issues-eslint-v1.0.1-released.md | 12 +- ...8-04-cake-issues-recipe-v1.0.0-released.md | 18 +- ...8-11-cake-issues-recipe-v1.1.0-released.md | 8 +- ...8-19-cake-issues-recipe-v1.2.0-released.md | 10 +- .../blog/posts}/2021-08-29-console-addin.md | 11 +- .../blog/posts}/2021-08-29-diagnostics.png | Bin .../posts}/2021-08-29-summary-by-provider.png | Bin .../2021-08-29-summary-of-priorities.png | Bin ...1-08-31-cake-issues-markdownlint-v1.1.0.md | 14 +- ...05-cake-issues-reporting-0-3-0-released.md | 12 +- .../posts}/2021-09-05-summary-by-provider.png | Bin .../2022-12-10-cake-issues-v2.0.0-released.md | 16 +- .../2023-07-22-cake-issues-v3.0.0-released.md | 12 +- ...8-16-cake-issues-recipe-v3.1.0-released.md | 10 +- .../contributing/how-to-build.md | 9 +- .../contributing/how-to-contribute.md | 8 +- .../contributing/how-to-release.md | 8 +- .../documentation/extending/fundamentals.md | 10 + docs/docs/documentation/extending/index.md | 4 + .../extending/issue-provider/categories.md | 21 + .../extending/issue-provider/helper.md | 19 +- .../extending/issue-provider/overview.md | 21 + .../tutorials/logfile-format.md | 36 +- .../tutorials/rule-url-resolving.md | 39 +- .../issue-provider/tutorials/settings.md | 23 +- .../issue-provider/tutorials/simple.md | 20 +- .../pull-request-system/categories.md | 14 +- .../extending/pull-request-system/overview.md | 22 + .../extending/report-format/categories.md | 21 + .../extending/report-format/overview.md | 8 + docs/docs/documentation/extending/testing.md | 7 + .../fundamentals/architecture.md | 10 +- .../fundamentals/issue-provider.md | 9 +- .../documentation}/fundamentals/overview.png | Bin .../fundamentals/pull-request-system.md | 9 +- .../documentation}/fundamentals/recipe.md | 7 +- .../fundamentals/report-format.md | 9 +- .../documentation}/fundamentals/versioning.md | 21 +- .../issue-providers/docfx/examples.md | 26 +- .../issue-providers/docfx/features.md | 39 + .../issue-providers/docfx/index.md | 7 + .../issue-providers/eslint/features.md | 42 + .../issue-providers/eslint/index.md | 7 + .../issue-providers/gitrepository/examples.md | 26 +- .../issue-providers/gitrepository/features.md | 39 + .../issue-providers/gitrepository/index.md | 7 + .../rules/BinaryFileNotTrackedByLfs.md | 28 + .../gitrepository/rules/FilePathTooLong.md | 16 +- .../documentation/issue-providers/index.md | 4 + .../issue-providers/inspectcode/examples.md | 15 +- .../issue-providers/inspectcode/features.md | 38 + .../issue-providers/inspectcode/index.md | 7 + .../issue-providers/markdownlint/examples.md | 15 +- .../issue-providers/markdownlint/features.md | 54 + .../issue-providers/markdownlint/index.md | 7 + .../issue-providers/msbuild/examples.md | 15 +- .../issue-providers/msbuild/features.md | 42 + .../issue-providers/msbuild/index.md | 7 + .../issue-providers/terraform/features.md | 37 + .../issue-providers/terraform/index.md | 7 + .../documentation}/overview/features.md | 54 +- .../documentation}/overview/introduction.md | 31 +- .../documentation/overview/requirements.md | 8 + .../appveyor/appveyor-messages.png | Bin .../github-pullrequest-integration.md | 8 +- .../github-pullrequest-integration.png | Bin .../appveyor/examples/index.md | 8 + .../appveyor/examples/write-messages.md | 20 +- .../pull-request-systems/appveyor/features.md | 31 + .../pull-request-systems/appveyor/index.md | 7 + .../cake.issues.pullrequests.azuredevops.png | Bin .../azure-devops/examples/azure-pipelines.md | 34 +- .../azure-devops/examples/index.md | 8 + .../azure-devops/examples/pullrequest-id.md | 24 +- .../examples/repository-information.md | 25 +- .../azure-devops/features.md | 47 + .../azure-devops/index.md | 7 + .../azure-devops/setup.md | 40 +- .../examples/write-annotations.md | 20 +- .../github-actions/features.md | 25 + .../githubactions-annotations.png | Bin .../githubactions-log-output.png | Bin .../githubactions-pullrequest-integration.png | Bin .../github-actions/index.md | 7 + .../pull-request-systems/index.md | 4 + .../documentation}/recipe/configuration.md | 31 +- .../documentation}/recipe/demos.md | 5 +- .../documentation}/recipe/overview.md | 14 +- .../documentation}/recipe/supported-tools.md | 29 +- .../documentation}/recipe/tasks.md | 5 +- docs/docs/documentation/recipe/usage/index.md | 4 + .../using-cake-frosting-issues-recipe.md | 32 +- .../recipe/usage/using-cake-issues-recipe.md | 27 +- .../report-formats/console/examples.md | 15 +- .../report-formats/console/features.md | 14 +- .../report-formats/console/index.md | 7 + .../generic/examples/custom-template.md | 40 +- .../generic/examples/default-template.md | 17 +- .../generic/examples/index.cshtml | 0 .../report-formats/generic/features.md | 16 + .../report-formats/generic/index.md | 7 + .../templates/htmldatatable-demo-default.html | 0 .../generic/templates/htmldatatable.md | 53 + .../generic/templates/htmldatatable01.png | Bin .../htmldiagnostic-demo-default.html | 0 .../generic/templates/htmldiagnostic.md | 48 + .../generic/templates/htmldiagnostic01.png | Bin ...htmldxdatagrid-demo-additionalcolumns.html | 0 .../htmldxdatagrid-demo-changetitle.html | 0 .../htmldxdatagrid-demo-columnhiding.html | 0 ...ldxdatagrid-demo-customexportfilename.html | 0 ...ldxdatagrid-demo-customscriptlocation.html | 0 .../htmldxdatagrid-demo-default.html | 0 .../htmldxdatagrid-demo-disablefiltering.html | 0 .../htmldxdatagrid-demo-disablegrouping.html | 0 .../htmldxdatagrid-demo-disableheader.html | 0 .../htmldxdatagrid-demo-disablesearching.html | 0 .../htmldxdatagrid-demo-enableexporting.html | 0 .../htmldxdatagrid-demo-exportformat-pdf.html | 0 ...htmldxdatagrid-demo-exportformat-xlsx.html | 0 .../htmldxdatagrid-demo-grouping.html | 0 .../htmldxdatagrid-demo-sorting.html | 0 .../htmldxdatagrid-demo-theme-carmine.html | 0 .../htmldxdatagrid-demo-theme-contrast.html | 0 ...dxdatagrid-demo-theme-contrastcompact.html | 0 .../htmldxdatagrid-demo-theme-dark.html | 0 ...htmldxdatagrid-demo-theme-darkcompact.html | 0 .../htmldxdatagrid-demo-theme-darkmoon.html | 0 .../htmldxdatagrid-demo-theme-darkviolet.html | 0 .../htmldxdatagrid-demo-theme-greenmist.html | 0 .../htmldxdatagrid-demo-theme-light.html | 0 ...tmldxdatagrid-demo-theme-lightcompact.html | 0 ...xdatagrid-demo-theme-materialbluedark.html | 0 ...id-demo-theme-materialbluedarkcompact.html | 0 ...datagrid-demo-theme-materialbluelight.html | 0 ...d-demo-theme-materialbluelightcompact.html | 0 ...xdatagrid-demo-theme-materiallimedark.html | 0 ...id-demo-theme-materiallimedarkcompact.html | 0 ...datagrid-demo-theme-materiallimelight.html | 0 ...d-demo-theme-materiallimelightcompact.html | 0 ...atagrid-demo-theme-materialorangedark.html | 0 ...-demo-theme-materialorangedarkcompact.html | 0 ...tagrid-demo-theme-materialorangelight.html | 0 ...demo-theme-materialorangelightcompact.html | 0 ...atagrid-demo-theme-materialpurpledark.html | 0 ...-demo-theme-materialpurpledarkcompact.html | 0 ...tagrid-demo-theme-materialpurplelight.html | 0 ...demo-theme-materialpurplelightcompact.html | 0 ...xdatagrid-demo-theme-materialtealdark.html | 0 ...id-demo-theme-materialtealdarkcompact.html | 0 ...datagrid-demo-theme-materialteallight.html | 0 ...d-demo-theme-materialteallightcompact.html | 0 .../htmldxdatagrid-demo-theme-softblue.html | 0 .../generic/templates/htmldxdatagrid.md | 239 ++++ .../generic/templates/htmldxdatagrid01.png | Bin .../report-formats/generic/templates/index.md | 4 + .../documentation/report-formats/index.md | 4 + .../report-formats/sarif/examples.md | 17 +- .../report-formats/sarif/features.md | 19 + .../report-formats/sarif/index.md | 7 + .../documentation}/resources/blog-posts.md | 16 +- .../documentation}/resources/presentations.md | 16 +- .../usage/creating-issues/creating-issues.md | 17 +- .../creating-reports/creating-reports.md | 17 +- .../usage/creating-reports/index.md | 6 + docs/docs/documentation/usage/index.md | 6 + .../usage/reading-issues/file-linking.md | 6 +- .../usage/reading-issues/index.md | 6 + .../usage/reading-issues/reading-issues.md | 19 +- .../usage/reading-issues/run-information.md | 6 +- docs/docs/documentation/usage/recipe/index.md | 8 + .../custom-issue-filter.md | 28 +- .../index.md | 6 + .../report-issues-to-pull-requests.md | 17 +- docs/docs/index.md | 75 ++ docs/input/_AddinsLayout.cshtml | 20 - docs/input/_AddinsList.cshtml | 57 - docs/input/_AddinsSidebar.cshtml | 6 - docs/input/_BlogPost.cshtml | 21 - docs/input/_Bottom.cshtml | 66 -- docs/input/_Footer.cshtml | 5 - docs/input/_Head.cshtml | 1 - docs/input/_Navbar.cshtml | 19 - docs/input/addins/index.cshtml | 12 - .../fonts/glyphicons-halflings-regular.eot | Bin 20127 -> 0 bytes .../fonts/glyphicons-halflings-regular.svg | 288 ----- .../fonts/glyphicons-halflings-regular.ttf | Bin 45404 -> 0 bytes .../fonts/glyphicons-halflings-regular.woff | Bin 23424 -> 0 bytes .../fonts/glyphicons-halflings-regular.woff2 | Bin 18028 -> 0 bytes docs/input/assets/css/override.less | 174 --- docs/input/assets/images/clippy.svg | 3 - docs/input/assets/images/envelope.svg | 1 - docs/input/assets/images/facebook.svg | 1 - docs/input/assets/images/linkedin.svg | 1 - docs/input/assets/images/reddit.svg | 1 - docs/input/assets/images/twitter.svg | 1 - docs/input/assets/js/anchor.min.js | 6 - docs/input/assets/js/clipboard.min.js | 7 - docs/input/docs/contributing/index.cshtml | 6 - docs/input/docs/contributing/issues.cshtml | 19 - docs/input/docs/extending/fundamentals.md | 11 - docs/input/docs/extending/index.cshtml | 6 - .../extending/issue-provider/categories.md | 23 - .../extending/issue-provider/index.cshtml | 6 - .../docs/extending/issue-provider/overview.md | 24 - .../issue-provider/tutorials/index.cshtml | 6 - .../pull-request-system/index.cshtml | 6 - .../extending/pull-request-system/overview.md | 26 - .../extending/report-format/categories.md | 23 - .../docs/extending/report-format/index.cshtml | 6 - .../docs/extending/report-format/overview.md | 10 - docs/input/docs/extending/testing.md | 11 - docs/input/docs/fundamentals/index.cshtml | 6 - docs/input/docs/index.cshtml | 20 - .../docs/issue-providers/docfx/features.md | 43 - .../docs/issue-providers/docfx/index.cshtml | 12 - .../issue-providers/docfx/requirements.md | 9 - .../docs/issue-providers/eslint/features.md | 44 - .../docs/issue-providers/eslint/index.cshtml | 12 - .../issue-providers/eslint/requirements.md | 9 - .../issue-providers/gitrepository/features.md | 39 - .../gitrepository/index.cshtml | 11 - .../gitrepository/requirements.md | 9 - .../rules/BinaryFileNotTrackedByLfs.md | 33 - .../gitrepository/rules/index.cshtml | 7 - docs/input/docs/issue-providers/index.cshtml | 7 - .../issue-providers/inspectcode/features.md | 38 - .../issue-providers/inspectcode/index.cshtml | 12 - .../inspectcode/requirements.md | 9 - .../issue-providers/markdownlint/features.md | 56 - .../issue-providers/markdownlint/index.cshtml | 12 - .../markdownlint/requirements.md | 9 - .../docs/issue-providers/msbuild/features.md | 48 - .../docs/issue-providers/msbuild/index.cshtml | 12 - .../issue-providers/msbuild/requirements.md | 9 - .../issue-providers/terraform/features.md | 37 - .../issue-providers/terraform/index.cshtml | 12 - .../issue-providers/terraform/requirements.md | 9 - docs/input/docs/overview/index.cshtml | 6 - .../release-notes/Cake.Issues.PullRequests.md | 930 --------------- .../release-notes/Cake.Issues.Reporting.md | 1036 ----------------- .../docs/overview/release-notes/index.cshtml | 11 - docs/input/docs/overview/requirements.md | 18 - .../appveyor/examples/index.cshtml | 12 - .../pull-request-systems/appveyor/features.md | 32 - .../appveyor/index.cshtml | 10 - .../appveyor/requirements.md | 9 - .../azure-devops/examples/index.cshtml | 12 - .../azure-devops/features.md | 48 - .../azure-devops/index.cshtml | 10 - .../azure-devops/requirements.md | 9 - .../github-actions/examples/index.cshtml | 7 - .../github-actions/features.md | 25 - .../github-actions/index.cshtml | 10 - .../github-actions/requirements.md | 9 - .../docs/pull-request-systems/index.cshtml | 7 - docs/input/docs/recipe/index.cshtml | 7 - docs/input/docs/recipe/usage/index.cshtml | 7 - .../docs/report-formats/console/index.cshtml | 12 - .../report-formats/console/requirements.md | 9 - .../docs/report-formats/generic/features.md | 20 - .../docs/report-formats/generic/index.cshtml | 12 - .../report-formats/generic/requirements.md | 9 - .../generic/templates/.artifactignore | 2 - .../generic/templates/htmldatatable.md | 54 - .../generic/templates/htmldiagnostic.md | 50 - .../generic/templates/htmldxdatagrid.md | 240 ---- .../generic/templates/index.cshtml | 7 - docs/input/docs/report-formats/index.cshtml | 7 - .../docs/report-formats/sarif/features.md | 17 - .../docs/report-formats/sarif/index.cshtml | 12 - .../docs/report-formats/sarif/requirements.md | 9 - docs/input/docs/resources/index.cshtml | 7 - docs/input/docs/thanks.cshtml | 127 -- .../docs/usage/creating-issues/index.cshtml | 7 - .../docs/usage/creating-reports/index.cshtml | 11 - docs/input/docs/usage/index.cshtml | 7 - .../docs/usage/reading-issues/index.cshtml | 11 - docs/input/docs/usage/recipe/index.md | 8 - .../index.cshtml | 11 - docs/input/dsl/index.cshtml | 74 -- docs/input/index.cshtml | 82 -- docs/mkdocs.yml | 231 ++++ .../frosting/build/BuildContext.cs | 2 +- .../script-runner/build.cake | 2 +- 301 files changed, 2067 insertions(+), 5120 deletions(-) create mode 100644 docs/docs/blog/index.md rename docs/{input/news => docs/blog/posts}/2020-08-22-cake-issues-v0.9.0-released.md (81%) rename docs/{input/news => docs/blog/posts}/2020-09-19-cake-issues-v0.9.1-released.md (82%) rename docs/{input/news => docs/blog/posts}/2020-09-24-annotations.png (100%) rename docs/{input/news => docs/blog/posts}/2020-09-24-cake-issues-recipe-v0.4.2-released.md (75%) rename docs/{input/news => docs/blog/posts}/2020-09-24-log-output.png (100%) rename docs/{input/news => docs/blog/posts}/2020-09-24-pullrequest-integration.png (100%) rename docs/{input/news => docs/blog/posts}/2020-09-27-github-actions-addin.md (53%) rename docs/{input/news => docs/blog/posts}/2020-10-09-cake-issues-pullrequests-v0.9.1-released.md (78%) rename docs/{input/news => docs/blog/posts}/2020-10-20-cake-issues-msbuild-v0.9.1-released.md (69%) rename docs/{input/news => docs/blog/posts}/2020-12-01-cake-issues-recipe-v0.4.4-released.md (73%) rename docs/{input/news => docs/blog/posts}/2021-07-27-terraform-addin.md (82%) rename docs/{input/news => docs/blog/posts}/2021-07-28-cake-issues-v1.0.0-released.md (76%) rename docs/{input/news => docs/blog/posts}/2021-07-30-cake-issues-eslint-v1.0.1-released.md (79%) rename docs/{input/news => docs/blog/posts}/2021-08-04-cake-issues-recipe-v1.0.0-released.md (84%) rename docs/{input/news => docs/blog/posts}/2021-08-11-cake-issues-recipe-v1.1.0-released.md (92%) rename docs/{input/news => docs/blog/posts}/2021-08-19-cake-issues-recipe-v1.2.0-released.md (85%) rename docs/{input/news => docs/blog/posts}/2021-08-29-console-addin.md (78%) rename docs/{input/news => docs/blog/posts}/2021-08-29-diagnostics.png (100%) rename docs/{input/news => docs/blog/posts}/2021-08-29-summary-by-provider.png (100%) rename docs/{input/news => docs/blog/posts}/2021-08-29-summary-of-priorities.png (100%) rename docs/{input/news => docs/blog/posts}/2021-08-31-cake-issues-markdownlint-v1.1.0.md (75%) rename docs/{input/news => docs/blog/posts}/2021-09-05-cake-issues-reporting-0-3-0-released.md (82%) rename docs/{input/news => docs/blog/posts}/2021-09-05-summary-by-provider.png (100%) rename docs/{input/news => docs/blog/posts}/2022-12-10-cake-issues-v2.0.0-released.md (90%) rename docs/{input/news => docs/blog/posts}/2023-07-22-cake-issues-v3.0.0-released.md (94%) rename docs/{input/news => docs/blog/posts}/2023-08-16-cake-issues-recipe-v3.1.0-released.md (86%) rename docs/{input/docs => docs/documentation}/contributing/how-to-build.md (55%) rename docs/{input/docs => docs/documentation}/contributing/how-to-contribute.md (69%) rename docs/{input/docs => docs/documentation}/contributing/how-to-release.md (53%) create mode 100644 docs/docs/documentation/extending/fundamentals.md create mode 100644 docs/docs/documentation/extending/index.md create mode 100644 docs/docs/documentation/extending/issue-provider/categories.md rename docs/{input/docs => docs/documentation}/extending/issue-provider/helper.md (56%) create mode 100644 docs/docs/documentation/extending/issue-provider/overview.md rename docs/{input/docs => docs/documentation}/extending/issue-provider/tutorials/logfile-format.md (87%) rename docs/{input/docs => docs/documentation}/extending/issue-provider/tutorials/rule-url-resolving.md (70%) rename docs/{input/docs => docs/documentation}/extending/issue-provider/tutorials/settings.md (89%) rename docs/{input/docs => docs/documentation}/extending/issue-provider/tutorials/simple.md (84%) rename docs/{input/docs => docs/documentation}/extending/pull-request-system/categories.md (51%) create mode 100644 docs/docs/documentation/extending/pull-request-system/overview.md create mode 100644 docs/docs/documentation/extending/report-format/categories.md create mode 100644 docs/docs/documentation/extending/report-format/overview.md create mode 100644 docs/docs/documentation/extending/testing.md rename docs/{input/docs => docs/documentation}/fundamentals/architecture.md (89%) rename docs/{input/docs => docs/documentation}/fundamentals/issue-provider.md (75%) rename docs/{input/docs => docs/documentation}/fundamentals/overview.png (100%) rename docs/{input/docs => docs/documentation}/fundamentals/pull-request-system.md (71%) rename docs/{input/docs => docs/documentation}/fundamentals/recipe.md (71%) rename docs/{input/docs => docs/documentation}/fundamentals/report-format.md (61%) rename docs/{input/docs => docs/documentation}/fundamentals/versioning.md (55%) rename docs/{input/docs => docs/documentation}/issue-providers/docfx/examples.md (52%) create mode 100644 docs/docs/documentation/issue-providers/docfx/features.md create mode 100644 docs/docs/documentation/issue-providers/docfx/index.md create mode 100644 docs/docs/documentation/issue-providers/eslint/features.md create mode 100644 docs/docs/documentation/issue-providers/eslint/index.md rename docs/{input/docs => docs/documentation}/issue-providers/gitrepository/examples.md (53%) create mode 100644 docs/docs/documentation/issue-providers/gitrepository/features.md create mode 100644 docs/docs/documentation/issue-providers/gitrepository/index.md create mode 100644 docs/docs/documentation/issue-providers/gitrepository/rules/BinaryFileNotTrackedByLfs.md rename docs/{input/docs => docs/documentation}/issue-providers/gitrepository/rules/FilePathTooLong.md (58%) create mode 100644 docs/docs/documentation/issue-providers/index.md rename docs/{input/docs => docs/documentation}/issue-providers/inspectcode/examples.md (76%) create mode 100644 docs/docs/documentation/issue-providers/inspectcode/features.md create mode 100644 docs/docs/documentation/issue-providers/inspectcode/index.md rename docs/{input/docs => docs/documentation}/issue-providers/markdownlint/examples.md (79%) create mode 100644 docs/docs/documentation/issue-providers/markdownlint/features.md create mode 100644 docs/docs/documentation/issue-providers/markdownlint/index.md rename docs/{input/docs => docs/documentation}/issue-providers/msbuild/examples.md (81%) create mode 100644 docs/docs/documentation/issue-providers/msbuild/features.md create mode 100644 docs/docs/documentation/issue-providers/msbuild/index.md create mode 100644 docs/docs/documentation/issue-providers/terraform/features.md create mode 100644 docs/docs/documentation/issue-providers/terraform/index.md rename docs/{input/docs => docs/documentation}/overview/features.md (63%) rename docs/{input/docs => docs/documentation}/overview/introduction.md (62%) create mode 100644 docs/docs/documentation/overview/requirements.md rename docs/{input/docs => docs/documentation}/pull-request-systems/appveyor/appveyor-messages.png (100%) rename docs/{input/docs => docs/documentation}/pull-request-systems/appveyor/examples/github-pullrequest-integration.md (87%) rename docs/{input/docs => docs/documentation}/pull-request-systems/appveyor/examples/github-pullrequest-integration.png (100%) create mode 100644 docs/docs/documentation/pull-request-systems/appveyor/examples/index.md rename docs/{input/docs => docs/documentation}/pull-request-systems/appveyor/examples/write-messages.md (64%) create mode 100644 docs/docs/documentation/pull-request-systems/appveyor/features.md create mode 100644 docs/docs/documentation/pull-request-systems/appveyor/index.md rename docs/{input/docs => docs/documentation}/pull-request-systems/azure-devops/cake.issues.pullrequests.azuredevops.png (100%) rename docs/{input/docs => docs/documentation}/pull-request-systems/azure-devops/examples/azure-pipelines.md (67%) create mode 100644 docs/docs/documentation/pull-request-systems/azure-devops/examples/index.md rename docs/{input/docs => docs/documentation}/pull-request-systems/azure-devops/examples/pullrequest-id.md (59%) rename docs/{input/docs => docs/documentation}/pull-request-systems/azure-devops/examples/repository-information.md (64%) create mode 100644 docs/docs/documentation/pull-request-systems/azure-devops/features.md create mode 100644 docs/docs/documentation/pull-request-systems/azure-devops/index.md rename docs/{input/docs => docs/documentation}/pull-request-systems/azure-devops/setup.md (80%) rename docs/{input/docs => docs/documentation}/pull-request-systems/github-actions/examples/write-annotations.md (70%) create mode 100644 docs/docs/documentation/pull-request-systems/github-actions/features.md rename docs/{input/docs => docs/documentation}/pull-request-systems/github-actions/githubactions-annotations.png (100%) rename docs/{input/docs => docs/documentation}/pull-request-systems/github-actions/githubactions-log-output.png (100%) rename docs/{input/docs => docs/documentation}/pull-request-systems/github-actions/githubactions-pullrequest-integration.png (100%) create mode 100644 docs/docs/documentation/pull-request-systems/github-actions/index.md create mode 100644 docs/docs/documentation/pull-request-systems/index.md rename docs/{input/docs => docs/documentation}/recipe/configuration.md (95%) rename docs/{input/docs => docs/documentation}/recipe/demos.md (91%) rename docs/{input/docs => docs/documentation}/recipe/overview.md (96%) rename docs/{input/docs => docs/documentation}/recipe/supported-tools.md (66%) rename docs/{input/docs => docs/documentation}/recipe/tasks.md (97%) create mode 100644 docs/docs/documentation/recipe/usage/index.md rename docs/{input/docs => docs/documentation}/recipe/usage/using-cake-frosting-issues-recipe.md (84%) rename docs/{input/docs => docs/documentation}/recipe/usage/using-cake-issues-recipe.md (72%) rename docs/{input/docs => docs/documentation}/report-formats/console/examples.md (77%) rename docs/{input/docs => docs/documentation}/report-formats/console/features.md (57%) create mode 100644 docs/docs/documentation/report-formats/console/index.md rename docs/{input/docs => docs/documentation}/report-formats/generic/examples/custom-template.md (75%) rename docs/{input/docs => docs/documentation}/report-formats/generic/examples/default-template.md (75%) rename docs/{input/docs => docs/documentation}/report-formats/generic/examples/index.cshtml (100%) create mode 100644 docs/docs/documentation/report-formats/generic/features.md create mode 100644 docs/docs/documentation/report-formats/generic/index.md rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldatatable-demo-default.html (100%) create mode 100644 docs/docs/documentation/report-formats/generic/templates/htmldatatable.md rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldatatable01.png (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldiagnostic-demo-default.html (100%) create mode 100644 docs/docs/documentation/report-formats/generic/templates/htmldiagnostic.md rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldiagnostic01.png (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-additionalcolumns.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-changetitle.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-columnhiding.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-customexportfilename.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-customscriptlocation.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-default.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-disablefiltering.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-disablegrouping.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-disableheader.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-disablesearching.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-enableexporting.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-exportformat-pdf.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-exportformat-xlsx.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-grouping.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-sorting.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-carmine.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-contrast.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-contrastcompact.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-dark.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-darkcompact.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-darkmoon.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-darkviolet.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-greenmist.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-light.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-lightcompact.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialbluedark.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialbluedarkcompact.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialbluelight.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialbluelightcompact.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-materiallimedark.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-materiallimedarkcompact.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-materiallimelight.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-materiallimelightcompact.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialorangedark.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialorangedarkcompact.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialorangelight.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialorangelightcompact.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialpurpledark.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialpurpledarkcompact.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialpurplelight.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialpurplelightcompact.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialtealdark.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialtealdarkcompact.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialteallight.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialteallightcompact.html (100%) rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid-demo-theme-softblue.html (100%) create mode 100644 docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid.md rename docs/{input/docs => docs/documentation}/report-formats/generic/templates/htmldxdatagrid01.png (100%) create mode 100644 docs/docs/documentation/report-formats/generic/templates/index.md create mode 100644 docs/docs/documentation/report-formats/index.md rename docs/{input/docs => docs/documentation}/report-formats/sarif/examples.md (75%) create mode 100644 docs/docs/documentation/report-formats/sarif/features.md create mode 100644 docs/docs/documentation/report-formats/sarif/index.md rename docs/{input/docs => docs/documentation}/resources/blog-posts.md (57%) rename docs/{input/docs => docs/documentation}/resources/presentations.md (55%) rename docs/{input/docs => docs/documentation}/usage/creating-issues/creating-issues.md (66%) rename docs/{input/docs => docs/documentation}/usage/creating-reports/creating-reports.md (69%) create mode 100644 docs/docs/documentation/usage/creating-reports/index.md create mode 100644 docs/docs/documentation/usage/index.md rename docs/{input/docs => docs/documentation}/usage/reading-issues/file-linking.md (90%) create mode 100644 docs/docs/documentation/usage/reading-issues/index.md rename docs/{input/docs => docs/documentation}/usage/reading-issues/reading-issues.md (68%) rename docs/{input/docs => docs/documentation}/usage/reading-issues/run-information.md (92%) create mode 100644 docs/docs/documentation/usage/recipe/index.md rename docs/{input/docs => docs/documentation}/usage/reporting-issues-to-pull-requests/custom-issue-filter.md (56%) create mode 100644 docs/docs/documentation/usage/reporting-issues-to-pull-requests/index.md rename docs/{input/docs => docs/documentation}/usage/reporting-issues-to-pull-requests/report-issues-to-pull-requests.md (71%) create mode 100644 docs/docs/index.md delete mode 100644 docs/input/_AddinsLayout.cshtml delete mode 100644 docs/input/_AddinsList.cshtml delete mode 100644 docs/input/_AddinsSidebar.cshtml delete mode 100644 docs/input/_BlogPost.cshtml delete mode 100644 docs/input/_Bottom.cshtml delete mode 100644 docs/input/_Footer.cshtml delete mode 100644 docs/input/_Head.cshtml delete mode 100644 docs/input/_Navbar.cshtml delete mode 100644 docs/input/addins/index.cshtml delete mode 100644 docs/input/assets/css/fonts/glyphicons-halflings-regular.eot delete mode 100644 docs/input/assets/css/fonts/glyphicons-halflings-regular.svg delete mode 100644 docs/input/assets/css/fonts/glyphicons-halflings-regular.ttf delete mode 100644 docs/input/assets/css/fonts/glyphicons-halflings-regular.woff delete mode 100644 docs/input/assets/css/fonts/glyphicons-halflings-regular.woff2 delete mode 100644 docs/input/assets/css/override.less delete mode 100644 docs/input/assets/images/clippy.svg delete mode 100644 docs/input/assets/images/envelope.svg delete mode 100644 docs/input/assets/images/facebook.svg delete mode 100644 docs/input/assets/images/linkedin.svg delete mode 100644 docs/input/assets/images/reddit.svg delete mode 100644 docs/input/assets/images/twitter.svg delete mode 100644 docs/input/assets/js/anchor.min.js delete mode 100644 docs/input/assets/js/clipboard.min.js delete mode 100644 docs/input/docs/contributing/index.cshtml delete mode 100644 docs/input/docs/contributing/issues.cshtml delete mode 100644 docs/input/docs/extending/fundamentals.md delete mode 100644 docs/input/docs/extending/index.cshtml delete mode 100644 docs/input/docs/extending/issue-provider/categories.md delete mode 100644 docs/input/docs/extending/issue-provider/index.cshtml delete mode 100644 docs/input/docs/extending/issue-provider/overview.md delete mode 100644 docs/input/docs/extending/issue-provider/tutorials/index.cshtml delete mode 100644 docs/input/docs/extending/pull-request-system/index.cshtml delete mode 100644 docs/input/docs/extending/pull-request-system/overview.md delete mode 100644 docs/input/docs/extending/report-format/categories.md delete mode 100644 docs/input/docs/extending/report-format/index.cshtml delete mode 100644 docs/input/docs/extending/report-format/overview.md delete mode 100644 docs/input/docs/extending/testing.md delete mode 100644 docs/input/docs/fundamentals/index.cshtml delete mode 100644 docs/input/docs/index.cshtml delete mode 100644 docs/input/docs/issue-providers/docfx/features.md delete mode 100644 docs/input/docs/issue-providers/docfx/index.cshtml delete mode 100644 docs/input/docs/issue-providers/docfx/requirements.md delete mode 100644 docs/input/docs/issue-providers/eslint/features.md delete mode 100644 docs/input/docs/issue-providers/eslint/index.cshtml delete mode 100644 docs/input/docs/issue-providers/eslint/requirements.md delete mode 100644 docs/input/docs/issue-providers/gitrepository/features.md delete mode 100644 docs/input/docs/issue-providers/gitrepository/index.cshtml delete mode 100644 docs/input/docs/issue-providers/gitrepository/requirements.md delete mode 100644 docs/input/docs/issue-providers/gitrepository/rules/BinaryFileNotTrackedByLfs.md delete mode 100644 docs/input/docs/issue-providers/gitrepository/rules/index.cshtml delete mode 100644 docs/input/docs/issue-providers/index.cshtml delete mode 100644 docs/input/docs/issue-providers/inspectcode/features.md delete mode 100644 docs/input/docs/issue-providers/inspectcode/index.cshtml delete mode 100644 docs/input/docs/issue-providers/inspectcode/requirements.md delete mode 100644 docs/input/docs/issue-providers/markdownlint/features.md delete mode 100644 docs/input/docs/issue-providers/markdownlint/index.cshtml delete mode 100644 docs/input/docs/issue-providers/markdownlint/requirements.md delete mode 100644 docs/input/docs/issue-providers/msbuild/features.md delete mode 100644 docs/input/docs/issue-providers/msbuild/index.cshtml delete mode 100644 docs/input/docs/issue-providers/msbuild/requirements.md delete mode 100644 docs/input/docs/issue-providers/terraform/features.md delete mode 100644 docs/input/docs/issue-providers/terraform/index.cshtml delete mode 100644 docs/input/docs/issue-providers/terraform/requirements.md delete mode 100644 docs/input/docs/overview/index.cshtml delete mode 100644 docs/input/docs/overview/release-notes/Cake.Issues.PullRequests.md delete mode 100644 docs/input/docs/overview/release-notes/Cake.Issues.Reporting.md delete mode 100644 docs/input/docs/overview/release-notes/index.cshtml delete mode 100644 docs/input/docs/overview/requirements.md delete mode 100644 docs/input/docs/pull-request-systems/appveyor/examples/index.cshtml delete mode 100644 docs/input/docs/pull-request-systems/appveyor/features.md delete mode 100644 docs/input/docs/pull-request-systems/appveyor/index.cshtml delete mode 100644 docs/input/docs/pull-request-systems/appveyor/requirements.md delete mode 100644 docs/input/docs/pull-request-systems/azure-devops/examples/index.cshtml delete mode 100644 docs/input/docs/pull-request-systems/azure-devops/features.md delete mode 100644 docs/input/docs/pull-request-systems/azure-devops/index.cshtml delete mode 100644 docs/input/docs/pull-request-systems/azure-devops/requirements.md delete mode 100644 docs/input/docs/pull-request-systems/github-actions/examples/index.cshtml delete mode 100644 docs/input/docs/pull-request-systems/github-actions/features.md delete mode 100644 docs/input/docs/pull-request-systems/github-actions/index.cshtml delete mode 100644 docs/input/docs/pull-request-systems/github-actions/requirements.md delete mode 100644 docs/input/docs/pull-request-systems/index.cshtml delete mode 100644 docs/input/docs/recipe/index.cshtml delete mode 100644 docs/input/docs/recipe/usage/index.cshtml delete mode 100644 docs/input/docs/report-formats/console/index.cshtml delete mode 100644 docs/input/docs/report-formats/console/requirements.md delete mode 100644 docs/input/docs/report-formats/generic/features.md delete mode 100644 docs/input/docs/report-formats/generic/index.cshtml delete mode 100644 docs/input/docs/report-formats/generic/requirements.md delete mode 100644 docs/input/docs/report-formats/generic/templates/.artifactignore delete mode 100644 docs/input/docs/report-formats/generic/templates/htmldatatable.md delete mode 100644 docs/input/docs/report-formats/generic/templates/htmldiagnostic.md delete mode 100644 docs/input/docs/report-formats/generic/templates/htmldxdatagrid.md delete mode 100644 docs/input/docs/report-formats/generic/templates/index.cshtml delete mode 100644 docs/input/docs/report-formats/index.cshtml delete mode 100644 docs/input/docs/report-formats/sarif/features.md delete mode 100644 docs/input/docs/report-formats/sarif/index.cshtml delete mode 100644 docs/input/docs/report-formats/sarif/requirements.md delete mode 100644 docs/input/docs/resources/index.cshtml delete mode 100644 docs/input/docs/thanks.cshtml delete mode 100644 docs/input/docs/usage/creating-issues/index.cshtml delete mode 100644 docs/input/docs/usage/creating-reports/index.cshtml delete mode 100644 docs/input/docs/usage/index.cshtml delete mode 100644 docs/input/docs/usage/reading-issues/index.cshtml delete mode 100644 docs/input/docs/usage/recipe/index.md delete mode 100644 docs/input/docs/usage/reporting-issues-to-pull-requests/index.cshtml delete mode 100644 docs/input/dsl/index.cshtml delete mode 100644 docs/input/index.cshtml create mode 100644 docs/mkdocs.yml diff --git a/.azuredevops/pipelines/templates/stages/integration-tests-reporting-generic.yml b/.azuredevops/pipelines/templates/stages/integration-tests-reporting-generic.yml index 4a87f7b91..bf68c851b 100644 --- a/.azuredevops/pipelines/templates/stages/integration-tests-reporting-generic.yml +++ b/.azuredevops/pipelines/templates/stages/integration-tests-reporting-generic.yml @@ -31,7 +31,7 @@ stages: - powershell: ./build.ps1 --verbosity=diagnostic workingDirectory: ./tests/Cake.Issues.Reporting.Generic/script-runner displayName: 'Run integration tests' - - publish: $(Build.SourcesDirectory)/docs/input/docs/report-formats/generic/templates + - publish: $(Build.SourcesDirectory)/docs/docs/documentation/report-formats/generic/templates artifact: Integration Tests Cake.Issues.Reporting.Generic Cake Scripting $(System.JobName) displayName: 'Publish generated reports as build artifact' - job: TestReportingGenericFrostingNet8Job @@ -60,6 +60,6 @@ stages: - powershell: ./build.ps1 --verbosity=diagnostic workingDirectory: ./tests/Cake.Issues.Reporting.Generic/frosting displayName: 'Run integration tests' - - publish: $(Build.SourcesDirectory)/docs/input/docs/report-formats/generic/templates + - publish: $(Build.SourcesDirectory)/docs/docs/documentation/report-formats/generic/templates artifact: Integration Tests Cake.Issues.Reporting.Generic Cake Frosting .NET 8 $(System.JobName) displayName: 'Publish generated reports as build artifact' diff --git a/.gitignore b/.gitignore index ba4e60c6b..3068af6bf 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,3 @@ -# Project specific - -BuildArtifacts/ - # Created by https://www.gitignore.io/api/cake,visualstudio ### Cake ### @@ -304,4 +300,9 @@ __pycache__/ # By default, sensitive information, such as encrypted password # should be stored in the .pubxml.user file. -# End of https://www.gitignore.io/api/cake,visualstudio \ No newline at end of file +# End of https://www.gitignore.io/api/cake,visualstudio + +# Project specific + +BuildArtifacts/ +docs/.cache/ \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json index ff1570829..be2f7b909 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,3 +1,15 @@ { - "dotnet.defaultSolution": "src\\Cake.Issues.sln" + "dotnet.defaultSolution": "src\\Cake.Issues.sln", + "yaml.schemas": { + "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml" + }, + "yaml.customTags": [ + "!ENV scalar", + "!ENV sequence", + "!relative scalar", + "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg", + "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji", + "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format", + "tag:yaml.org,2002:python/object/apply:pymdownx.slugs.slugify mapping" + ] } \ No newline at end of file diff --git a/docs/docs/blog/index.md b/docs/docs/blog/index.md new file mode 100644 index 000000000..0e6302856 --- /dev/null +++ b/docs/docs/blog/index.md @@ -0,0 +1,2 @@ +# News + diff --git a/docs/input/news/2020-08-22-cake-issues-v0.9.0-released.md b/docs/docs/blog/posts/2020-08-22-cake-issues-v0.9.0-released.md similarity index 81% rename from docs/input/news/2020-08-22-cake-issues-v0.9.0-released.md rename to docs/docs/blog/posts/2020-08-22-cake-issues-v0.9.0-released.md index 086df590d..5f6390b54 100644 --- a/docs/input/news/2020-08-22-cake-issues-v0.9.0-released.md +++ b/docs/docs/blog/posts/2020-08-22-cake-issues-v0.9.0-released.md @@ -1,11 +1,13 @@ --- title: Cake Issues v0.9.0 Released -category: Release Notes +date: 2020-08-22 +categories: + - Release Notes --- Cake Issues version 0.9.0 has been released. This is a major release bringing a lot of new features across all addins. - + This post shows the highlights included in this release. For update instructions skip to [Updating from previous versions](#updating-from-previous-versions). @@ -14,15 +16,15 @@ For update instructions skip to [Updating from previous versions](#updating-from People working on this release: -* [AdmiringWorm](https://github.com/AdmiringWorm) -* [christianbumann](https://github.com/christianbumann) -* [eoehen](https://github.com/eoehen) -* [gep13](https://github.com/gep13) -* [janniksam](https://github.com/janniksam) -* [mholo65](https://github.com/mholo65) -* [pascalberger](https://github.com/pascalberger) -* [Speeedy01](https://github.com/Speeedy01) -* [jokay](https://github.com/jokay) +* [AdmiringWorm](https://github.com/AdmiringWorm){target="_blank"} +* [christianbumann](https://github.com/christianbumann){target="_blank"} +* [eoehen](https://github.com/eoehen){target="_blank"} +* [gep13](https://github.com/gep13){target="_blank"} +* [janniksam](https://github.com/janniksam){target="_blank"} +* [mholo65](https://github.com/mholo65){target="_blank"} +* [pascalberger](https://github.com/pascalberger){target="_blank"} +* [Speeedy01](https://github.com/Speeedy01){target="_blank"} +* [jokay](https://github.com/jokay){target="_blank"} ## Full cross-platform support @@ -31,10 +33,11 @@ While in previous versions most parts of Cake Issues was already targeting .NET .NET Core. With this release `Cake.Issues.Reporting.Generic` was ported to also run on .NET Core. -The migration was done by [gep13](https://github.com/gep13) on his [Twitch stream](https://www.twitch.tv/gep13) and you -can watch work done in [Stream 90 - Working on Cake.Issues.Recipe](https://www.youtube.com/watch?v=7roa5Q6KcrQ), -[Stream 91 - Working on Cake.Issues.Reporting.Generic and Gazorator](https://www.youtube.com/watch?v=ocacOz3CxME) and -[Stream 92 - Working on Cake.Issues.Reporting.Generic and Gazorator - Part 2](https://www.youtube.com/watch?v=P0IpkL9gUAE). +The migration was done by [gep13](https://github.com/gep13){target="_blank"} on his +[Twitch stream](https://www.twitch.tv/gep13){target="_blank"} and you +can watch work done in [Stream 90 - Working on Cake.Issues.Recipe](https://www.youtube.com/watch?v=7roa5Q6KcrQ){target="_blank"}, +[Stream 91 - Working on Cake.Issues.Reporting.Generic and Gazorator](https://www.youtube.com/watch?v=ocacOz3CxME){target="_blank"} and +[Stream 92 - Working on Cake.Issues.Reporting.Generic and Gazorator - Part 2](https://www.youtube.com/watch?v=P0IpkL9gUAE){target="_blank"}. ## Enhanced issue information @@ -137,7 +140,7 @@ across all runs. [Cake.Issues.Recipe], the Cake Recipe script which you can integrate into your build script for easy integration of full feature issue management, has been updated to version 0.4.0, bringing all the new features of Cake.Issues 0.9.0. -[Cake.Issues.Recipe]: ../docs/recipe/overview +[Cake.Issues.Recipe]: ../../documentation/recipe/overview.md ## Updating from previous versions @@ -149,7 +152,7 @@ This section documents the most common changes which might be required: Older version are still supported for deserialization. * Cake.Issues.Markdownlint * `MarkdownlintLogFileFormat` alias has been renamed to `MarkdownlintV1LogFileFormat` - ([#116](https://github.com/cake-contrib/Cake.Issues.Markdownlint/issues/116)). + ([#116](https://github.com/cake-contrib/Cake.Issues.Markdownlint/issues/116){target="_blank"}). * Cake.Issues.PullRequest * `ReportIssuesToPullRequest` alias which accepts an issue provider, or a list of issue providers, and settings requires now settings of type `IReportIssuesToPullRequestFromIssueProviderSettings` instead of `ReportIssuesToPullRequestSettings` to @@ -165,30 +168,30 @@ This section documents the most common changes which might be required: * `HtmlDxDataGridOption.FileLinkSettings` has been removed. File link settings can now be defined while reading the issues. For details see [File linking]. - ([#265](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/issues/265)). + ([#265](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/issues/265){target="_blank"}). * `HtmlDxDataGridOption.JSZipLocation` has been split into `HtmlDxDataGridOption.JsZipLocation` and `HtmlDxDataGridOption.JsZipVersion` - ([#320](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/issues/320)). + ([#320](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/issues/320){target="_blank"}). * Cake.Issues.Recipe * Cake.Issues.Recipe requires at least Cake 0.38.0 For details see release notes of the individual addins: -* [Cake.Issues 0.9.0](https://github.com/cake-contrib/Cake.Issues/releases/tag/0.9.0) -* [Cake.Issues.MsBuild 0.9.0](https://github.com/cake-contrib/Cake.Issues.MsBuild/releases/tag/0.9.0) -* [Cake.Issues.InspectCode 0.9.0](https://github.com/cake-contrib/Cake.Issues.InspectCode/releases/tag/0.9.0) -* [Cake.Issues.DupFinder 0.9.0](https://github.com/cake-contrib/Cake.Issues.DupFinder/releases/tag/0.9.0) -* [Cake.Issues.GitRepository 0.9.0](https://github.com/cake-contrib/Cake.Issues.GitRepository/releases/tag/0.9.0) -* [Cake.Issues.Markdownlint 0.9.0](https://github.com/cake-contrib/Cake.Issues.Markdownlint/releases/tag/0.9.0) -* [Cake.Issues.EsLint 0.9.0](https://github.com/cake-contrib/Cake.Issues.EsLint/releases/tag/0.9.0) -* [Cake.Issues.DocFx 0.9.0](https://github.com/cake-contrib/Cake.Issues.DocFx/releases/tag/0.9.0) -* [Cake.Issues.PullRequests 0.9.0](https://github.com/cake-contrib/Cake.Issues.PullRequests/releases/tag/0.9.0) -* [Cake.Issues.PullRequests.AzureDevOps 0.9.0](https://github.com/cake-contrib/Cake.Issues.PullRequests.AzureDevOps/releases/tag/0.9.0) -* [Cake.Issues.PullRequests.AppVeyor 0.9.0](https://github.com/cake-contrib/Cake.Issues.PullRequests.AppVeyor/releases/tag/0.9.0) -* [Cake.Issues.Reporting 0.9.0](https://github.com/cake-contrib/Cake.Issues.Reporting/releases/tag/0.9.0) -* [Cake.Issues.Reporting.Generic 0.9.0](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/releases/tag/0.9.0) -* [Cake.Issues.Reporting.Sarif 0.9.0](https://github.com/cake-contrib/Cake.Issues.Reporting.Sarif/releases/tag/0.9.0) -* [Cake.Issues.Recipe 0.4.0](https://github.com/cake-contrib/Cake.Issues.Recipe/releases/tag/0.4.0) +* [Cake.Issues 0.9.0](https://github.com/cake-contrib/Cake.Issues/releases/tag/0.9.0){target="_blank"} +* [Cake.Issues.MsBuild 0.9.0](https://github.com/cake-contrib/Cake.Issues.MsBuild/releases/tag/0.9.0){target="_blank"} +* [Cake.Issues.InspectCode 0.9.0](https://github.com/cake-contrib/Cake.Issues.InspectCode/releases/tag/0.9.0){target="_blank"} +* [Cake.Issues.DupFinder 0.9.0](https://github.com/cake-contrib/Cake.Issues.DupFinder/releases/tag/0.9.0){target="_blank"} +* [Cake.Issues.GitRepository 0.9.0](https://github.com/cake-contrib/Cake.Issues.GitRepository/releases/tag/0.9.0){target="_blank"} +* [Cake.Issues.Markdownlint 0.9.0](https://github.com/cake-contrib/Cake.Issues.Markdownlint/releases/tag/0.9.0){target="_blank"} +* [Cake.Issues.EsLint 0.9.0](https://github.com/cake-contrib/Cake.Issues.EsLint/releases/tag/0.9.0){target="_blank"} +* [Cake.Issues.DocFx 0.9.0](https://github.com/cake-contrib/Cake.Issues.DocFx/releases/tag/0.9.0){target="_blank"} +* [Cake.Issues.PullRequests 0.9.0](https://github.com/cake-contrib/Cake.Issues.PullRequests/releases/tag/0.9.0){target="_blank"} +* [Cake.Issues.PullRequests.AzureDevOps 0.9.0](https://github.com/cake-contrib/Cake.Issues.PullRequests.AzureDevOps/releases/tag/0.9.0){target="_blank"} +* [Cake.Issues.PullRequests.AppVeyor 0.9.0](https://github.com/cake-contrib/Cake.Issues.PullRequests.AppVeyor/releases/tag/0.9.0){target="_blank"} +* [Cake.Issues.Reporting 0.9.0](https://github.com/cake-contrib/Cake.Issues.Reporting/releases/tag/0.9.0){target="_blank"} +* [Cake.Issues.Reporting.Generic 0.9.0](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/releases/tag/0.9.0){target="_blank"} +* [Cake.Issues.Reporting.Sarif 0.9.0](https://github.com/cake-contrib/Cake.Issues.Reporting.Sarif/releases/tag/0.9.0){target="_blank"} +* [Cake.Issues.Recipe 0.4.0](https://github.com/cake-contrib/Cake.Issues.Recipe/releases/tag/0.4.0){target="_blank"} [File linking]: #file-linking [Support for passing additional run information]: #support-for-passing-additional-run-information diff --git a/docs/input/news/2020-09-19-cake-issues-v0.9.1-released.md b/docs/docs/blog/posts/2020-09-19-cake-issues-v0.9.1-released.md similarity index 82% rename from docs/input/news/2020-09-19-cake-issues-v0.9.1-released.md rename to docs/docs/blog/posts/2020-09-19-cake-issues-v0.9.1-released.md index f1c3a2458..c906d3160 100644 --- a/docs/input/news/2020-09-19-cake-issues-v0.9.1-released.md +++ b/docs/docs/blog/posts/2020-09-19-cake-issues-v0.9.1-released.md @@ -1,12 +1,14 @@ --- title: Cake Issues v0.9.1 Released -category: Release Notes +date: 2020-09-19 +categories: + - Release Notes --- Version 0.9.1 of Cake Issues and Cake.Issues.PullRequests.AzureDevOps have been released. These are minor releases containing improvements and bug fixes. - + This post shows the highlights included in this release. For update instructions skip to [Updating from previous versions](#updating-from-previous-versions). @@ -15,10 +17,10 @@ For update instructions skip to [Updating from previous versions](#updating-from People working on this release: -* [christianbumann](https://github.com/christianbumann) -* [janniksam](https://github.com/janniksam) -* [pascalberger](https://github.com/pascalberger) -* [jokay](https://github.com/jokay) +* [christianbumann](https://github.com/christianbumann){target="_blank"} +* [janniksam](https://github.com/janniksam){target="_blank"} +* [pascalberger](https://github.com/pascalberger){target="_blank"} +* [jokay](https://github.com/jokay){target="_blank"} ## Easier file linking for manually created issues @@ -31,7 +33,7 @@ it become much more complicated for issues created using the `NewIssue` alias, w Cake.Issues 0.9.1 adds an `WithFileLinkSettings` method to `IIssueBuilder` where a file link setting object can be passed which does resolve the URL. -[file link infrastructure was moved to Cake.Issues]: cake-issues-v0.9.0-released#file-linking +[file link infrastructure was moved to Cake.Issues]: 2020-08-22-cake-issues-v0.9.0-released.md#file-linking ## Line range and column support in Azure DevOps pull request integration diff --git a/docs/input/news/2020-09-24-annotations.png b/docs/docs/blog/posts/2020-09-24-annotations.png similarity index 100% rename from docs/input/news/2020-09-24-annotations.png rename to docs/docs/blog/posts/2020-09-24-annotations.png diff --git a/docs/input/news/2020-09-24-cake-issues-recipe-v0.4.2-released.md b/docs/docs/blog/posts/2020-09-24-cake-issues-recipe-v0.4.2-released.md similarity index 75% rename from docs/input/news/2020-09-24-cake-issues-recipe-v0.4.2-released.md rename to docs/docs/blog/posts/2020-09-24-cake-issues-recipe-v0.4.2-released.md index 53a1730ba..088d2b4e0 100644 --- a/docs/input/news/2020-09-24-cake-issues-recipe-v0.4.2-released.md +++ b/docs/docs/blog/posts/2020-09-24-cake-issues-recipe-v0.4.2-released.md @@ -1,11 +1,13 @@ --- title: Cake Issues Recipe v0.4.2 released, bringing support for GitHub Actions -category: Release Notes +date: 2020-09-24 +categories: + - Release Notes --- Version 0.4.2 of Cake Issues Recipe has been released bringing support for GitHub Actions. - + This post shows the highlights included in this release. For update instructions skip to [Updating from previous versions](#updating-from-previous-versions). @@ -14,8 +16,8 @@ For update instructions skip to [Updating from previous versions](#updating-from People working on this release: -* [admiringworm](https://github.com/admiringworm) -* [pascalberger](https://github.com/pascalberger) +* [admiringworm](https://github.com/admiringworm){target="_blank"} +* [pascalberger](https://github.com/pascalberger){target="_blank"} ## Support for GitHub Actions @@ -34,10 +36,9 @@ Having issues available as annotations also means that they will be shown in pul It's planned to support remaining features like providing full issue report as artifact in a future release. -:::{.alert .alert-info} -Support for GitHub Actions integration is currently only available in Cake.Issues.Recipe, but not as a standalone addin. -It's planned to additionally provide a standalone addin which can be used outside of Cake.Issues.Recipe in the future. -::: +!!! info + Support for GitHub Actions integration is currently only available in Cake.Issues.Recipe, but not as a standalone addin. + It's planned to additionally provide a standalone addin which can be used outside of Cake.Issues.Recipe in the future. ## Updating from previous versions diff --git a/docs/input/news/2020-09-24-log-output.png b/docs/docs/blog/posts/2020-09-24-log-output.png similarity index 100% rename from docs/input/news/2020-09-24-log-output.png rename to docs/docs/blog/posts/2020-09-24-log-output.png diff --git a/docs/input/news/2020-09-24-pullrequest-integration.png b/docs/docs/blog/posts/2020-09-24-pullrequest-integration.png similarity index 100% rename from docs/input/news/2020-09-24-pullrequest-integration.png rename to docs/docs/blog/posts/2020-09-24-pullrequest-integration.png diff --git a/docs/input/news/2020-09-27-github-actions-addin.md b/docs/docs/blog/posts/2020-09-27-github-actions-addin.md similarity index 53% rename from docs/input/news/2020-09-27-github-actions-addin.md rename to docs/docs/blog/posts/2020-09-27-github-actions-addin.md index 3efe52714..936d495c2 100644 --- a/docs/input/news/2020-09-27-github-actions-addin.md +++ b/docs/docs/blog/posts/2020-09-27-github-actions-addin.md @@ -1,23 +1,25 @@ --- title: New GitHub Actions addin -category: Release Notes +date: 2020-09-27 +categories: + - Release Notes --- A new [Cake.Issues.PullRequest.GitHubActions addin] has been released which brings integration with GitHub Actions and GitHub pull requests. - + [Cake.Issues.PullRequest.GitHubActions addin] creates annotations from issues when running on GitHub Actions: -![Annotations](../docs/pull-request-systems/github-actions/githubactions-annotations.png "Annotations") +![Annotations](../../documentation/pull-request-systems/github-actions/githubactions-annotations.png "Annotations") These annotations will also be shown in pull requests on the related file / position, bringing first class integration for GitHub pull requests to Cake.Issues: -![Pull request integration](../docs/pull-request-systems/github-actions/githubactions-pullrequest-integration.png "Pull request integration") +![Pull request integration](../../documentation/pull-request-systems/github-actions/githubactions-pullrequest-integration.png "Pull request integration") This integration was [first released in Cake.Issues.Recipe 0.4.2] and has now been moved to its own addin, which can also be used outside of Cake.Issues.Recipe. -[Cake.Issues.PullRequest.GitHubActions addin]: ../docs/pull-request-systems/github-actions/ -[first released in Cake.Issues.Recipe 0.4.2]: cake-issues-recipe-v0.4.2-released +[Cake.Issues.PullRequest.GitHubActions addin]: ../../documentation/pull-request-systems/github-actions/index.md +[first released in Cake.Issues.Recipe 0.4.2]: 2020-09-24-cake-issues-recipe-v0.4.2-released.md diff --git a/docs/input/news/2020-10-09-cake-issues-pullrequests-v0.9.1-released.md b/docs/docs/blog/posts/2020-10-09-cake-issues-pullrequests-v0.9.1-released.md similarity index 78% rename from docs/input/news/2020-10-09-cake-issues-pullrequests-v0.9.1-released.md rename to docs/docs/blog/posts/2020-10-09-cake-issues-pullrequests-v0.9.1-released.md index b28c70819..4555b3a48 100644 --- a/docs/input/news/2020-10-09-cake-issues-pullrequests-v0.9.1-released.md +++ b/docs/docs/blog/posts/2020-10-09-cake-issues-pullrequests-v0.9.1-released.md @@ -1,12 +1,14 @@ --- title: Cake Issues PullRequests v0.9.1 Released -category: Release Notes +date: 2020-10-09 +categories: + - Release Notes --- Version 0.9.1 of Cake.Issues.PullRequests has been released. This is a minor releases containing bug fixes. - + This post shows the highlights included in this release. For update instructions skip to [Updating from previous versions](#updating-from-previous-versions). @@ -15,9 +17,9 @@ For update instructions skip to [Updating from previous versions](#updating-from People working on this release: -* [janniksam](https://github.com/janniksam) -* [pascalberger](https://github.com/pascalberger) -* [phlorian](https://github.com/phlorian) +* [janniksam](https://github.com/janniksam){target="_blank"} +* [pascalberger](https://github.com/pascalberger){target="_blank"} +* [phlorian](https://github.com/phlorian){target="_blank"} ## Don't post issues if a provider limit is set to 0 diff --git a/docs/input/news/2020-10-20-cake-issues-msbuild-v0.9.1-released.md b/docs/docs/blog/posts/2020-10-20-cake-issues-msbuild-v0.9.1-released.md similarity index 69% rename from docs/input/news/2020-10-20-cake-issues-msbuild-v0.9.1-released.md rename to docs/docs/blog/posts/2020-10-20-cake-issues-msbuild-v0.9.1-released.md index 051b2c9c6..a7a4bfabb 100644 --- a/docs/input/news/2020-10-20-cake-issues-msbuild-v0.9.1-released.md +++ b/docs/docs/blog/posts/2020-10-20-cake-issues-msbuild-v0.9.1-released.md @@ -1,12 +1,14 @@ --- title: Cake Issues MsBuild v0.9.1 Released -category: Release Notes +date: 2020-10-20 +categories: + - Release Notes --- Version 0.9.1 of MsBuild support for Cake.Issues has been released. This is a minor release containing improvements. - + This post shows the highlights included in this release. For update instructions skip to [Updating from previous versions](#updating-from-previous-versions). @@ -15,10 +17,10 @@ For update instructions skip to [Updating from previous versions](#updating-from People working on this release: -* [cho-trackman](https://github.com/cho-trackman) -* [eoehen](https://github.com/eoehen) -* [pascalberger](https://github.com/pascalberger) -* [jokay](https://github.com/jokay) +* [cho-trackman](https://github.com/cho-trackman){target="_blank"} +* [eoehen](https://github.com/eoehen){target="_blank"} +* [pascalberger](https://github.com/pascalberger){target="_blank"} +* [jokay](https://github.com/jokay){target="_blank"} ## Support for reading of errors @@ -27,9 +29,8 @@ Starting with version 0.9.1 it will also return errors. Reading of errors has been implemented for `MsBuildBinaryLogFileFormat` and `MsBuildXmlFileLoggerFormat`. For errors `IIssue.Priority` will be set to `IssuePriority.Error`. -:::{.alert .alert-info} -To keep previous behavior result after reading the issues can be filtered for `IIssue.Priority == IIssuePriority.Warning`. -::: +!!! info + To keep previous behavior result after reading the issues can be filtered for `IIssue.Priority == IIssuePriority.Warning`. ## Updating from previous versions diff --git a/docs/input/news/2020-12-01-cake-issues-recipe-v0.4.4-released.md b/docs/docs/blog/posts/2020-12-01-cake-issues-recipe-v0.4.4-released.md similarity index 73% rename from docs/input/news/2020-12-01-cake-issues-recipe-v0.4.4-released.md rename to docs/docs/blog/posts/2020-12-01-cake-issues-recipe-v0.4.4-released.md index c85db7238..89fc88980 100644 --- a/docs/input/news/2020-12-01-cake-issues-recipe-v0.4.4-released.md +++ b/docs/docs/blog/posts/2020-12-01-cake-issues-recipe-v0.4.4-released.md @@ -1,26 +1,28 @@ --- title: Cake Issues Recipe v0.4.4 released, bringing support for ESLint -category: Release Notes +date: 2020-12-01 +categories: + - Release Notes --- Version 0.4.4 of Cake Issues Recipe has been released bringing support for ESLint. - + This post shows the highlights included in this release. For update instructions skip to [Updating from previous versions](#updating-from-previous-versions). -For details see [full release notes](https://github.com/cake-contrib/Cake.Issues.Recipe/releases/tag/0.4.4). +For details see [full release notes](https://github.com/cake-contrib/Cake.Issues.Recipe/releases/tag/0.4.4){target="_blank"}. ❤ Huge thanks to our community! This release would not have been possible without your support and contributions! ❤ People working on this release: -* [pascalberger](https://github.com/pascalberger) +* [pascalberger](https://github.com/pascalberger){target="_blank"} ## Support for ESLint -This version of Cake.Issues.Recipe brings support for issues reported by [ESLint](https://eslint.org/). -Currently supported are files generated using the [ESLint json formatter](https://eslint.org/docs/user-guide/formatters/#json) +This version of Cake.Issues.Recipe brings support for issues reported by [ESLint](https://eslint.org/){target="_blank"}. +Currently supported are files generated using the [ESLint json formatter](https://eslint.org/docs/user-guide/formatters/#json){target="_blank"} ## Updating from previous versions diff --git a/docs/input/news/2021-07-27-terraform-addin.md b/docs/docs/blog/posts/2021-07-27-terraform-addin.md similarity index 82% rename from docs/input/news/2021-07-27-terraform-addin.md rename to docs/docs/blog/posts/2021-07-27-terraform-addin.md index 114329390..0f561888f 100644 --- a/docs/input/news/2021-07-27-terraform-addin.md +++ b/docs/docs/blog/posts/2021-07-27-terraform-addin.md @@ -1,11 +1,13 @@ --- title: New addin for Terraform support -category: Release Notes +date: 2021-07-27 +categories: + - Release Notes --- A new [Cake.Issues.Terraform addin] has been released which adds support for reading issues from Terraform `validate` command.. - + [Cake.Issues.Terraform addin] brings support for Terraform to the Cake.Issues ecosystem. It allows to read the output of the Terraform `validate` command. @@ -14,4 +16,4 @@ ensure quality standards by validating Terraform files before merging or deployi When using a pull requests workflow it is also possible to have the issues reported by Terraform validate automatically reported as comments to pull request. -[Cake.Issues.Terraform addin]: ../docs/issue-providers/terraform/ +[Cake.Issues.Terraform addin]: ../../documentation/issue-providers/terraform/index.md diff --git a/docs/input/news/2021-07-28-cake-issues-v1.0.0-released.md b/docs/docs/blog/posts/2021-07-28-cake-issues-v1.0.0-released.md similarity index 76% rename from docs/input/news/2021-07-28-cake-issues-v1.0.0-released.md rename to docs/docs/blog/posts/2021-07-28-cake-issues-v1.0.0-released.md index 8c0931525..ad658977b 100644 --- a/docs/input/news/2021-07-28-cake-issues-v1.0.0-released.md +++ b/docs/docs/blog/posts/2021-07-28-cake-issues-v1.0.0-released.md @@ -1,13 +1,15 @@ --- title: Cake Issues v1.0.0 Released -category: Release Notes +date: 2021-07-28 +categories: + - Release Notes --- -More than 4 years after the [first commit for Cake.Prca](https://github.com/cake-contrib/Cake.Prca/commit/438b3a1a609e5b9cc9e6f8f489a73988f9ed1f4d), +More than 4 years after the [first commit for Cake.Prca](https://github.com/cake-contrib/Cake.Prca/commit/438b3a1a609e5b9cc9e6f8f489a73988f9ed1f4d){target="_blank"}, the predecessor of Cake Issues, we're happy to announce that Cake Issues version 1.0.0 has been released. This is a major release bringing a lot of new features across all addins. - + This post shows the highlights included in this release. For update instructions skip to [Updating from previous versions](#updating-from-previous-versions). @@ -16,11 +18,11 @@ For update instructions skip to [Updating from previous versions](#updating-from People working on this release: -* [eoehen](https://github.com/eoehen) -* [janniksam](https://github.com/janniksam) -* [pascalberger](https://github.com/pascalberger) -* [phlorian](https://github.com/phlorian) -* [jokay](https://github.com/jokay) +* [eoehen](https://github.com/eoehen){target="_blank"} +* [janniksam](https://github.com/janniksam){target="_blank"} +* [pascalberger](https://github.com/pascalberger){target="_blank"} +* [phlorian](https://github.com/phlorian){target="_blank"} +* [jokay](https://github.com/jokay){target="_blank"} ## Support for Cake 1.0 @@ -44,8 +46,8 @@ of what exact version of dependencies should be used. In the future more Cake Issues addins might be released in Frosting specific packages. [Cake Frosting]: https://cakebuild.net/docs/running-builds/runners/cake-frosting -[Cake.Issues.Reporting.Generic addin]: /docs/report-formats/generic/ -[Cake.Issues.Reporting.Generic]: https://www.nuget.org/packages/Cake.Issues.Reporting.Generic/ +[Cake.Issues.Reporting.Generic addin]: ../../documentation/report-formats/generic/index.md +[Cake.Issues.Reporting.Generic]: https://cakebuild.net/extensions/cake-issues-reporting-generic/ [Cake.Frosting.Issues.Reporting.Generic]: https://www.nuget.org/packages/Cake.Frosting.Issues.Reporting.Generic/ ## Support for arbitrary values in an issue @@ -59,7 +61,7 @@ While there are aliases to get provider type name (e.g. [MsBuildIssuesProviderTy not available through the `IIssueProvider` interface. There is a new `IIssueProvider.ProviderType` property which can be used to retrieve the provider type. -[MsBuildIssuesProviderTypeName]: /api/Cake.Issues.MsBuild/MsBuildIssuesAliases/0A221402 +[MsBuildIssuesProviderTypeName]: https://cakebuild.net/api/Cake.Issues.MsBuild/MsBuildIssuesAliases/0A221402 ## PDF export @@ -87,24 +89,23 @@ This section documents the most common changes which might be required: For issue providers inheriting from `BaseIssueProvider` no action is required to keep the same behavior as with previous versions, with the type name used as provider type. -:::{.alert .alert-info} -Cake.Recipe has not been updated to 1.0 yet. -::: +!!! info + Cake.Recipe has not been updated to 1.0 yet. For details see release notes of the individual addins: -* [Cake.Issues 1.0.0](https://github.com/cake-contrib/Cake.Issues/releases/tag/1.0.0) -* [Cake.Issues.MsBuild 1.0.0](https://github.com/cake-contrib/Cake.Issues.MsBuild/releases/tag/1.0.0) -* [Cake.Issues.InspectCode 1.0.0](https://github.com/cake-contrib/Cake.Issues.InspectCode/releases/tag/1.0.0) -* [Cake.Issues.DupFinder 1.0.0](https://github.com/cake-contrib/Cake.Issues.DupFinder/releases/tag/1.0.0) -* [Cake.Issues.GitRepository 1.0.0](https://github.com/cake-contrib/Cake.Issues.GitRepository/releases/tag/1.0.0) -* [Cake.Issues.Markdownlint 1.0.0](https://github.com/cake-contrib/Cake.Issues.Markdownlint/releases/tag/1.0.0) -* [Cake.Issues.EsLint 1.0.0](https://github.com/cake-contrib/Cake.Issues.EsLint/releases/tag/1.0.0) -* [Cake.Issues.DocFx 1.0.0](https://github.com/cake-contrib/Cake.Issues.DocFx/releases/tag/1.0.0) -* [Cake.Issues.Terraform 1.0.0](https://github.com/cake-contrib/Cake.Issues.Terraform/releases/tag/1.0.0) -* [Cake.Issues.PullRequests 1.0.0](https://github.com/cake-contrib/Cake.Issues.PullRequests/releases/tag/1.0.0) -* [Cake.Issues.PullRequests.AzureDevOps 1.0.0](https://github.com/cake-contrib/Cake.Issues.PullRequests.AzureDevOps/releases/tag/1.0.0) -* [Cake.Issues.PullRequests.AppVeyor 1.0.0](https://github.com/cake-contrib/Cake.Issues.PullRequests.AppVeyor/releases/tag/1.0.0) -* [Cake.Issues.Reporting 1.0.0](https://github.com/cake-contrib/Cake.Issues.Reporting/releases/tag/1.0.0) -* [Cake.Issues.Reporting.Generic 1.0.0](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/releases/tag/1.0.0) -* [Cake.Issues.Reporting.Sarif 1.0.0](https://github.com/cake-contrib/Cake.Issues.Reporting.Sarif/releases/tag/1.0.0) +* [Cake.Issues 1.0.0](https://github.com/cake-contrib/Cake.Issues/releases/tag/1.0.0){target="_blank"} +* [Cake.Issues.MsBuild 1.0.0](https://github.com/cake-contrib/Cake.Issues.MsBuild/releases/tag/1.0.0){target="_blank"} +* [Cake.Issues.InspectCode 1.0.0](https://github.com/cake-contrib/Cake.Issues.InspectCode/releases/tag/1.0.0){target="_blank"} +* [Cake.Issues.DupFinder 1.0.0](https://github.com/cake-contrib/Cake.Issues.DupFinder/releases/tag/1.0.0){target="_blank"} +* [Cake.Issues.GitRepository 1.0.0](https://github.com/cake-contrib/Cake.Issues.GitRepository/releases/tag/1.0.0){target="_blank"} +* [Cake.Issues.Markdownlint 1.0.0](https://github.com/cake-contrib/Cake.Issues.Markdownlint/releases/tag/1.0.0){target="_blank"} +* [Cake.Issues.EsLint 1.0.0](https://github.com/cake-contrib/Cake.Issues.EsLint/releases/tag/1.0.0){target="_blank"} +* [Cake.Issues.DocFx 1.0.0](https://github.com/cake-contrib/Cake.Issues.DocFx/releases/tag/1.0.0){target="_blank"} +* [Cake.Issues.Terraform 1.0.0](https://github.com/cake-contrib/Cake.Issues.Terraform/releases/tag/1.0.0){target="_blank"} +* [Cake.Issues.PullRequests 1.0.0](https://github.com/cake-contrib/Cake.Issues.PullRequests/releases/tag/1.0.0){target="_blank"} +* [Cake.Issues.PullRequests.AzureDevOps 1.0.0](https://github.com/cake-contrib/Cake.Issues.PullRequests.AzureDevOps/releases/tag/1.0.0){target="_blank"} +* [Cake.Issues.PullRequests.AppVeyor 1.0.0](https://github.com/cake-contrib/Cake.Issues.PullRequests.AppVeyor/releases/tag/1.0.0){target="_blank"} +* [Cake.Issues.Reporting 1.0.0](https://github.com/cake-contrib/Cake.Issues.Reporting/releases/tag/1.0.0){target="_blank"} +* [Cake.Issues.Reporting.Generic 1.0.0](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/releases/tag/1.0.0){target="_blank"} +* [Cake.Issues.Reporting.Sarif 1.0.0](https://github.com/cake-contrib/Cake.Issues.Reporting.Sarif/releases/tag/1.0.0){target="_blank"} diff --git a/docs/input/news/2021-07-30-cake-issues-eslint-v1.0.1-released.md b/docs/docs/blog/posts/2021-07-30-cake-issues-eslint-v1.0.1-released.md similarity index 79% rename from docs/input/news/2021-07-30-cake-issues-eslint-v1.0.1-released.md rename to docs/docs/blog/posts/2021-07-30-cake-issues-eslint-v1.0.1-released.md index 8413a1d15..056935dbf 100644 --- a/docs/input/news/2021-07-30-cake-issues-eslint-v1.0.1-released.md +++ b/docs/docs/blog/posts/2021-07-30-cake-issues-eslint-v1.0.1-released.md @@ -1,12 +1,14 @@ --- title: Cake Issues ESLint v1.0.1 Released -category: Release Notes +date: 2021-07-30 +categories: + - Release Notes --- Version 1.0.1 of ESLint support for Cake.Issues has been released. This is a minor release containing bug fixes. - + This post shows the highlights included in this release. For update instructions skip to [Updating from previous versions](#updating-from-previous-versions). @@ -15,9 +17,9 @@ For update instructions skip to [Updating from previous versions](#updating-from People working on this release: -* [eoehen](https://github.com/eoehen) -* [pascalberger](https://github.com/pascalberger) -* [Speeedy01](https://github.com/Speeedy01) +* [eoehen](https://github.com/eoehen){target="_blank"} +* [pascalberger](https://github.com/pascalberger){target="_blank"} +* [Speeedy01](https://github.com/Speeedy01){target="_blank"} ## Bug fix for issues with line, column or rule diff --git a/docs/input/news/2021-08-04-cake-issues-recipe-v1.0.0-released.md b/docs/docs/blog/posts/2021-08-04-cake-issues-recipe-v1.0.0-released.md similarity index 84% rename from docs/input/news/2021-08-04-cake-issues-recipe-v1.0.0-released.md rename to docs/docs/blog/posts/2021-08-04-cake-issues-recipe-v1.0.0-released.md index f7bd27c13..12841c9e3 100644 --- a/docs/input/news/2021-08-04-cake-issues-recipe-v1.0.0-released.md +++ b/docs/docs/blog/posts/2021-08-04-cake-issues-recipe-v1.0.0-released.md @@ -1,6 +1,8 @@ --- title: Cake Issues Recipe v1.0.0 Released, bringing support for Cake Frosting -category: Release Notes +date: 2021-08-04 +categories: + - Release Notes --- Hard on the heels of the [announcement for release 1.0 of Cake.Issues addins], @@ -8,9 +10,9 @@ we're happy to announce release 1.0 of the recipe script for Cake.Issues. This is a major release bringing support for Cake Frosting and other new features. -[announcement for release 1.0 of Cake.Issues addins]: /news/cake-issues-v1.0.0-released +[announcement for release 1.0 of Cake.Issues addins]: 2021-07-28-cake-issues-v1.0.0-released.md - + This post shows the highlights included in this release. For update instructions skip to [Updating from previous versions](#updating-from-previous-versions). @@ -19,7 +21,7 @@ For update instructions skip to [Updating from previous versions](#updating-from People working on this release: -* [pascalberger](https://github.com/pascalberger) +* [pascalberger](https://github.com/pascalberger){target="_blank"} ## Support for Cake 1.0 @@ -37,7 +39,7 @@ See [Using Cake.Frosting.Issues.Recipe] for an example. [Cake Frosting]: https://cakebuild.net/docs/running-builds/runners/cake-frosting [Cake.Issues.Recipe]: https://www.nuget.org/packages/Cake.Issues.Recipe/ [Cake.Frosting.Issues.Recipe]: https://www.nuget.org/packages/Cake.Frosting.Issues.Recipe/ -[Using Cake.Frosting.Issues.Recipe]: /docs/recipe/usage/using-cake-frosting-issues-recipe +[Using Cake.Frosting.Issues.Recipe]: ../../documentation/recipe/usage/using-cake-frosting-issues-recipe.md ## Support for environments not compatible with Cake.Git addin @@ -46,7 +48,7 @@ While this works in most cases, there are some environments where [Cake.Git addi Starting with this version it is now possible to define if [Cake.Git addin] or Git CLI should be used. -See [Git repository information configuration](/docs/recipe/configuration#git-repository-information) for details. +See [Git repository information configuration](../../documentation/recipe/configuration.md#git-repository-information) for details. [Cake.Git addin]: https://cakebuild.net/extensions/cake-git/ @@ -81,6 +83,4 @@ This section documents the most common changes which might be required: IssuesParameters.InputFiles.AddMsBuildXmlFileLoggerLogFile(@"c:\build\msbuild.log"); ``` -For details see [full release notes]. - -[full release notes]: https://github.com/cake-contrib/Cake.Issues.Recipe/releases/tag/1.0.0 +For details see [full release notes](https://github.com/cake-contrib/Cake.Issues.Recipe/releases/tag/1.0.0){target="_blank"} diff --git a/docs/input/news/2021-08-11-cake-issues-recipe-v1.1.0-released.md b/docs/docs/blog/posts/2021-08-11-cake-issues-recipe-v1.1.0-released.md similarity index 92% rename from docs/input/news/2021-08-11-cake-issues-recipe-v1.1.0-released.md rename to docs/docs/blog/posts/2021-08-11-cake-issues-recipe-v1.1.0-released.md index 152faa0d8..a2ce616db 100644 --- a/docs/input/news/2021-08-11-cake-issues-recipe-v1.1.0-released.md +++ b/docs/docs/blog/posts/2021-08-11-cake-issues-recipe-v1.1.0-released.md @@ -1,11 +1,13 @@ --- title: Cake Issues Recipes v1.1.0 released -category: Release Notes +date: 2021-08-11 +categories: + - Release Notes --- Version 1.1.0 of Cake Issues recipes have been released adding support to customize report generation. - + This post shows the highlights included in this release. For update instructions skip to [Updating from previous versions](#updating-from-previous-versions). @@ -14,7 +16,7 @@ For update instructions skip to [Updating from previous versions](#updating-from People working on this release: -* [pascalberger](https://github.com/pascalberger) +* [pascalberger](https://github.com/pascalberger){target="_blank"} ## Report customization diff --git a/docs/input/news/2021-08-19-cake-issues-recipe-v1.2.0-released.md b/docs/docs/blog/posts/2021-08-19-cake-issues-recipe-v1.2.0-released.md similarity index 85% rename from docs/input/news/2021-08-19-cake-issues-recipe-v1.2.0-released.md rename to docs/docs/blog/posts/2021-08-19-cake-issues-recipe-v1.2.0-released.md index 2c270090e..1e7736dea 100644 --- a/docs/input/news/2021-08-19-cake-issues-recipe-v1.2.0-released.md +++ b/docs/docs/blog/posts/2021-08-19-cake-issues-recipe-v1.2.0-released.md @@ -1,11 +1,13 @@ --- title: Cake Issues Recipes v1.2.0 released -category: Release Notes +date: 2021-08-19 +categories: + - Release Notes --- Version 1.2.0 of Cake Issues recipes have been released adding support to customize issue reporting to pull requests. - + This post shows the highlights included in this release. For details see [full release notes]. @@ -15,7 +17,7 @@ For update instructions skip to [Updating from previous versions](#updating-from People working on this release: -* [pascalberger](https://github.com/pascalberger) +* [pascalberger](https://github.com/pascalberger){target="_blank"} ## Customization of pull request integration @@ -40,5 +42,5 @@ context.Parameters.PullRequestSystem.MaxIssuesToPost = 20; Cake Issues recipes 1.2.0 are compatible with version 1.x without any breaking changes. To update to the new version bump the version in your build. -[Pull request integration parameters]: /docs/recipe/configuration#pull-request-integration +[Pull request integration parameters]: ../../documentation/recipe/configuration.md#pull-request-integration [full release notes]: https://github.com/cake-contrib/Cake.Issues.Recipe/releases/tag/1.2.0 diff --git a/docs/input/news/2021-08-29-console-addin.md b/docs/docs/blog/posts/2021-08-29-console-addin.md similarity index 78% rename from docs/input/news/2021-08-29-console-addin.md rename to docs/docs/blog/posts/2021-08-29-console-addin.md index 5398da538..7f20ce3c8 100644 --- a/docs/input/news/2021-08-29-console-addin.md +++ b/docs/docs/blog/posts/2021-08-29-console-addin.md @@ -1,14 +1,16 @@ --- title: New addin for printing issues to console -category: Release Notes +date: 2021-08-29 +categories: + - Release Notes --- A new [Cake.Issues.Reporting.Console addin] has been released which allows to output issues to the console. - + [Cake.Issues.Reporting.Console addin] can be used to print issues to the console and is built on top -of the excellent [Errata library] by Patrik Svensson. +of the excellent [Errata library](https://github.com/spectreconsole/errata){target="_blank"} by Patrik Svensson. Its main focus is to annotate source code with issues: @@ -27,5 +29,4 @@ Another summary shows the number of issues by priority for every provider and ru ![Summary of priorities](2021-08-29-summary-of-priorities.png "Summary of priorities") -[Cake.Issues.Reporting.Console addin]: /docs/report-formats/console/ -[Errata library]: https://github.com/spectreconsole/errata +[Cake.Issues.Reporting.Console addin]: ../../documentation/report-formats/console/index.md diff --git a/docs/input/news/2021-08-29-diagnostics.png b/docs/docs/blog/posts/2021-08-29-diagnostics.png similarity index 100% rename from docs/input/news/2021-08-29-diagnostics.png rename to docs/docs/blog/posts/2021-08-29-diagnostics.png diff --git a/docs/input/news/2021-08-29-summary-by-provider.png b/docs/docs/blog/posts/2021-08-29-summary-by-provider.png similarity index 100% rename from docs/input/news/2021-08-29-summary-by-provider.png rename to docs/docs/blog/posts/2021-08-29-summary-by-provider.png diff --git a/docs/input/news/2021-08-29-summary-of-priorities.png b/docs/docs/blog/posts/2021-08-29-summary-of-priorities.png similarity index 100% rename from docs/input/news/2021-08-29-summary-of-priorities.png rename to docs/docs/blog/posts/2021-08-29-summary-of-priorities.png diff --git a/docs/input/news/2021-08-31-cake-issues-markdownlint-v1.1.0.md b/docs/docs/blog/posts/2021-08-31-cake-issues-markdownlint-v1.1.0.md similarity index 75% rename from docs/input/news/2021-08-31-cake-issues-markdownlint-v1.1.0.md rename to docs/docs/blog/posts/2021-08-31-cake-issues-markdownlint-v1.1.0.md index 3853e97e9..a63d6b2dc 100644 --- a/docs/input/news/2021-08-31-cake-issues-markdownlint-v1.1.0.md +++ b/docs/docs/blog/posts/2021-08-31-cake-issues-markdownlint-v1.1.0.md @@ -1,12 +1,14 @@ --- title: Cake Issues Markdownlint v1.1.0 Released -category: Release Notes +date: 2021-08-31 +categories: + - Release Notes --- Version 1.1.0 of Markdownlint support for Cake.Issues has been released. This is a minor release adding features and improvements. - + This post shows the highlights included in this release. For update instructions skip to [Updating from previous versions](#updating-from-previous-versions). @@ -15,7 +17,7 @@ For update instructions skip to [Updating from previous versions](#updating-from People working on this release: -* [pascalberger](https://github.com/pascalberger) +* [pascalberger](https://github.com/pascalberger){target="_blank"} ## Support for markdownlint-cli JSON format @@ -37,6 +39,6 @@ adding support for markdownlint-cli JSON files. Cake.Issues.Markdownlint 1.1.0 is compatible with version 1.0.0 without any breaking changes. To update to the new version bump the version of the addin. -[MarkdownlintCliJsonLogFileFormat]: /api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/36DE6F5F -[MarkdownlintCliLogFileFormat]: /api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/B518F49E -[Cake Issues recipes]: /docs/recipe/overview \ No newline at end of file +[MarkdownlintCliJsonLogFileFormat]: https://cakebuild.net/api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/36DE6F5F +[MarkdownlintCliLogFileFormat]: https://cakebuild.net/api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/B518F49E +[Cake Issues recipes]: ../../documentation/recipe/overview.md \ No newline at end of file diff --git a/docs/input/news/2021-09-05-cake-issues-reporting-0-3-0-released.md b/docs/docs/blog/posts/2021-09-05-cake-issues-reporting-0-3-0-released.md similarity index 82% rename from docs/input/news/2021-09-05-cake-issues-reporting-0-3-0-released.md rename to docs/docs/blog/posts/2021-09-05-cake-issues-reporting-0-3-0-released.md index ed8d34599..f075a75eb 100644 --- a/docs/input/news/2021-09-05-cake-issues-reporting-0-3-0-released.md +++ b/docs/docs/blog/posts/2021-09-05-cake-issues-reporting-0-3-0-released.md @@ -1,12 +1,14 @@ --- title: Cake Issues Reporting Console v0.3.0 released, adding support for all Cake runners -category: Release Notes +date: 2021-09-05 +categories: + - Release Notes --- Version 0.3.0 of [Cake.Issues.Reporting.Console] has been released. This is a minor release adding features and improvements. - + This post shows the highlights included in this release. For update instructions skip to [Updating from previous versions](#updating-from-previous-versions). @@ -15,8 +17,8 @@ For update instructions skip to [Updating from previous versions](#updating-from People working on this release: -* [pascalberger](https://github.com/pascalberger) -* [patriksvensson](https://github.com/patriksvensson) +* [pascalberger](https://github.com/pascalberger){target="_blank"} +* [patriksvensson](https://github.com/patriksvensson){target="_blank"} ## Support for all Cake runners @@ -38,5 +40,5 @@ Underlying [Errata] library has been updated to 0.6.0, containing additional bug [Cake.Issues.Reporting.Console] 0.3.0 is compatible with previous versions without any breaking changes. To update to the new version bump the version of the addin. -[Cake.Issues.Reporting.Console]: /docs/report-formats/console/ +[Cake.Issues.Reporting.Console]: ../../documentation/report-formats/console/index.md [Errata]: https://github.com/spectreconsole/errata diff --git a/docs/input/news/2021-09-05-summary-by-provider.png b/docs/docs/blog/posts/2021-09-05-summary-by-provider.png similarity index 100% rename from docs/input/news/2021-09-05-summary-by-provider.png rename to docs/docs/blog/posts/2021-09-05-summary-by-provider.png diff --git a/docs/input/news/2022-12-10-cake-issues-v2.0.0-released.md b/docs/docs/blog/posts/2022-12-10-cake-issues-v2.0.0-released.md similarity index 90% rename from docs/input/news/2022-12-10-cake-issues-v2.0.0-released.md rename to docs/docs/blog/posts/2022-12-10-cake-issues-v2.0.0-released.md index e14fc32ab..7f22b5f27 100644 --- a/docs/input/news/2022-12-10-cake-issues-v2.0.0-released.md +++ b/docs/docs/blog/posts/2022-12-10-cake-issues-v2.0.0-released.md @@ -1,12 +1,14 @@ --- title: Cake Issues v2.0.0 Released -category: Release Notes +date: 2022-12-10 +categories: + - Release Notes --- After several months with beta releases Cake Issues version 2.0.0 has been released. This is a major release, containing breaking changes beside bringing new features and bug fixes across all addins. - + This post shows the highlights included in this release. For update instructions skip to [Updating from previous versions](#updating-from-previous-versions). @@ -15,11 +17,11 @@ For update instructions skip to [Updating from previous versions](#updating-from People working on this release: -* [eoehen](https://github.com/eoehen) -* [KirillOsenkov](https://github.com/KirillOsenkov) -* [pascalberger](https://github.com/pascalberger) -* [twenzel](https://github.com/twenzel) -* [yansklyarenko](https://github.com/yansklyarenko) +* [eoehen](https://github.com/eoehen){target="_blank"} +* [KirillOsenkov](https://github.com/KirillOsenkov){target="_blank"} +* [pascalberger](https://github.com/pascalberger){target="_blank"} +* [twenzel](https://github.com/twenzel){target="_blank"} +* [yansklyarenko](https://github.com/yansklyarenko){target="_blank"} ## Support for Cake 2.0 diff --git a/docs/input/news/2023-07-22-cake-issues-v3.0.0-released.md b/docs/docs/blog/posts/2023-07-22-cake-issues-v3.0.0-released.md similarity index 94% rename from docs/input/news/2023-07-22-cake-issues-v3.0.0-released.md rename to docs/docs/blog/posts/2023-07-22-cake-issues-v3.0.0-released.md index 59670d003..0e8218054 100644 --- a/docs/input/news/2023-07-22-cake-issues-v3.0.0-released.md +++ b/docs/docs/blog/posts/2023-07-22-cake-issues-v3.0.0-released.md @@ -1,12 +1,14 @@ --- title: Cake Issues v3.0.0 Released -category: Release Notes +date: 2023-07-22 +categories: + - Release Notes --- Cake Issues version 3.0.0 has been released. This is a major release, containing breaking changes beside bringing new features and bug fixes across all addins. - + This post shows the highlights included in this release. For update instructions skip to [Updating from previous versions](#updating-from-previous-versions). @@ -15,9 +17,9 @@ For update instructions skip to [Updating from previous versions](#updating-from People working on this release: -* [DiDoHH](https://github.com/DiDoHH) -* [eoehen](https://github.com/eoehen) -* [pascalberger](https://github.com/pascalberger) +* [DiDoHH](https://github.com/DiDoHH){target="_blank"} +* [eoehen](https://github.com/eoehen){target="_blank"} +* [pascalberger](https://github.com/pascalberger){target="_blank"} ## Support for Cake 3.0 diff --git a/docs/input/news/2023-08-16-cake-issues-recipe-v3.1.0-released.md b/docs/docs/blog/posts/2023-08-16-cake-issues-recipe-v3.1.0-released.md similarity index 86% rename from docs/input/news/2023-08-16-cake-issues-recipe-v3.1.0-released.md rename to docs/docs/blog/posts/2023-08-16-cake-issues-recipe-v3.1.0-released.md index 29b2e760f..2a9458668 100644 --- a/docs/input/news/2023-08-16-cake-issues-recipe-v3.1.0-released.md +++ b/docs/docs/blog/posts/2023-08-16-cake-issues-recipe-v3.1.0-released.md @@ -1,11 +1,13 @@ --- title: Cake Issues Recipes v3.1.0 released -category: Release Notes +date: 2023-08-16 +categories: + - Release Notes --- Version 3.1.0 of Cake Issues recipes have been released adding support for creating of reports in SARIF format. - + This post shows the highlights included in this release. For details see [full release notes]. @@ -15,7 +17,7 @@ For update instructions skip to [Updating from previous versions](#updating-from People working on this release: -* [pascalberger](https://github.com/pascalberger) +* [pascalberger](https://github.com/pascalberger){target="_blank"} ## Reports in SARIF format @@ -32,6 +34,6 @@ Cake Issues recipes 3.1.0 are compatible with version 3.x without any breaking c To update to the new version bump the version in your build. [full release notes]: https://github.com/cake-contrib/Cake.Issues.Recipe/releases/tag/3.1.0 -[Report parameters]: /docs/recipe/configuration#report-creation +[Report parameters]: ../../documentation/recipe/configuration.md#report-creation [SARIF format]: https://sarifweb.azurewebsites.net/ [SARIF SAST Scans Tab extension]: https://marketplace.visualstudio.com/items?itemName=sariftools.scans diff --git a/docs/input/docs/contributing/how-to-build.md b/docs/docs/documentation/contributing/how-to-build.md similarity index 55% rename from docs/input/docs/contributing/how-to-build.md rename to docs/docs/documentation/contributing/how-to-build.md index 0e256a7e2..a9100d7b2 100644 --- a/docs/input/docs/contributing/how-to-build.md +++ b/docs/docs/documentation/contributing/how-to-build.md @@ -1,8 +1,8 @@ --- -Order: 30 -Title: How to build addins -Description: Instructions how to build individual Cake Issues addins. +title: How to build addins +description: Instructions how to build individual Cake Issues addins. --- + To build this a package we are using Cake. On Windows PowerShell run: @@ -14,4 +14,5 @@ On Windows PowerShell run: On OSX/Linux run: ```bash -./build.sh \ No newline at end of file +./build.sh +``` diff --git a/docs/input/docs/contributing/how-to-contribute.md b/docs/docs/documentation/contributing/how-to-contribute.md similarity index 69% rename from docs/input/docs/contributing/how-to-contribute.md rename to docs/docs/documentation/contributing/how-to-contribute.md index 8004ea3dd..52db0222f 100644 --- a/docs/input/docs/contributing/how-to-contribute.md +++ b/docs/docs/documentation/contributing/how-to-contribute.md @@ -1,8 +1,8 @@ --- -Order: 10 -Title: How to contribute -Description: Instructions how to contribute to Cake Issues addins. +title: How to contribute +description: Instructions how to contribute to Cake Issues addins. --- + The repositories are using [GitFlow] with default configuration. Development is happening on `develop` branch. @@ -16,4 +16,4 @@ To contribute: For getting started see issues marked with `Up-for-grabs` in the individual repositories. -[GitFlow]: (http://nvie.com/posts/a-successful-git-branching-model/) \ No newline at end of file +[GitFlow]: https://nvie.com/posts/a-successful-git-branching-model/ diff --git a/docs/input/docs/contributing/how-to-release.md b/docs/docs/documentation/contributing/how-to-release.md similarity index 53% rename from docs/input/docs/contributing/how-to-release.md rename to docs/docs/documentation/contributing/how-to-release.md index fd8031546..6ff7b63a7 100644 --- a/docs/input/docs/contributing/how-to-release.md +++ b/docs/docs/documentation/contributing/how-to-release.md @@ -1,8 +1,8 @@ --- -Order: 40 -Title: How to release addins -Description: Instructions how to release individual Cake Issues addins. +title: How to release addins +description: Instructions how to release individual Cake Issues addins. --- + See [Cake.Recipe documentation] how to create a new release of this addin. -[Cake.Recipe documentation]: https://cake-contrib.github.io/Cake.Recipe/docs/usage/creating-release \ No newline at end of file +[Cake.Recipe documentation]: https://cake-contrib.github.io/Cake.Recipe/docs/usage/creating-release diff --git a/docs/docs/documentation/extending/fundamentals.md b/docs/docs/documentation/extending/fundamentals.md new file mode 100644 index 000000000..ccc3a991a --- /dev/null +++ b/docs/docs/documentation/extending/fundamentals.md @@ -0,0 +1,10 @@ +--- +title: Fundamentals +description: Fundamentals to extend Cake Issues ecosystem. +--- + +You can easily extend Cake Issues with additional [Issue Provider], [Report Formats] and [Pull Request System integrations]. + +[Issue Provider]: issue-provider/overview.md +[Report Formats]: report-format/overview.md +[Pull Request System integrations]: pull-request-system/overview.md \ No newline at end of file diff --git a/docs/docs/documentation/extending/index.md b/docs/docs/documentation/extending/index.md new file mode 100644 index 000000000..d8d0c3b46 --- /dev/null +++ b/docs/docs/documentation/extending/index.md @@ -0,0 +1,4 @@ +--- +title: Extending +description: Instructions how to add support for additional analyzers, report formats and pull request system to the Cake Issues Addin. +--- diff --git a/docs/docs/documentation/extending/issue-provider/categories.md b/docs/docs/documentation/extending/issue-provider/categories.md new file mode 100644 index 000000000..828617af6 --- /dev/null +++ b/docs/docs/documentation/extending/issue-provider/categories.md @@ -0,0 +1,21 @@ +--- +title: Alias categories +description: Instructions how to set the alias category. +--- + +Issue provider aliases should use the [IssuesAliasConstants.MainCakeAliasCategory](https://cakebuild.net/api/Cake.Issues/IssuesAliasConstants/41CCADF8){target="_blank"} +and [IssuesAliasConstants.IssueProviderCakeAliasCategory](https://cakebuild.net/api/Cake.Issues/IssuesAliasConstants/D265B28D){target="_blank"} +constants for defining their category: + +```csharp +[CakeAliasCategory(IssuesAliasConstants.MainCakeAliasCategory)] +public static class MyIssueProviderAliases +{ + [CakeMethodAlias] + [CakeAliasCategory(IssuesAliasConstants.IssueProviderCakeAliasCategory)] + public static IIssueProvider MyIssueProvider( + this ICakeContext context) + { + } +} +``` diff --git a/docs/input/docs/extending/issue-provider/helper.md b/docs/docs/documentation/extending/issue-provider/helper.md similarity index 56% rename from docs/input/docs/extending/issue-provider/helper.md rename to docs/docs/documentation/extending/issue-provider/helper.md index e2c4e3b1c..6e444efe3 100644 --- a/docs/input/docs/extending/issue-provider/helper.md +++ b/docs/docs/documentation/extending/issue-provider/helper.md @@ -1,16 +1,16 @@ --- -Order: 50 -Title: Helper -Description: Overview of different helper classes for implementing issue providers. +title: Helper +description: Overview of different helper classes for implementing issue providers. --- + The following helpers are provider by `Cake.Issues` for simplifying implementation of issue providers: -| Helper | Description | -|--------------------------|--------------------------------------------------------------------------------| -| [StringPathExtensions] | Extensions for string for handling paths. | -| [ByteArrayExtensions] | Extensions for converting between strings an byte arrays. | +| Helper | Description | +|------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------| +| [StringPathExtensions](https://cakebuild.net/api/Cake.Issues/StringPathExtensions/){target="_blank"} | Extensions for string for handling paths. | +| [ByteArrayExtensions](https://cakebuild.net/api/Cake.Issues/ByteArrayExtensions/){target="_blank"} | Extensions for converting between strings an byte arrays. | -# File linking +## File linking Cake.Issues provides infrastructure to get links to files on source code hosts like GitHub or Azure Repos. This infrastructure can be used inside issue providers to generate file links which can be used inside the issue messages: @@ -44,6 +44,3 @@ protected override IEnumerable InternalReadIssues() return result; } ``` - -[StringPathExtensions]: ../../../api/Cake.Issues/StringPathExtensions/ -[ByteArrayExtensions]: ../../../api/Cake.Issues/ByteArrayExtensions/ \ No newline at end of file diff --git a/docs/docs/documentation/extending/issue-provider/overview.md b/docs/docs/documentation/extending/issue-provider/overview.md new file mode 100644 index 000000000..3a9925425 --- /dev/null +++ b/docs/docs/documentation/extending/issue-provider/overview.md @@ -0,0 +1,21 @@ +--- +title: Overview +description: Overview how to implement support for an analyzer or linter. +--- + +Issue providers need to implement the [IIssueProvider](https://cakebuild.net/api/Cake.Issues/IIssueProvider/){target="_blank"} +interface. + +## Base classes + +For simplifying implementation there exists base classes from which concrete implementation can be inherited. + +| Base Class | Use case | Tutorial | +|--------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------|-------------------------------------| +| [BaseIssueProvider](https://cakebuild.net/api/Cake.Issues/BaseIssueProvider/){target="_blank"} | Base class for a simple issue provider implementation. | [Simple provider] | +| [BaseConfigurableIssueProvider](https://cakebuild.net/api/Cake.Issues/BaseConfigurableIssueProvider_1/){target="_blank"} | Base class for a issue provider with issue provider specific settings. | [Provider settings] | +| [BaseMultiFormatIssueProvider](https://cakebuild.net/api/Cake.Issues/BaseMultiFormatIssueProvider_2/){target="_blank"} | Base class for issue providers supporting multiple log formats. | [Multiple log file formats support] | + +[Simple provider]: tutorials/simple.md +[Provider settings]: tutorials/settings.md +[Multiple log file formats support]: tutorials/logfile-format.md diff --git a/docs/input/docs/extending/issue-provider/tutorials/logfile-format.md b/docs/docs/documentation/extending/issue-provider/tutorials/logfile-format.md similarity index 87% rename from docs/input/docs/extending/issue-provider/tutorials/logfile-format.md rename to docs/docs/documentation/extending/issue-provider/tutorials/logfile-format.md index 2bbd0d283..b9f671672 100644 --- a/docs/input/docs/extending/issue-provider/tutorials/logfile-format.md +++ b/docs/docs/documentation/extending/issue-provider/tutorials/logfile-format.md @@ -1,16 +1,18 @@ --- -Order: 30 -Title: Multiple log file formats -Description: Instructions how to implement an issue provider with support for multiple log file formats. +title: Multiple log file formats +description: Instructions how to implement an issue provider with support for multiple log file formats. --- + A single issue provider might support reading issues from multiple different log file formats. -For these cases the `Cake.Issue` addin provides the [BaseMultiFormatIssueProvider], [BaseMultiFormatIssueProviderSettings] -and [BaseLogFileFormat] classes for simplifying implementation in the issue provider addin. +For these cases the `Cake.Issue` addin provides the [BaseMultiFormatIssueProvider](https://cakebuild.net/api/Cake.Issues/BaseMultiFormatIssueProvider_2/){target="_blank"}, +[BaseMultiFormatIssueProviderSettings](https://cakebuild.net/api/Cake.Issues/BaseMultiFormatIssueProviderSettings_2/){target="_blank"} +and [BaseLogFileFormat](https://cakebuild.net/api/Cake.Issues/BaseLogFileFormat_2/){target="_blank"} +classes for simplifying implementation in the issue provider addin. -# Implementing issue provider +## Implementing issue provider -A concrete class inheriting from [BaseMultiFormatIssueProvider] needs to be implemented defining the -concrete types. +A concrete class inheriting from [BaseMultiFormatIssueProvider](https://cakebuild.net/api/Cake.Issues/BaseMultiFormatIssueProvider_2/){target="_blank"} +needs to be implemented defining the concrete types. ```csharp /// @@ -33,8 +35,8 @@ public class MyIssuesProvider : BaseMultiFormatIssueProvider @@ -92,7 +94,7 @@ public abstract class MyLogFileFormat : BaseLogFileFormat @@ -51,7 +55,8 @@ internal class MyRuleUrlResolver : BaseUrlResolver } ``` -To use the URL resolver the [ResolveRuleUrl] method needs to be called: +To use the URL resolver the [ResolveRuleUrl](https://cakebuild.net/api/Cake.Issues/BaseRuleUrlResolver_1/6B23EC74){target="_blank"} +method needs to be called: ```csharp var resolver = new MyRuleUrlResolver(); @@ -84,10 +89,10 @@ internal class MyRuleUrlResolver : BaseUrlResolver } ``` -# Support custom URL resolvers +## Support custom URL resolvers -The [AddUrlResolver] method can also be called from an Cake alias to allow users of the addin to -register custom resolvers. +The [AddUrlResolver](https://cakebuild.net/api/Cake.Issues/BaseRuleUrlResolver_1/AAA4FB20){target="_blank"} +method can also be called from an Cake alias to allow users of the addin to register custom resolvers. For this the URL resolver class needs to be implemented as a singleton: ```csharp @@ -126,9 +131,3 @@ public static class MyIssueProviderAliases MyRuleUrlResolver.Instance.AddUrlResolver(resolver); } ``` - -[BaseRuleDescription]: ../../../../api/Cake.Issues/BaseRuleDescription/ -[BaseRuleUrlResolver]: ../../../../api/Cake.Issues/BaseRuleUrlResolver_1/ -[TryGetRuleDescription]: ../../../../api/Cake.Issues/BaseRuleUrlResolver_1/D9DB5D44 -[AddUrlResolver]: ../../../../api/Cake.Issues/BaseRuleUrlResolver_1/AAA4FB20 -[ResolveRuleUrl]: ../../../../api/Cake.Issues/BaseRuleUrlResolver_1/6B23EC74 \ No newline at end of file diff --git a/docs/input/docs/extending/issue-provider/tutorials/settings.md b/docs/docs/documentation/extending/issue-provider/tutorials/settings.md similarity index 89% rename from docs/input/docs/extending/issue-provider/tutorials/settings.md rename to docs/docs/documentation/extending/issue-provider/tutorials/settings.md index bafba5633..b94f5de62 100644 --- a/docs/input/docs/extending/issue-provider/tutorials/settings.md +++ b/docs/docs/documentation/extending/issue-provider/tutorials/settings.md @@ -1,16 +1,17 @@ --- -Order: 20 -Title: Provider settings -Description: Instructions how to implement an issue provider with specific settings. +title: Provider settings +description: Instructions how to implement an issue provider with specific settings. --- + Often issue providers require specific settings. -For these cases the `Cake.Issue` addin provides the [BaseConfigurableIssueProvider] and [IssueProviderSettings] classes +For these cases the `Cake.Issue` addin provides the [BaseConfigurableIssueProvider](https://cakebuild.net/api/Cake.Issues/BaseConfigurableIssueProvider_1/){target="_blank"} +and [IssueProviderSettings](https://cakebuild.net/api/Cake.Issues/IssueProviderSettings/){target="_blank"} classes for simplifying implementation in the issue provider addin. -# Implementing issue provider +## Implementing issue provider -A concrete class inheriting from [BaseConfigurableIssueProvider] needs to be implemented defining the -concrete settings class to use: +A concrete class inheriting from [BaseConfigurableIssueProvider](https://cakebuild.net/api/Cake.Issues/BaseConfigurableIssueProvider_1/){target="_blank"} +needs to be implemented defining the concrete settings class to use: ```csharp /// @@ -49,7 +50,8 @@ public class MyIssuesProvider : BaseConfigurableIssueProvider } ``` -Also a concrete class inheriting from [IssueProviderSettings] needs to be implemented. +Also a concrete class inheriting from [IssueProviderSettings](https://cakebuild.net/api/Cake.Issues/IssueProviderSettings/){target="_blank"} +needs to be implemented. Based on the capabilities of the issue provider the appropriate constructors for reading from the file system or memory can be made public: @@ -83,7 +85,7 @@ public class MyIssuesSettings : IssueProviderSettings } ``` -# Aliases +## Aliases An alias for reading issues with the provider should be provided: @@ -200,6 +202,3 @@ public static string MyIssuesProviderTypeName( return typeof(MyIssuesProvider).FullName; } ``` - -[BaseConfigurableIssueProvider]: ../../../../api/Cake.Issues/BaseConfigurableIssueProvider_1/ -[IssueProviderSettings ]: ../../../../api/Cake.Issues/IssueProviderSettings/ \ No newline at end of file diff --git a/docs/input/docs/extending/issue-provider/tutorials/simple.md b/docs/docs/documentation/extending/issue-provider/tutorials/simple.md similarity index 84% rename from docs/input/docs/extending/issue-provider/tutorials/simple.md rename to docs/docs/documentation/extending/issue-provider/tutorials/simple.md index b84d429df..d6b2b156b 100644 --- a/docs/input/docs/extending/issue-provider/tutorials/simple.md +++ b/docs/docs/documentation/extending/issue-provider/tutorials/simple.md @@ -1,14 +1,16 @@ --- -Order: 10 -Title: Simple issue provider -Description: Instructions how to implement a simple issue provider. +title: Simple issue provider +description: Instructions how to implement a simple issue provider. --- -This tutorial explains how to implement a simple issue provider using the [BaseIssueProvider] class -from the `Cake.Issue` addin. -# Implementing issue provider +This tutorial explains how to implement a simple issue provider using the +[BaseIssueProvider](https://cakebuild.net/api/Cake.Issues/BaseIssueProvider/){target="_blank"} +class from the `Cake.Issue` addin. -A concrete class inheriting from [BaseIssueProvider] needs to be implemented: +## Implementing issue provider + +A concrete class inheriting from [BaseIssueProvider](https://cakebuild.net/api/Cake.Issues/BaseIssueProvider/){target="_blank"} +needs to be implemented: ```csharp /// @@ -46,7 +48,7 @@ public class MyIssuesProvider : BaseIssueProvider } ``` -# Aliases +## Aliases An alias for reading issues with the provider should be provided: @@ -96,5 +98,3 @@ public static string MyIssuesProviderTypeName( return typeof(MyIssuesProvider).FullName; } ``` - -[BaseIssueProvider]: ../../../../api/Cake.Issues/BaseIssueProvider/ \ No newline at end of file diff --git a/docs/input/docs/extending/pull-request-system/categories.md b/docs/docs/documentation/extending/pull-request-system/categories.md similarity index 51% rename from docs/input/docs/extending/pull-request-system/categories.md rename to docs/docs/documentation/extending/pull-request-system/categories.md index c375b8316..d303fc3c8 100644 --- a/docs/input/docs/extending/pull-request-system/categories.md +++ b/docs/docs/documentation/extending/pull-request-system/categories.md @@ -1,10 +1,11 @@ --- -Order: 30 -Title: Alias categories -Description: Instructions how to set the alias category. +title: Alias categories +description: Instructions how to set the alias category. --- -Pull request system aliases should use the [IssuesAliasConstants.MainCakeAliasCategory] and -[PullRequestsAliasConstants.PullRequestSystemCakeAliasCategory] constants for defining their category: + +Pull request system aliases should use the [IssuesAliasConstants.MainCakeAliasCategory](https://cakebuild.net/api/Cake.Issues/IssuesAliasConstants/41CCADF8){target="_blank"} +and [PullRequestsAliasConstants.PullRequestSystemCakeAliasCategory](https://cakebuild.net/api/Cake.Issues.PullRequests/PullRequestsAliasConstants/B4C013A1){target="_blank"} +constants for defining their category: ```csharp [CakeAliasCategory(IssuesAliasConstants.MainCakeAliasCategory)] @@ -18,6 +19,3 @@ public static class MyPullRequestSystemAliases } } ``` - -[IssuesAliasConstants.MainCakeAliasCategory]: ../../../api/Cake.Issues/IssuesAliasConstants/41CCADF8 -[PullRequestsAliasConstants.PullRequestSystemCakeAliasCategory]: ../../../api/Cake.Issues.PullRequests/PullRequestsAliasConstants/B4C013A1 \ No newline at end of file diff --git a/docs/docs/documentation/extending/pull-request-system/overview.md b/docs/docs/documentation/extending/pull-request-system/overview.md new file mode 100644 index 000000000..94f5f48bf --- /dev/null +++ b/docs/docs/documentation/extending/pull-request-system/overview.md @@ -0,0 +1,22 @@ +--- +title: Overview +description: Overview how to implement support for a pull request system. +--- + +Pull Request Systems need to implement the [IPullRequestSystem](https://cakebuild.net/api/Cake.Issues.PullRequests/IPullRequestSystem/){target="_blank"} +interface. + +## BaseClasses + +For simplifying implementation there exists base classes from which concrete implementation can be inherited. +[BasePullRequestSystem](https://cakebuild.net/api/Cake.Issues.PullRequests/BasePullRequestSystem/){target="_blank"} +is the main base class with the required functionality for a pull request system implementation. +Additionally there exists several classes which can be implemented to support additional optional capabilities +in a pull request system implementation. + +| Base Class | Use case | Tutorial | +|---------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|-------------------------------------| +| [BasePullRequestSystem](https://cakebuild.net/api/Cake.Issues.PullRequests/BasePullRequestSystem/){target="_blank"} | Base class for all pull request system implementations. | | +| [BaseCheckingCommitIdCapability](https://cakebuild.net/api/Cake.Issues.PullRequests/BaseCheckingCommitIdCapability_1/){target="_blank"} | Base class for capability to post issues only if pull request is for a specific commit. | | +| [BaseDiscussionThreadsCapability](https://cakebuild.net/api/Cake.Issues.PullRequests/BaseDiscussionThreadsCapability_1/){target="_blank"} | Base class for capability to read, resolve and reopen discussion threads. | | +| [BaseFilteringByModifiedFilesCapability](https://cakebuild.net/api/Cake.Issues.PullRequests/BaseFilteringByModifiedFilesCapability_1/){target="_blank"} | Base class for capability to filter issues to only those affecting files modified in the pull request. | | diff --git a/docs/docs/documentation/extending/report-format/categories.md b/docs/docs/documentation/extending/report-format/categories.md new file mode 100644 index 000000000..dc45d8ff7 --- /dev/null +++ b/docs/docs/documentation/extending/report-format/categories.md @@ -0,0 +1,21 @@ +--- +title: Alias categories +description: Instructions how to set the alias category. +--- + +Report format aliases should use the [IssuesAliasConstants.MainCakeAliasCategory](https://cakebuild.net/api/Cake.Issues/IssuesAliasConstants/41CCADF8){target="_blank"} +and [ReportingAliasConstants.ReportingFormatCakeAliasCategory](https://cakebuild.net/api/Cake.Issues.Reporting/ReportingAliasConstants/979CDCAF){target="_blank"} +constants for defining their category: + +```csharp +[CakeAliasCategory(IssuesAliasConstants.MainCakeAliasCategory)] +public static class MyReportFormatAliases +{ + [CakeMethodAlias] + [CakeAliasCategory(ReportingAliasConstants.ReportingFormatCakeAliasCategory)] + public static IIssueReportFormat MyReportFormat( + this ICakeContext context) + { + } +} +``` diff --git a/docs/docs/documentation/extending/report-format/overview.md b/docs/docs/documentation/extending/report-format/overview.md new file mode 100644 index 000000000..752ae4f5b --- /dev/null +++ b/docs/docs/documentation/extending/report-format/overview.md @@ -0,0 +1,8 @@ +--- +title: Overview +description: Overview how to implement support for a report output format. +--- + +Report formats need to implement the [IIssueReportFormat](https://cakebuild.net/api/Cake.Issues.Reporting/IIssueReportFormat/){target="_blank"} interface. +For simplifying implementation there exists an abstract [IssueReportFormat](https://cakebuild.net/api/Cake.Issues.Reporting/IssueReportFormat/){target="_blank"} +base class from which concrete implementation can be inherited. diff --git a/docs/docs/documentation/extending/testing.md b/docs/docs/documentation/extending/testing.md new file mode 100644 index 000000000..3b6b60018 --- /dev/null +++ b/docs/docs/documentation/extending/testing.md @@ -0,0 +1,7 @@ +--- +title: Testing +description: Instructions how to write test cases for Cake Issues addins. +--- + +The `Cake.Issues.Testing` packages provides different helper classes for writing test cases +for issue provider, report format or pull request system addins. diff --git a/docs/input/docs/fundamentals/architecture.md b/docs/docs/documentation/fundamentals/architecture.md similarity index 89% rename from docs/input/docs/fundamentals/architecture.md rename to docs/docs/documentation/fundamentals/architecture.md index 3e8641927..8ea4d8258 100644 --- a/docs/input/docs/fundamentals/architecture.md +++ b/docs/docs/documentation/fundamentals/architecture.md @@ -1,6 +1,6 @@ --- -Order: 10 -Description: Architecture overview. +title: Architecture +description: Architecture overview. --- The Cake Issues addins are built in a modular architecture, allowing to easily @@ -16,6 +16,6 @@ The core consists of the following addins: | Cake.Issues.Reporting | Provides aliases for creating reports for issues. Support for different report formats can be provided through additional [report format] addins. | | Cake.Issues.PullRequests | Provides aliases for reporting issues as comments to pull requests. Support for different pull request systems can be provided through additional [pull request system] addins. | -[issue provider]: issue-provider -[report format]: report-format -[pull request system]: pull-request-system +[issue provider]: issue-provider.md +[report format]: report-format.md +[pull request system]: pull-request-system.md diff --git a/docs/input/docs/fundamentals/issue-provider.md b/docs/docs/documentation/fundamentals/issue-provider.md similarity index 75% rename from docs/input/docs/fundamentals/issue-provider.md rename to docs/docs/documentation/fundamentals/issue-provider.md index 170e2cc60..9f9032f25 100644 --- a/docs/input/docs/fundamentals/issue-provider.md +++ b/docs/docs/documentation/fundamentals/issue-provider.md @@ -1,12 +1,13 @@ --- -Order: 40 -Description: Overview about issue providers. +title: Issue Provider +description: Overview about issue providers. --- + Issue provider addins are responsible for providing the output of an analyzer or linter to the Cake Issues addin. See [Issue Provider] for a list of currently supported analyzers and linters. See [How to implement issue providers] for instruction on how to implement support for additional issue providers. -[Issue Provider]: ../../addins/issue-provider/ -[How to implement issue providers]: ../extending/issue-provider/ \ No newline at end of file +[Issue Provider]: ../issue-providers/index.md +[How to implement issue providers]: ../extending/issue-provider/overview.md diff --git a/docs/input/docs/fundamentals/overview.png b/docs/docs/documentation/fundamentals/overview.png similarity index 100% rename from docs/input/docs/fundamentals/overview.png rename to docs/docs/documentation/fundamentals/overview.png diff --git a/docs/input/docs/fundamentals/pull-request-system.md b/docs/docs/documentation/fundamentals/pull-request-system.md similarity index 71% rename from docs/input/docs/fundamentals/pull-request-system.md rename to docs/docs/documentation/fundamentals/pull-request-system.md index 2615a4bfb..e9f473e0e 100644 --- a/docs/input/docs/fundamentals/pull-request-system.md +++ b/docs/docs/documentation/fundamentals/pull-request-system.md @@ -1,7 +1,8 @@ --- -Order: 60 -Description: Overview about pull request system implementations. +title: Pull Request System +description: Overview about pull request system implementations. --- + Pull request addins implement specific Pull Request Systems and allow the Cake Issues addin to write found issues as comments to pull requests. @@ -10,5 +11,5 @@ See [Pull Request Systems] for a list of currently supported pull request system See [How to implement pull request systems] for instruction on how to implement support for additional pull request systems. -[Pull Request Systems]: ../../addins/pull-request-system/ -[How to implement pull request systems]: ../extending/pull-request-system/ +[Pull Request Systems]: ../pull-request-systems/index.md +[How to implement pull request systems]: ../extending/pull-request-system/overview.md diff --git a/docs/input/docs/fundamentals/recipe.md b/docs/docs/documentation/fundamentals/recipe.md similarity index 71% rename from docs/input/docs/fundamentals/recipe.md rename to docs/docs/documentation/fundamentals/recipe.md index 635cc08ac..414306743 100644 --- a/docs/input/docs/fundamentals/recipe.md +++ b/docs/docs/documentation/fundamentals/recipe.md @@ -1,9 +1,10 @@ --- -Order: 30 -Description: Pre-made recipe script. +title: Recipe +description: Pre-made recipe script. --- + Recipes are pre-made Cake scripts which you can use in your project specific Cake script to get you quickly up and running. See [Recipe] for detailed documentation of the available recipe for Cake.Issues. -[Recipe]: ../recipe/ \ No newline at end of file +[Recipe]: ../recipe/overview.md diff --git a/docs/input/docs/fundamentals/report-format.md b/docs/docs/documentation/fundamentals/report-format.md similarity index 61% rename from docs/input/docs/fundamentals/report-format.md rename to docs/docs/documentation/fundamentals/report-format.md index a5f0e806a..20d0b38b3 100644 --- a/docs/input/docs/fundamentals/report-format.md +++ b/docs/docs/documentation/fundamentals/report-format.md @@ -1,7 +1,8 @@ --- -Order: 50 -Description: Overview about report format implementations. +title: Report Format +description: Overview about report format implementations. --- + Report format addins implement specific report formats and allow the Cake Issues addin to create reports in the specific format. @@ -10,5 +11,5 @@ See [Report Formats] for a list of currently supported report formats. See [How to implement report format] for instruction on how to implement support for additional report formats. -[Report Formats]: ../../addins/report-format/ -[How to implement report format]: ../extending/report-format/ +[Report Formats]: ../report-formats/index.md +[How to implement report format]: ../extending/report-format/overview.md diff --git a/docs/input/docs/fundamentals/versioning.md b/docs/docs/documentation/fundamentals/versioning.md similarity index 55% rename from docs/input/docs/fundamentals/versioning.md rename to docs/docs/documentation/fundamentals/versioning.md index 23111623f..0e119588f 100644 --- a/docs/input/docs/fundamentals/versioning.md +++ b/docs/docs/documentation/fundamentals/versioning.md @@ -1,24 +1,21 @@ --- -Order: 20 -Description: Compatible versions. +title: Versioning +description: Compatible versions. --- + The core addins and all issue providers and pull request systems need to be build against a compatible core API. You can check the required dependencies in the release notes of the addin. This means that it's not possible to use a version of an issue provider build against `Cake.Issues` 1.0.0 together with a version of a pull request system build against `Cake.Issues` 2.0.0. -We use strict [semantic versioning]. +We use strict [semantic versioning](http://semver.org/){target="_blank"}. Therefore it's possible to use issue provider and pull request system built against `Cake.Issues` 1.0.0 together with `Cake.Issues` 1.1.0. -:::{.alert .alert-info} -Please note that versions below 1.0.0 are not considered stable and their API will break regularly. -Expect breaking changes in each minor version. - -Therefore we strongly advise to pin to specific versions of the addins to avoid breaking builds -once we update the addin. -::: - +!!! info + Please note that versions below 1.0.0 are not considered stable and their API will break regularly. + Expect breaking changes in each minor version. -[semantic versioning]: http://semver.org/ \ No newline at end of file + Therefore we strongly advise to pin to specific versions of the addins to avoid breaking builds + once we update the addin. diff --git a/docs/input/docs/issue-providers/docfx/examples.md b/docs/docs/documentation/issue-providers/docfx/examples.md similarity index 52% rename from docs/input/docs/issue-providers/docfx/examples.md rename to docs/docs/documentation/issue-providers/docfx/examples.md index bd2225cfb..00f2d7ee7 100644 --- a/docs/input/docs/issue-providers/docfx/examples.md +++ b/docs/docs/documentation/issue-providers/docfx/examples.md @@ -1,11 +1,13 @@ --- -Order: 30 -Title: Examples -Description: Examples for using the Cake.Issues.DocFx addin. +title: Examples +description: Examples for using the Cake.Issues.DocFx addin. --- -The following example will call [DocFx] to generate the documentation and outputs the number of warnings. -To call [DocFx] from a Cake script you can use the [Cake.DocFx] addin. +The following example will call [DocFx](https://dotnet.github.io/docfx/){target="_blank"} to +generate the documentation and outputs the number of warnings. + +To call [DocFx](https://dotnet.github.io/docfx/){target="_blank"} from a Cake script you can +use the [Cake.DocFx](https://cakebuild.net/extensions/cake-docfx/){target="_blank"} addin. ```csharp #addin "Cake.DocFx" @@ -18,12 +20,11 @@ To read issues from DocFx log files you need to import the core addin and the Do #addin "Cake.Issues.DocFx" ``` -:::{.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. +!!! 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. -::: + See [pinning addin versions](https://cakebuild.net/docs/writing-builds/reproducible-builds/){target="_blank"} for details. We need some global variables: @@ -33,7 +34,7 @@ var repoRootPath = @"c:\repo"; var docRootPath = @"docs"; ``` -The following task will build the [DocFx] project and write a log file: +The following task will build the [DocFx](https://dotnet.github.io/docfx/){target="_blank"} project and write a log file: ```csharp Task("Build-Documentation").Does(() => @@ -62,6 +63,3 @@ Task("Read-Issues") Information("{0} issues are found.", issues.Count()); }); ``` - -[DocFx]: https://dotnet.github.io/docfx/ -[Cake.DocFx]: https://www.nuget.org/packages/Cake.DocFx/ diff --git a/docs/docs/documentation/issue-providers/docfx/features.md b/docs/docs/documentation/issue-providers/docfx/features.md new file mode 100644 index 000000000..4de379006 --- /dev/null +++ b/docs/docs/documentation/issue-providers/docfx/features.md @@ -0,0 +1,39 @@ +--- +title: Features +description: Features of the Cake.Issues.DocFx addin. +--- + +The [Cake.Issues.DocFx addin](https://cakebuild.net/extensions/cake-issues-docfx/){target="_blank"} +provides the following features. + +## Basic features + +* Reads warnings from [DocFx](https://dotnet.github.io/docfx/){target="_blank"} log files. + +!!! info + [DocFx](https://dotnet.github.io/docfx/){target="_blank"} can be run with + [Cake.DocFx](https://cakebuild.net/extensions/cake-docfx/){target="_blank"} addin. + +## Supported IIssue properties + +| | Property | Remarks | +|------------------|-----------------------------------|---------------------------------| +| :material-check: | `IIssue.ProviderType` | | +| :material-check: | `IIssue.ProviderName` | | +| | `IIssue.Run` | Can be set while reading issues | +| :material-check: | `IIssue.Identifier` | Set to `IIssue.MessageText` | +| | `IIssue.ProjectName` | | +| | `IIssue.ProjectFileRelativePath` | | +| :material-check: | `IIssue.AffectedFileRelativePath` | | +| :material-check: | `IIssue.Line` | | +| | `IIssue.EndLine` | | +| | `IIssue.Column` | | +| | `IIssue.EndColumn` | | +| | `IIssue.FileLink` | Can be set while reading issues | +| :material-check: | `IIssue.MessageText` | | +| | `IIssue.MessageHtml` | | +| | `IIssue.MessageMarkdown` | | +| :material-check: | `IIssue.Priority` | | +| :material-check: | `IIssue.PriorityName` | | +| :material-check: | `IIssue.Rule` | | +| :material-check: | `IIssue.RuleUrl` | | diff --git a/docs/docs/documentation/issue-providers/docfx/index.md b/docs/docs/documentation/issue-providers/docfx/index.md new file mode 100644 index 000000000..764fc8fbd --- /dev/null +++ b/docs/docs/documentation/issue-providers/docfx/index.md @@ -0,0 +1,7 @@ +--- +title: DocFx +description: Issue provider which allows you to read warnings logged by DocFx. +--- + +Support for reading warnings reported by [DocFx](https://dotnet.github.io/docfx/){target="_blank"} is implemented in the +[Cake.Issues.DocFx addin](https://cakebuild.net/extensions/cake-issues-docfx/){target="_blank"}. diff --git a/docs/docs/documentation/issue-providers/eslint/features.md b/docs/docs/documentation/issue-providers/eslint/features.md new file mode 100644 index 000000000..6718c1038 --- /dev/null +++ b/docs/docs/documentation/issue-providers/eslint/features.md @@ -0,0 +1,42 @@ +--- +title: Features +description: Features of the Cake.Issues.EsLint addin. +--- + +The [Cake.Issues.EsLint addin](https://cakebuild.net/extensions/cake-issues-eslint/){target="_blank"} provides the following features. + +## Basic features + +* Reads issues reported by ESLint. +* Provides URLs for all issues. +* Support for custom URL resolving using the [EsLintAddRuleUrlResolver](https://cakebuild.net/api/Cake.Issues.EsLint/EsLintIssuesAliases/0F6CCE21){target="_blank"} + alias. + +## Supported log file formats + +* [EsLintJsonFormat](https://cakebuild.net/api/Cake.Issues.EsLint/EsLintIssuesAliases/230C6E27){target="_blank"} + alias for reading issues from log files created by + [ESLint json formatter](https://eslint.org/docs/user-guide/formatters/#json){target="_blank"}. + +## Supported IIssue properties + +| | Property | Remarks | +|------------------|-----------------------------------|---------------------------------| +| :material-check: | `IIssue.ProviderType` | | +| :material-check: | `IIssue.ProviderName` | | +| | `IIssue.Run` | Can be set while reading issues | +| :material-check: | `IIssue.Identifier` | Set to `IIssue.MessageText` | +| | `IIssue.ProjectName` | | +| | `IIssue.ProjectFileRelativePath` | | +| :material-check: | `IIssue.AffectedFileRelativePath` | | +| :material-check: | `IIssue.Line` | | +| | `IIssue.EndLine` | | +| :material-check: | `IIssue.Column` | | +| | `IIssue.EndColumn` | | +| :material-check: | `IIssue.MessageText` | | +| | `IIssue.MessageHtml` | | +| | `IIssue.MessageMarkdown` | | +| :material-check: | `IIssue.Priority` | | +| :material-check: | `IIssue.PriorityName` | | +| :material-check: | `IIssue.Rule` | | +| :material-check: | `IIssue.RuleUrl` | Support for custom rules can be added through a custom [EsLintAddRuleUrlResolver](https://cakebuild.net/api/Cake.Issues.EsLint/EsLintIssuesAliases/0F6CCE21){target="_blank"} | diff --git a/docs/docs/documentation/issue-providers/eslint/index.md b/docs/docs/documentation/issue-providers/eslint/index.md new file mode 100644 index 000000000..a233ea84a --- /dev/null +++ b/docs/docs/documentation/issue-providers/eslint/index.md @@ -0,0 +1,7 @@ +--- +title: ESLint +description: Issue provider which allows you to read issues logged by ESLint. +--- + +Support for reading issues reported by [ESLint](https://eslint.org/){target="_blank"} +is implemented in the [Cake.Issues.EsLint addin](https://cakebuild.net/extensions/cake-issues-eslint/){target="_blank"}. diff --git a/docs/input/docs/issue-providers/gitrepository/examples.md b/docs/docs/documentation/issue-providers/gitrepository/examples.md similarity index 53% rename from docs/input/docs/issue-providers/gitrepository/examples.md rename to docs/docs/documentation/issue-providers/gitrepository/examples.md index 28c116f38..d055e4159 100644 --- a/docs/input/docs/issue-providers/gitrepository/examples.md +++ b/docs/docs/documentation/issue-providers/gitrepository/examples.md @@ -1,13 +1,14 @@ --- -Order: 30 -Title: Examples -Description: Examples for using the Cake.Issues.GitRepository addin. +title: Examples +description: Examples for using the Cake.Issues.GitRepository addin. --- -The following example prints the number of binary files which are not tracked by [Git Large File Storage] in a repository. -:::{.alert .alert-warning} -Checking binary files requires Git and [Git Large File Storage] available on the local machine. -::: +The following example prints the number of binary files which are not tracked by +[Git Large File Storage](https://git-lfs.github.com/){target="_blank"} in a repository. + +!!! warning + Checking binary files requires Git and [Git Large File Storage](https://git-lfs.github.com/){target="_blank"} + available on the local machine. To analyze Git repositories you need to import the core addin and the Git repository support: @@ -16,12 +17,11 @@ To analyze Git repositories you need to import the core addin and the Git reposi #addin "Cake.Issues.GitRepository" ``` -:::{.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. +!!! 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. -::: + See [pinning addin versions](https://cakebuild.net/docs/writing-builds/reproducible-builds/){target="_blank"} for details. We need some global variables: @@ -50,5 +50,3 @@ Task("Analyze-Repo") Information("{0} issues are found.", issues.Count()); }); ``` - -[Git Large File Storage]: https://git-lfs.github.com/ \ No newline at end of file diff --git a/docs/docs/documentation/issue-providers/gitrepository/features.md b/docs/docs/documentation/issue-providers/gitrepository/features.md new file mode 100644 index 000000000..a108b8f41 --- /dev/null +++ b/docs/docs/documentation/issue-providers/gitrepository/features.md @@ -0,0 +1,39 @@ +--- +title: Features +description: Features of the Cake.Issues.GitRepository addin. +--- + +The [Cake.Issues.GitRepository addin](https://cakebuild.net/extensions/cake-issues-gitrepository/){target="_blank"} +provides the following features. + +## Basic features + +* Checks path length of files. See [FilePathTooLong] for details. +* Checks if binary files are tracked by Git LFS. See [BinaryFileNotTrackedByLfs] for details. + +## Supported IIssue properties + +| | Property | Remarks | +|------------------|-----------------------------------|---------------------------------| +| :material-check: | `IIssue.ProviderType` | | +| :material-check: | `IIssue.ProviderName` | | +| | `IIssue.Run` | Can be set while reading issues | +| :material-check: | `IIssue.Identifier` | Set to `IIssue.MessageText` | +| | `IIssue.ProjectName` | | +| | `IIssue.ProjectFileRelativePath` | | +| :material-check: | `IIssue.AffectedFileRelativePath` | | +| | `IIssue.Line` | | +| | `IIssue.EndLine` | | +| | `IIssue.Column` | | +| | `IIssue.EndColumn` | | +| | `IIssue.FileLink` | Can be set while reading issues | +| :material-check: | `IIssue.MessageText` | | +| :material-check: | `IIssue.MessageHtml` | | +| :material-check: | `IIssue.MessageMarkdown` | | +| :material-check: | `IIssue.Priority` | | +| :material-check: | `IIssue.PriorityName` | | +| :material-check: | `IIssue.Rule` | | +| :material-check: | `IIssue.RuleUrl` | | + +[FilePathTooLong]: rules/FilePathTooLong.md +[BinaryFileNotTrackedByLfs]: rules/BinaryFileNotTrackedByLfs.md diff --git a/docs/docs/documentation/issue-providers/gitrepository/index.md b/docs/docs/documentation/issue-providers/gitrepository/index.md new file mode 100644 index 000000000..897680de1 --- /dev/null +++ b/docs/docs/documentation/issue-providers/gitrepository/index.md @@ -0,0 +1,7 @@ +--- +title: Git Repository +description: Issue provider which allows you to analyzing Git repositories and create issues resulting from it. +--- + +Support for analyzing Git repositories is implemented in the +[Cake.Issues.GitRepository addin](https://cakebuild.net/extensions/cake-issues-gitrepository/){target="_blank"}. diff --git a/docs/docs/documentation/issue-providers/gitrepository/rules/BinaryFileNotTrackedByLfs.md b/docs/docs/documentation/issue-providers/gitrepository/rules/BinaryFileNotTrackedByLfs.md new file mode 100644 index 000000000..acafd93a5 --- /dev/null +++ b/docs/docs/documentation/issue-providers/gitrepository/rules/BinaryFileNotTrackedByLfs.md @@ -0,0 +1,28 @@ +--- +title: BinaryFileNotTrackedByLfs +description: A binary file is not tracked by Git LFS. +--- + +| Metadata | | +|--------------|---------------------------| +| Rule Id | BinaryFileNotTrackedByLfs | +| Priority | Warning | +| Available in | 0.7.0 or higher | + +## Cause + +A binary file in the repository is not tracked by [Git Large File Storage](https://git-lfs.github.com/){target="_blank"}. + +## 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 Storage](https://git-lfs.github.com/){target="_blank"} replaces large files with small text pointers inside the Git repository, while storing the file contents on a remote server. + +!!! 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 Storage](https://git-lfs.github.com/){target="_blank"}. diff --git a/docs/input/docs/issue-providers/gitrepository/rules/FilePathTooLong.md b/docs/docs/documentation/issue-providers/gitrepository/rules/FilePathTooLong.md similarity index 58% rename from docs/input/docs/issue-providers/gitrepository/rules/FilePathTooLong.md rename to docs/docs/documentation/issue-providers/gitrepository/rules/FilePathTooLong.md index e3eb20e67..ac7dfb3db 100644 --- a/docs/input/docs/issue-providers/gitrepository/rules/FilePathTooLong.md +++ b/docs/docs/documentation/issue-providers/gitrepository/rules/FilePathTooLong.md @@ -1,15 +1,13 @@ --- -Title: FilePathTooLong -Description: The path of a file is too long. +title: FilePathTooLong +description: The path of a file is too long. --- - - - +| Metadata | | +|--------------|-----------------| +| Rule Id | FilePathTooLong | +| Priority | Warning | +| Available in | 0.7.3 or higher | ## Cause diff --git a/docs/docs/documentation/issue-providers/index.md b/docs/docs/documentation/issue-providers/index.md new file mode 100644 index 000000000..66eff4003 --- /dev/null +++ b/docs/docs/documentation/issue-providers/index.md @@ -0,0 +1,4 @@ +--- +title: Issue Providers +description: Documentation of the different issue provider addins. +--- diff --git a/docs/input/docs/issue-providers/inspectcode/examples.md b/docs/docs/documentation/issue-providers/inspectcode/examples.md similarity index 76% rename from docs/input/docs/issue-providers/inspectcode/examples.md rename to docs/docs/documentation/issue-providers/inspectcode/examples.md index 5d9dbaf9e..2e535381e 100644 --- a/docs/input/docs/issue-providers/inspectcode/examples.md +++ b/docs/docs/documentation/issue-providers/inspectcode/examples.md @@ -1,8 +1,8 @@ --- -Order: 30 -Title: Examples -Description: Examples for using the Cake.Issues.InspectCode addin. +title: Examples +description: Examples for using the Cake.Issues.InspectCode addin. --- + The following example will call [JetBrains InspectCode] and output the number of warnings. To call [JetBrains InspectCode] from a Cake script you need to add the `JetBrains.ReSharper.CommandLineTools`: @@ -18,12 +18,11 @@ To read issues from InspectCode log files you need to import the core addin and #addin "Cake.Issues.InspectCode" ``` -:::{.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. +!!! 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. -::: + See [pinning addin versions](https://cakebuild.net/docs/writing-builds/reproducible-builds/){target="_blank"} for details. We need some global variables: diff --git a/docs/docs/documentation/issue-providers/inspectcode/features.md b/docs/docs/documentation/issue-providers/inspectcode/features.md new file mode 100644 index 000000000..d04c5170e --- /dev/null +++ b/docs/docs/documentation/issue-providers/inspectcode/features.md @@ -0,0 +1,38 @@ +--- +title: Features +description: Features of the Cake.Issues.InspectCode addin. +--- + +The [Cake.Issues.InspectCode addin] provides the following features: + +## Basic features + +* Reads warnings from [JetBrains InsepectCode] log files. +* Provides URLs for issues containing a Wiki URL. + +## Supported IIssue properties + +| | Property | Remarks | +|------------------|-----------------------------------|----------------------------------| +| :material-check: | `IIssue.ProviderType` | | +| :material-check: | `IIssue.ProviderName` | | +| | `IIssue.Run` | Can be set while reading issues | +| :material-check: | `IIssue.Identifier` | Set to `IIssue.MessageText` | +| :material-check: | `IIssue.ProjectName` | | +| | `IIssue.ProjectFileRelativePath` | | +| :material-check: | `IIssue.AffectedFileRelativePath` | | +| :material-check: | `IIssue.Line` | | +| | `IIssue.EndLine` | | +| | `IIssue.Column` | | +| | `IIssue.EndColumn` | | +| | `IIssue.FileLink` | Can be set while reading issues | +| :material-check: | `IIssue.MessageText` | | +| | `IIssue.MessageHtml` | | +| | `IIssue.MessageMarkdown` | | +| :material-check: | `IIssue.Priority` | | +| :material-check: | `IIssue.PriorityName` | | +| :material-check: | `IIssue.Rule` | | +| :material-check: | `IIssue.RuleUrl` | For issues containing a Wiki Url | + +[JetBrains InsepectCode]: https://www.jetbrains.com/help/resharper/2017.1/InspectCode.html +[Cake.Issues.InspectCode addin]: https://www.nuget.org/packages/Cake.Issues.InspectCode diff --git a/docs/docs/documentation/issue-providers/inspectcode/index.md b/docs/docs/documentation/issue-providers/inspectcode/index.md new file mode 100644 index 000000000..41d8d068e --- /dev/null +++ b/docs/docs/documentation/issue-providers/inspectcode/index.md @@ -0,0 +1,7 @@ +--- +title: InspectCode +description: Issue provider which allows you to read issues logged by JetBrains Inspect Code. +--- + +Support for reading issues reported by [JetBrains Inspect Code](https://www.jetbrains.com/help/resharper/2017.1/InspectCode.html) +is implemented in the [Cake.Issues.InspectCode addin](https://www.nuget.org/packages/Cake.Issues.InspectCode). diff --git a/docs/input/docs/issue-providers/markdownlint/examples.md b/docs/docs/documentation/issue-providers/markdownlint/examples.md similarity index 79% rename from docs/input/docs/issue-providers/markdownlint/examples.md rename to docs/docs/documentation/issue-providers/markdownlint/examples.md index b81ddec24..02e9c56ec 100644 --- a/docs/input/docs/issue-providers/markdownlint/examples.md +++ b/docs/docs/documentation/issue-providers/markdownlint/examples.md @@ -1,8 +1,8 @@ --- -Order: 30 -Title: Examples -Description: Examples for using the Cake.Issues.Markdownlint addin. +title: Examples +description: Examples for using the Cake.Issues.Markdownlint addin. --- + The following example will call [markdownlint-cli] to lint some markdown files and outputs the number of warnings. To call [markdownlint-cli] from a Cake script you can use the [Cake.Markdownlint] addin. @@ -18,12 +18,11 @@ To read issues from markdownlint-cli log files you need to import the core addin #addin "Cake.Issues.Markdownlint" ``` -:::{.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. +!!! 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. -::: + See [pinning addin versions](https://cakebuild.net/docs/writing-builds/reproducible-builds/){target="_blank"} for details. We need some global variables: diff --git a/docs/docs/documentation/issue-providers/markdownlint/features.md b/docs/docs/documentation/issue-providers/markdownlint/features.md new file mode 100644 index 000000000..82418f14e --- /dev/null +++ b/docs/docs/documentation/issue-providers/markdownlint/features.md @@ -0,0 +1,54 @@ +--- +title: Features +description: Features of the Cake.Issues.Markdownlint addin. +--- + +The [Cake.Issues.Markdownlint addin](https://cakebuild.net/extensions/cake-issues-markdownlint/){target="_blank"} +provides the following features. + +## Basic features + +* Reads warnings from [Markdownlint](https://github.com/DavidAnson/markdownlint){target="_blank"} logfiles. +* Provides URLs for all issues. +* Support for custom URL resolving using the [MarkdownlintAddRuleUrlResolver](https://cakebuild.net/api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/2EE35F55){target="_blank"} + alias (except for [MarkdownlintCliJsonLogFileFormat](https://cakebuild.net/api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/36DE6F5F){target="_blank"}). + +## Supported log file formats + +* [MarkdownlintV1LogFileFormat](https://cakebuild.net/api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/65609BEB){target="_blank"} + alias for reading issues from [Markdownlint](https://github.com/DavidAnson/markdownlint){target="_blank"} + output generated with `options.resultVersion` set to 1. +* [MarkdownlintCliLogFileFormat](https://cakebuild.net/api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/B518F49E){target="_blank"} + alias for reading issues from [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli){target="_blank"} log files. +* [MarkdownlintCliJsonLogFileFormat](https://cakebuild.net/api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/36DE6F5F){target="_blank"} + alias for reading issues from [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli){target="_blank"} + log files created with the `--json` parameter. + +!!! tip + [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli){target="_blank"} + can be run with the [Cake.Markdownlint](https://cakebuild.net/extensions/cake-markdownlint/){target="_blank"} + addin. + +## Supported IIssue properties + +| | Property | Remarks | +|------------------|-----------------------------------|-----------------------------------------| +| :material-check: | `IIssue.ProviderType` | | +| :material-check: | `IIssue.ProviderName` | | +| | `IIssue.Run` | Can be set while reading issues | +| :material-check: | `IIssue.Identifier` | Set to `IIssue.MessageText` | +| | `IIssue.ProjectName` | | +| | `IIssue.ProjectFileRelativePath` | | +| :material-check: | `IIssue.AffectedFileRelativePath` | | +| :material-check: | `IIssue.Line` | | +| | `IIssue.EndLine` | | +| :material-check: | `IIssue.Column` | Only for [MarkdownlintCliLogFileFormat](https://cakebuild.net/api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/B518F49E){target="_blank"} | +| | `IIssue.EndColumn` | | +| | `IIssue.FileLink` | Can be set while reading issues | +| :material-check: | `IIssue.MessageText` | | +| | `IIssue.MessageHtml` | | +| | `IIssue.MessageMarkdown` | | +| :material-check: | `IIssue.Priority` | Always [IssuePriority.Warning](https://cakebuild.net/api/Cake.Issues/IssuePriority/7A0CE07F){target="_blank"} | +| :material-check: | `IIssue.PriorityName` | Always `Warning` | +| :material-check: | `IIssue.Rule` | | +| :material-check: | `IIssue.RuleUrl` | Support for custom rules can be added through a custom [MarkdownlintAddRuleUrlResolver](https://cakebuild.net/api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/2EE35F55){target="_blank"} except for [MarkdownlintCliJsonLogFileFormat](https://cakebuild.net/api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/36DE6F5F){target="_blank"} | diff --git a/docs/docs/documentation/issue-providers/markdownlint/index.md b/docs/docs/documentation/issue-providers/markdownlint/index.md new file mode 100644 index 000000000..a47bf5b78 --- /dev/null +++ b/docs/docs/documentation/issue-providers/markdownlint/index.md @@ -0,0 +1,7 @@ +--- +title: markdownlint +description: Issue provider which allows you to read issues logged by markdownlint. +--- + +Support for reading issues reported by [markdownlint](https://github.com/DavidAnson/markdownlint) +is implemented in the [Cake.Issues.Markdownlint addin](https://www.nuget.org/packages/Cake.Issues.Markdownlint). diff --git a/docs/input/docs/issue-providers/msbuild/examples.md b/docs/docs/documentation/issue-providers/msbuild/examples.md similarity index 81% rename from docs/input/docs/issue-providers/msbuild/examples.md rename to docs/docs/documentation/issue-providers/msbuild/examples.md index b00940182..2c9154a57 100644 --- a/docs/input/docs/issue-providers/msbuild/examples.md +++ b/docs/docs/documentation/issue-providers/msbuild/examples.md @@ -1,8 +1,8 @@ --- -Order: 30 -Title: Examples -Description: Examples for using the Cake.Issues.MsBuild addin. +title: Examples +description: Examples for using the Cake.Issues.MsBuild addin. --- + The following example will call MsBuild to build the solution and outputs the number of warnings. To read issues from MsBuild log files you need to import the core addin and the MsBuild support: @@ -19,12 +19,11 @@ In order to use the above logger, the following line will download and install t #tool "nuget:?package=MSBuild.Extension.Pack" ``` -:::{.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. +!!! 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. -::: + See [pinning addin versions](https://cakebuild.net/docs/writing-builds/reproducible-builds/){target="_blank"} for details. We need some global variables: diff --git a/docs/docs/documentation/issue-providers/msbuild/features.md b/docs/docs/documentation/issue-providers/msbuild/features.md new file mode 100644 index 000000000..b91eaece6 --- /dev/null +++ b/docs/docs/documentation/issue-providers/msbuild/features.md @@ -0,0 +1,42 @@ +--- +title: Features +description: Features of the Cake.Issues.MsBuild addin. +--- + +The [Cake.Issues.MsBuild addin](https://cakebuild.net/extensions/cake-issues-msbuild/){target="_blank"} +provides the following features. + +## Basic features + +* Reads errors and warnings from MSBuild log files. +* Provides URLs for all code analysis (`CA*`) and StyleCop (`SA*`) warnings. +* Support for custom URL resolving using the [MsBuildAddRuleUrlResolver](https://cakebuild.net/api/Cake.Issues.MsBuild/MsBuildIssuesAliases/93C21487){target="_blank"} alias. + +## Supported log file formats + +* [MsBuildBinaryLogFileFormat](https://cakebuild.net/api/Cake.Issues.MsBuild/MsBuildIssuesAliases/AD50C7E1){target="_blank"} alias for reading issues from binary log files. +* [MsBuildXmlFileLoggerFormat](https://cakebuild.net/api/Cake.Issues.MsBuild/MsBuildIssuesAliases/051D7B6E){target="_blank"} alias for reading issues from log files created by [MSBuild Extension Pack XmlFileLogger](https://github.com/mikefourie-zz/MSBuildExtensionPack/blob/master/Solutions/Main/Loggers/Framework/XmlFileLogger.cs){target="_blank"}. + +## Supported IIssue properties + +| | Property | Remarks | +|------------------|-----------------------------------|---------------------------------------| +| :material-check: | `IIssue.ProviderType` | | +| :material-check: | `IIssue.ProviderName` | | +| | `IIssue.Run` | Can be set while reading issues | +| :material-check: | `IIssue.Identifier` | Set to `IIssue.MessageText` | +| :material-check: | `IIssue.ProjectName` | | +| :material-check: | `IIssue.ProjectFileRelativePath` | | +| :material-check: | `IIssue.AffectedFileRelativePath` | | +| :material-check: | `IIssue.Line` | | +| | `IIssue.EndLine` | | +| :material-check: | `IIssue.Column` | Only for [MsBuildXmlFileLoggerFormat](https://cakebuild.net/api/Cake.Issues.MsBuild/MsBuildIssuesAliases/051D7B6E){target="_blank"} | +| | `IIssue.EndColumn` | | +| | `IIssue.FileLink` | Can be set while reading issues | +| :material-check: | `IIssue.MessageText` | | +| | `IIssue.MessageHtml` | | +| | `IIssue.MessageMarkdown` | | +| :material-check: | `IIssue.Priority` | | +| :material-check: | `IIssue.PriorityName` | | +| :material-check: | `IIssue.Rule` | | +| :material-check: | `IIssue.RuleUrl` | For code analysis (`CA*`) and StyleCop (`SA*`) warnings. Support for additional rules can be added through a custom [MsBuildAddRuleUrlResolver](https://cakebuild.net/api/Cake.Issues.MsBuild/MsBuildIssuesAliases/93C21487){target="_blank"} | diff --git a/docs/docs/documentation/issue-providers/msbuild/index.md b/docs/docs/documentation/issue-providers/msbuild/index.md new file mode 100644 index 000000000..6a139dd47 --- /dev/null +++ b/docs/docs/documentation/issue-providers/msbuild/index.md @@ -0,0 +1,7 @@ +--- +title: MsBuild +description: Issue provider which allows you to read warnings logged by MsBuild. +--- + +Support for reading warnings reported by MsBuild is implemented in the +[Cake.Issues.MsBuild](https://www.nuget.org/packages/Cake.Issues.MsBuild). diff --git a/docs/docs/documentation/issue-providers/terraform/features.md b/docs/docs/documentation/issue-providers/terraform/features.md new file mode 100644 index 000000000..ce1361efc --- /dev/null +++ b/docs/docs/documentation/issue-providers/terraform/features.md @@ -0,0 +1,37 @@ +--- +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 | +|------------------|-----------------------------------|----------------------------------| +| :material-check: | `IIssue.ProviderType` | | +| :material-check: | `IIssue.ProviderName` | | +| | `IIssue.Run` | Can be set while reading issues | +| :material-check: | `IIssue.Identifier` | Set to `IIssue.MessageText` | +| | `IIssue.ProjectName` | | +| | `IIssue.ProjectFileRelativePath` | | +| :material-check: | `IIssue.AffectedFileRelativePath` | | +| :material-check: | `IIssue.Line` | | +| :material-check: | `IIssue.EndLine` | | +| :material-check: | `IIssue.Column` | | +| :material-check: | `IIssue.EndColumn` | | +| | `IIssue.FileLink` | Can be set while reading issues | +| :material-check: | `IIssue.MessageText` | | +| | `IIssue.MessageHtml` | | +| | `IIssue.MessageMarkdown` | | +| :material-check: | `IIssue.Priority` | | +| :material-check: | `IIssue.PriorityName` | | +| :material-check: | `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/docs/documentation/issue-providers/terraform/index.md b/docs/docs/documentation/issue-providers/terraform/index.md new file mode 100644 index 000000000..5d0982d3c --- /dev/null +++ b/docs/docs/documentation/issue-providers/terraform/index.md @@ -0,0 +1,7 @@ +--- +title: Terraform +description: Issue provider which allows you to read issues from Terraform validate command. +--- + +Support for reading issues reported by [Terraform validate command](https://www.terraform.io/docs/cli/commands/validate.html) +is implemented in the [Cake.Issues.Terraform addin](https://cakebuild.net/extensions/cake-issues-terraform/). diff --git a/docs/input/docs/overview/features.md b/docs/docs/documentation/overview/features.md similarity index 63% rename from docs/input/docs/overview/features.md rename to docs/docs/documentation/overview/features.md index cb1def00a..f7c82a6c5 100644 --- a/docs/input/docs/overview/features.md +++ b/docs/docs/documentation/overview/features.md @@ -1,42 +1,45 @@ --- -Order: 20 -Description: Overview about core features. +title: Features +description: Overview about core features. --- + The Cake Issues addins for Cake allows you to read issues from any analyzer or linter, create reports or write issues to comments in pull requests. -# Recipe Functionality +## Recipe Functionality See [Supported Tools] for a list of tools supported by [Cake.Issues.Recipe]. -# Supported Core Functionality +## Supported Core Functionality The core addins provide a modular architecture, allowing to easily enhance it for supporting additional analyzers, linters, report formats and code review systems. -## Cake.Issues +### Cake.Issues Addin for creating and reading issues providing the following functionality: -* [NewIssue] alias for creating issues in the build script. -* [ReadIssues] aliases for reading issues from an issue provider. +* [NewIssue](https://cakebuild.net/api/Cake.Issues/Aliases/5BAA8171){target="_blank"} alias for creating issues in the build script. +* [ReadIssues](https://cakebuild.net/api/Cake.Issues/Aliases/2C801A33){target="_blank"} aliases for reading issues from an issue provider. * Support for reading issues from multiple issue providers. * Support for reading issues in multiple formats (Plain text, Markdown, HTML) if supported by issue provider. * Support for creating links to file & location on source code hosting system (GitHub, Azure Repos, etc). * Support for passing additional run information to identify specific runs. -## Cake.Issues.Reporting +### Cake.Issues.Reporting Addin for creating reports providing the following functionality: -* [CreateIssueReport] aliases for creating reports about issues. +* [CreateIssueReport](https://cakebuild.net/api/Cake.Issues.Reporting/Aliases/39023BBC){target="_blank"} + aliases for creating reports about issues. * Support for creating reports with issues from multiple issue providers. -## Cake.Issues.PullRequests +### Cake.Issues.PullRequests Addin for writing issues as comments to pull requests providing the following functionality: -* [ReportIssuesToPullRequest] aliases for writing issues as comments to pull requests. +* [ReportIssuesToPullRequest](https://cakebuild.net/api/Cake.Issues.PullRequests/Aliases/C0F2D0B8){target="_blank"} + aliases for writing issues as comments to pull requests. * Support for reporting issues from multiple issue providers. * Support for passing custom issue filter routines in `ReportIssuesToPullRequestSettings.IssueFilters`. * Advanced support to limit number of maximum issues per run, across multiple runs or per issue provider by setting @@ -46,36 +49,29 @@ Addin for writing issues as comments to pull requests providing the following fu Concrete pull request systems can implement optional capabilities which will provide the following functionality: -* Filter by modified files ([BaseFilteringByModifiedFilesCapability]) +* Filter by modified files ([BaseFilteringByModifiedFilesCapability](https://cakebuild.net/api/Cake.Issues.PullRequests/BaseFilteringByModifiedFilesCapability_1/){target="_blank"}) * Filtering issues to only those related to changed files in a pull request. -* Check commit ID ([BaseCheckingCommitIdCapability]) +* Check commit ID ([BaseCheckingCommitIdCapability](https://cakebuild.net/api/Cake.Issues.PullRequests/BaseCheckingCommitIdCapability_1/){target="_blank"}) * Skipping posting of issues if checked source code is outdated by setting `ReportIssuesToPullRequestSettings.CommitId`. -* Support for discussion threads ([BaseDiscussionThreadsCapability]) +* Support for discussion threads ([BaseDiscussionThreadsCapability](https://cakebuild.net/api/Cake.Issues.PullRequests/BaseDiscussionThreadsCapability_1/){target="_blank"}) * Automatic resolving of issues fixed in subsequent commits. * Automatic reopening of still existing issues which are already closed on pull request. * Comparing issues by identifier to not rely on message or line numbers. -# Supported Issue Providers +## Supported Issue Providers See [Issue Provider Addins] for a list of currently supported analyzers and linters. -# Supported Report Formats +## Supported Report Formats See [Report Format Addins] for a list of currently supported report output formats. -# Supported Pull Request Systems +## Supported Pull Request Systems See [Pull Request System Addins] for a list of currently supported pull request systems. -[Supported Tools]: ../recipe/supported-tools -[Cake.Issues.Recipe]: ../recipe/ -[NewIssue]: ../../api/Cake.Issues/Aliases/DC3A3FD7 -[ReadIssues]: ../../api/Cake.Issues/Aliases/713F15FD -[CreateIssueReport]: ../../api/Cake.Issues.Reporting/Aliases/C778C70A -[ReportIssuesToPullRequest]: ../../api/Cake.Issues.PullRequests/Aliases/5350C413 -[BaseFilteringByModifiedFilesCapability]: ../../api/Cake.Issues.PullRequests/BaseFilteringByModifiedFilesCapability_1 -[BaseCheckingCommitIdCapability]: ../../api/Cake.Issues.PullRequests/BaseCheckingCommitIdCapability_1 -[BaseDiscussionThreadsCapability]: ../../api/Cake.Issues.PullRequests/BaseDiscussionThreadsCapability_1 -[Issue Provider Addins]: ../../addins/issue-provider/ -[Report Format Addins]: ../../addins/reporting-format/ -[Pull Request System Addins]: ../../addins/pull-request-system/ +[Supported Tools]: ../recipe/supported-tools.md +[Cake.Issues.Recipe]: ../recipe/overview.md +[Issue Provider Addins]: ../issue-providers/index.md +[Report Format Addins]: ../report-formats/index.md +[Pull Request System Addins]: ../pull-request-systems/index.md diff --git a/docs/input/docs/overview/introduction.md b/docs/docs/documentation/overview/introduction.md similarity index 62% rename from docs/input/docs/overview/introduction.md rename to docs/docs/documentation/overview/introduction.md index 62ba24292..85df2480e 100644 --- a/docs/input/docs/overview/introduction.md +++ b/docs/docs/documentation/overview/introduction.md @@ -1,7 +1,8 @@ --- -Order: 10 -Description: Introduction +title: Introduction +description: Introduction --- + Do you want to break your build on JetBrains InspectCode issues? Do you want to create nice reports for StyleCop issues in your code? Do you want to have ESLint issues reported as comments to pull requests? @@ -22,18 +23,14 @@ working together and providing over 75 aliases which can be used in Cake build s The addins are built in a [modular architecture] and are providing different [extension points] which allows to easily enhance them for supporting additional analyzers, linters, report formats and code review systems. -:::{.alert .alert-success} -To get started you can use one of the [Cake.Issues recipes], which bring support for different linters and -integration with build and pull request systems out-of-the box in a single and easy to use NuGet package. -::: - - - Presentation - - - Tutorials - - -[modular architecture]: /docs/fundamentals/architecture -[extension points]: /docs/extending/ -[Cake.Issues recipes]: /docs/recipe/overview +!!! tip + To get started you can use one of the [Cake.Issues recipes], which bring support for different linters and + integration with build and pull request systems out-of-the box in a single and easy to use NuGet package. + +[:fontawesome-solid-video: Presentation](https://gitpitch.com/pascalberger/Cake.Issues-Presentation){ .md-button } + +[:fontawesome-solid-graduation-cap: Tutorials](../usage/index.md){ .md-button } + +[modular architecture]: ../fundamentals/architecture.md +[extension points]: ../extending/index.md +[Cake.Issues recipes]: ../recipe/overview.md diff --git a/docs/docs/documentation/overview/requirements.md b/docs/docs/documentation/overview/requirements.md new file mode 100644 index 000000000..0c67ccd3c --- /dev/null +++ b/docs/docs/documentation/overview/requirements.md @@ -0,0 +1,8 @@ +--- +title: Requirements +description: Requirements for using Cake.Issues. +--- + +The requirements are listed in the [release notes] for any specific version + +[Release notes]: https://github.com/cake-contrib/Cake.Issues/releases diff --git a/docs/input/docs/pull-request-systems/appveyor/appveyor-messages.png b/docs/docs/documentation/pull-request-systems/appveyor/appveyor-messages.png similarity index 100% rename from docs/input/docs/pull-request-systems/appveyor/appveyor-messages.png rename to docs/docs/documentation/pull-request-systems/appveyor/appveyor-messages.png diff --git a/docs/input/docs/pull-request-systems/appveyor/examples/github-pullrequest-integration.md b/docs/docs/documentation/pull-request-systems/appveyor/examples/github-pullrequest-integration.md similarity index 87% rename from docs/input/docs/pull-request-systems/appveyor/examples/github-pullrequest-integration.md rename to docs/docs/documentation/pull-request-systems/appveyor/examples/github-pullrequest-integration.md index 2620901b5..f4449a404 100644 --- a/docs/input/docs/pull-request-systems/appveyor/examples/github-pullrequest-integration.md +++ b/docs/docs/documentation/pull-request-systems/appveyor/examples/github-pullrequest-integration.md @@ -1,8 +1,8 @@ --- -Order: 20 -Title: GitHub pull request integration -Description: Example how to write AppVeyor message to GitHub pull requests. +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] @@ -21,4 +21,4 @@ The output will look similar to this: ![GitHub pull request integration](github-pullrequest-integration.png "GitHub pull request integration") -[GitHub Pull Request Notification]: https://www.appveyor.com/docs/notifications/#github-pull-request \ No newline at end of file +[GitHub Pull Request Notification]: https://www.appveyor.com/docs/notifications/#github-pull-request diff --git a/docs/input/docs/pull-request-systems/appveyor/examples/github-pullrequest-integration.png b/docs/docs/documentation/pull-request-systems/appveyor/examples/github-pullrequest-integration.png similarity index 100% rename from docs/input/docs/pull-request-systems/appveyor/examples/github-pullrequest-integration.png rename to docs/docs/documentation/pull-request-systems/appveyor/examples/github-pullrequest-integration.png diff --git a/docs/docs/documentation/pull-request-systems/appveyor/examples/index.md b/docs/docs/documentation/pull-request-systems/appveyor/examples/index.md new file mode 100644 index 000000000..4fd332421 --- /dev/null +++ b/docs/docs/documentation/pull-request-systems/appveyor/examples/index.md @@ -0,0 +1,8 @@ +--- +title: Examples +description: Examples for using the Cake.Issues.PullRequests.AppVeyor addin. +--- + +!!! info + There's a [demo repository](https://github.com/pascalberger/Cake.Issues-Demo) + available which you can fork and to which you can create pull requests to test the integration functionality. diff --git a/docs/input/docs/pull-request-systems/appveyor/examples/write-messages.md b/docs/docs/documentation/pull-request-systems/appveyor/examples/write-messages.md similarity index 64% rename from docs/input/docs/pull-request-systems/appveyor/examples/write-messages.md rename to docs/docs/documentation/pull-request-systems/appveyor/examples/write-messages.md index 10cccdfb4..9c03b8204 100644 --- a/docs/input/docs/pull-request-systems/appveyor/examples/write-messages.md +++ b/docs/docs/documentation/pull-request-systems/appveyor/examples/write-messages.md @@ -1,8 +1,8 @@ --- -Order: 10 -Title: Writing message to AppVeyor -Description: Example how to write issues as messages to an AppVeyor build. +title: Writing message to AppVeyor +description: Example how to write issues as messages to an AppVeyor build. --- + This example shows how to report issues as messages to an AppVeyor build. To report issues as messages to an AppVeyor build you need to import the core addin, @@ -16,15 +16,15 @@ in this example for JetBrains InspectCode: #addin "Cake.Issues.PullRequests.AppVeyor" ``` -:::{.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. +!!! 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. -::: + See [pinning addin versions](https://cakebuild.net/docs/writing-builds/reproducible-builds/){target="_blank"} 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 [AppVeyorBuilds] alias: +source branch of the pull request and with this information call the +[AppVeyorBuilds](https://cakebuild.net/api/Cake.Issues.PullRequests.AppVeyor/AppVeyorBuildsAliases/){target="_blank"} alias: ```csharp Task("ReportIssuesToAppVeyor").Does(() => @@ -42,5 +42,3 @@ Task("ReportIssuesToAppVeyor").Does(() => The output will look similar to this: ![AppVeyor messages](../appveyor-messages.png "AppVeyor messages") - -[AppVeyorBuilds]: ../../../../api/Cake.Issues.PullRequests.AppVeyor/AppVeyorBuildsAliases/ \ No newline at end of file diff --git a/docs/docs/documentation/pull-request-systems/appveyor/features.md b/docs/docs/documentation/pull-request-systems/appveyor/features.md new file mode 100644 index 000000000..13d851d35 --- /dev/null +++ b/docs/docs/documentation/pull-request-systems/appveyor/features.md @@ -0,0 +1,31 @@ +--- +title: Features +description: Features of the Cake.Issues.PullRequests.AppVeyor addin. +--- + +The [Cake.Issues.PullRequests.AppVeyor addin] reports issues as messages to AppVeyor builds. + +![AppVeyor messages](appveyor-messages.png "AppVeyor messages") + +!!! info + There's a [demo repository] available which you can fork and to which you can create pull requests to test the integration functionality. + +## Basic features + +* Reports issues as messages to AppVeyor builds. +* Messages can be written as comment to GitHub pull requests. + See [GitHub pull request integration] for an example. + +## Supported capabilities + +The [Cake.Issues.PullRequests.AppVeyor addin] doesn't support any additional capabilities. + +| | Capability | Remarks | +|------------------|--------------------------------|--------------------------------| +| | Checking commit ID | | +| | Discussion threads | | +| | Filtering by modified files | | + +[demo repository]: https://github.com/pascalberger/Cake.Issues-Demo +[Cake.Issues.PullRequests.AppVeyor addin]: https://www.nuget.org/packages/Cake.Issues.PullRequests.AppVeyor +[GitHub pull request integration]: ./examples/github-pullrequest-integration.md diff --git a/docs/docs/documentation/pull-request-systems/appveyor/index.md b/docs/docs/documentation/pull-request-systems/appveyor/index.md new file mode 100644 index 000000000..3d0b41007 --- /dev/null +++ b/docs/docs/documentation/pull-request-systems/appveyor/index.md @@ -0,0 +1,7 @@ +--- +title: AppVeyor +description: Support for AppVeyor. +--- + +Support for AppVeyor is implemented in the +[Cake.Issues.PullRequests.AppVeyor addin](https://www.nuget.org/packages/Cake.Issues.PullRequests.AppVeyor). diff --git a/docs/input/docs/pull-request-systems/azure-devops/cake.issues.pullrequests.azuredevops.png b/docs/docs/documentation/pull-request-systems/azure-devops/cake.issues.pullrequests.azuredevops.png similarity index 100% rename from docs/input/docs/pull-request-systems/azure-devops/cake.issues.pullrequests.azuredevops.png rename to docs/docs/documentation/pull-request-systems/azure-devops/cake.issues.pullrequests.azuredevops.png diff --git a/docs/input/docs/pull-request-systems/azure-devops/examples/azure-pipelines.md b/docs/docs/documentation/pull-request-systems/azure-devops/examples/azure-pipelines.md similarity index 67% rename from docs/input/docs/pull-request-systems/azure-devops/examples/azure-pipelines.md rename to docs/docs/documentation/pull-request-systems/azure-devops/examples/azure-pipelines.md index 6078ba5ac..1e82b3adc 100644 --- a/docs/input/docs/pull-request-systems/azure-devops/examples/azure-pipelines.md +++ b/docs/docs/documentation/pull-request-systems/azure-devops/examples/azure-pipelines.md @@ -1,8 +1,8 @@ --- -Order: 30 -Title: Using with Azure Pipelines -Description: Example how to use the Cake.Issues.PullRequests.AzureDevOps addin from an Azure Pipelines build. +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, @@ -17,23 +17,23 @@ in this example for JetBrains InspectCode: #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. +!!! 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. -::: + See [pinning addin versions](https://cakebuild.net/docs/writing-builds/reproducible-builds/){target="_blank"} 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. +then read the remote repository URL and pull request id from environment variables set by the Azure Pipelines build +and finally call the [AzureDevOpsPullRequests](https://cakebuild.net/api/Cake.Issues.PullRequests.AzureDevOps/AzureDevOpsPullRequestSystemAliases/){target="_blank"} +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. +!!! info + Please note that you'll need to setup your Azure Pipelines build to + [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){target="_blank"} + and need to setup proper permissions. -See [OAuth authentication from Azure Pipelines] for details. -::: + See [OAuth authentication from Azure Pipelines] for details. ```csharp Task("ReportIssuesToPullRequest").Does(() => @@ -78,6 +78,4 @@ Task("ReportIssuesToPullRequest").Does(() => }); ``` -[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 +[OAuth authentication from Azure Pipelines]: ../setup.md#oauth-authentication-from-azure-pipelines diff --git a/docs/docs/documentation/pull-request-systems/azure-devops/examples/index.md b/docs/docs/documentation/pull-request-systems/azure-devops/examples/index.md new file mode 100644 index 000000000..1ec97dfb9 --- /dev/null +++ b/docs/docs/documentation/pull-request-systems/azure-devops/examples/index.md @@ -0,0 +1,8 @@ +--- +title: Examples +description: Examples for using the Cake.Issues.PullRequests.AzureDevOps addin. +--- + +!!! info + There's a [demo repository](https://dev.azure.com/pberger/Cake.Issues-Demo){target="_blank"} + available which you can fork and to which you can create pull requests to test the integration functionality. diff --git a/docs/input/docs/pull-request-systems/azure-devops/examples/pullrequest-id.md b/docs/docs/documentation/pull-request-systems/azure-devops/examples/pullrequest-id.md similarity index 59% rename from docs/input/docs/pull-request-systems/azure-devops/examples/pullrequest-id.md rename to docs/docs/documentation/pull-request-systems/azure-devops/examples/pullrequest-id.md index 843390dfc..0937bb78c 100644 --- a/docs/input/docs/pull-request-systems/azure-devops/examples/pullrequest-id.md +++ b/docs/docs/documentation/pull-request-systems/azure-devops/examples/pullrequest-id.md @@ -1,11 +1,11 @@ --- -Order: 10 -Title: Using with pull request id -Description: Example how to use the Cake.Issues.PullRequests.AzureDevOps addin with pull request id. +title: Using with pull request id +description: Example how to use the Cake.Issues.PullRequests.AzureDevOps addin with pull request id. --- + This example shows how to write issues as comments to an Azure DevOps pull request while using pull request id. -To determine the remote repository URL you need the [Cake.Git] addin: +To determine the remote repository URL you need the [Cake.Git](https://cakebuild.net/extensions/cake-git/){target="_blank"} addin: ```csharp #addin "Cake.Git" @@ -23,16 +23,15 @@ in this example for JetBrains InspectCode: #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. +!!! 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. -::: + See [pinning addin versions](https://cakebuild.net/docs/writing-builds/reproducible-builds/){target="_blank"} for details. In the following task we'll first determine the remote repository URL and -with this information call the [AzureDevOpsPullRequests] alias, -which will authenticate through NTLM to an on-premise Azure DevOps Server instance: +with this information call the [AzureDevOpsPullRequests](https://cakebuild.net/api/Cake.Issues.PullRequests.AzureDevOps/AzureDevOpsPullRequestSystemAliases/){target="_blank"} +alias, which will authenticate through NTLM to an on-premise Azure DevOps Server instance: ```csharp Task("ReportIssuesToPullRequest").Does(() => @@ -51,6 +50,3 @@ Task("ReportIssuesToPullRequest").Does(() => repoRootFolder); }); ``` - -[AzureDevOpsPullRequests]: ../../../../api/Cake.Issues.PullRequests.AzureDevOps/AzureDevOpsPullRequestSystemAliases/64912B0A -[Cake.Git]: https://www.nuget.org/packages/Cake.Git/ diff --git a/docs/input/docs/pull-request-systems/azure-devops/examples/repository-information.md b/docs/docs/documentation/pull-request-systems/azure-devops/examples/repository-information.md similarity index 64% rename from docs/input/docs/pull-request-systems/azure-devops/examples/repository-information.md rename to docs/docs/documentation/pull-request-systems/azure-devops/examples/repository-information.md index 804ef7cfd..e9e0fcff3 100644 --- a/docs/input/docs/pull-request-systems/azure-devops/examples/repository-information.md +++ b/docs/docs/documentation/pull-request-systems/azure-devops/examples/repository-information.md @@ -1,11 +1,12 @@ --- -Order: 20 -Title: Using with repository remote url and source branch name -Description: Example how to use the Cake.Issues.PullRequests.AzureDevOps addin with repository remote url and source branch name. +title: Using with repository remote url and source branch name +description: Example how to use the Cake.Issues.PullRequests.AzureDevOps addin with repository remote url and source branch name. --- + This example shows how to write issues as comments to an Azure DevOps pull request while using repository information. -To determine the remote repository URL and source branch of the pull request you need the [Cake.Git] addin: +To determine the remote repository URL and source branch of the pull request you need the [Cake.Git](https://cakebuild.net/extensions/cake-git/){target="_blank"} +addin: ```csharp #addin "Cake.Git" @@ -23,16 +24,15 @@ in this example for JetBrains InspectCode: #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. +!!! 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. -::: + See [pinning addin versions](https://cakebuild.net/docs/writing-builds/reproducible-builds/){target="_blank"} 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 [AzureDevOpsPullRequests] alias, -which will authenticate through NTLM to an on-premise Azure DevOps Server instance: +source branch of the pull request and with this information call the [AzureDevOpsPullRequests](https://cakebuild.net/api/Cake.Issues.PullRequests.AzureDevOps/AzureDevOpsPullRequestSystemAliases/){target="_blank"} +alias, which will authenticate through NTLM to an on-premise Azure DevOps Server instance: ```csharp Task("ReportIssuesToPullRequest").Does(() => @@ -52,6 +52,3 @@ Task("ReportIssuesToPullRequest").Does(() => repoRootFolder); }); ``` - -[AzureDevOpsPullRequests]: ../../../../api/Cake.Issues.PullRequests.AzureDevOps/AzureDevOpsPullRequestSystemAliases/8D75BECA -[Cake.Git]: https://www.nuget.org/packages/Cake.Git/ diff --git a/docs/docs/documentation/pull-request-systems/azure-devops/features.md b/docs/docs/documentation/pull-request-systems/azure-devops/features.md new file mode 100644 index 000000000..b7a0d33ea --- /dev/null +++ b/docs/docs/documentation/pull-request-systems/azure-devops/features.md @@ -0,0 +1,47 @@ +--- +title: Features +description: Features of the Cake.Issues.PullRequests.AzureDevOps addin. +--- + +The [Cake.Issues.PullRequests.AzureDevOps addin](https://cakebuild.net/extensions/cake-issues-pullrequests-azuredevops/){target="_blank"} +provides the following features. + +!!! info + There's a [demo repository] available which you can fork and to which you can create pull requests to test the integration functionality. + +## Basic features + +* Writes issues as comments to [Azure DevOps](https://azure.microsoft.com/en-us/services/devops/){target="_blank"} pull requests. +* Identification of pull requests through source branch or pull request ID. +* Comments written by the addin will be rendered with a specific icon corresponding to the state of the issue. +* Adds rule number and, if provided by the issue provider, link to the rule description to the comment. +* Support for issues messages formatted in Markdown format. + +## Supported capabilities + +The [Cake.Issues.PullRequests.AzureDevOps addin](https://cakebuild.net/extensions/cake-issues-pullrequests-azuredevops/){target="_blank"} +supports all [Core features]. + +| | Capability | Remarks | +|------------------|--------------------------------|--------------------------------| +| :material-check: | Checking commit ID | | +| :material-check: | Discussion threads | | +| :material-check: | Filtering by modified files | | + +## Supported authentication methods + +| Azure DevOps Server | Azure DevOps Service | Authentication method | +|---------------------|----------------------|--------------------------------| +| :material-check: | | NTLM | +| :material-check: | | Basic authentication | +| :material-check: | :material-check: | Personal access token | +| | :material-check: | OAuth | +| | :material-check: | Azure Active Directory | + +For detailed instructions how to connect using the different methods see [Setup instructions]. + +![Cake.Issues.PullRequests.AzureDevOps](cake.issues.pullrequests.azuredevops.png "Cake.Issues.PullRequests.AzureDevOps") + +[demo repository]: https://dev.azure.com/pberger/Cake.Issues-Demo +[Core features]: ../../overview/features.md#supported-core-functionality +[Setup instructions]: setup.md diff --git a/docs/docs/documentation/pull-request-systems/azure-devops/index.md b/docs/docs/documentation/pull-request-systems/azure-devops/index.md new file mode 100644 index 000000000..14f386e65 --- /dev/null +++ b/docs/docs/documentation/pull-request-systems/azure-devops/index.md @@ -0,0 +1,7 @@ +--- +title: Azure DevOps +description: Support for Azure DevOps. +--- + +Support for Azure DevOps is implemented in the +[Cake.Issues.PullRequests.AzureDevOps addin](https://www.nuget.org/packages/Cake.Issues.PullRequests.AzureDevOps). diff --git a/docs/input/docs/pull-request-systems/azure-devops/setup.md b/docs/docs/documentation/pull-request-systems/azure-devops/setup.md similarity index 80% rename from docs/input/docs/pull-request-systems/azure-devops/setup.md rename to docs/docs/documentation/pull-request-systems/azure-devops/setup.md index ac9f128bb..1067affcf 100644 --- a/docs/input/docs/pull-request-systems/azure-devops/setup.md +++ b/docs/docs/documentation/pull-request-systems/azure-devops/setup.md @@ -1,34 +1,32 @@ --- -Order: 30 -Title: Setup -Description: Instructions how to setup the Cake.Issues.PullRequests.AzureDevOps addin. +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 +## NTLM authentication -:::{.alert .alert-info} -NTLM authentication is only available for on-premise Azure DevOps Server. -::: +!!! 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 +## Basic authentication -:::{.alert .alert-info} -Basic authentication is only available for on-premise Azure DevOps Server. -::: +!!! 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]. +need to [Configure Azure DevOps 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 +## Personal access token To authenticate with an personal access token you can use the [AzureDevOpsAuthenticationPersonalAccessToken] alias from the [Cake.AzureDevOps addin]. @@ -39,11 +37,10 @@ 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 +## OAuth authentication from Azure Pipelines -:::{.alert .alert-info} -OAuth authentication is only available for Azure DevOps Service. -::: +!!! 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. @@ -55,11 +52,10 @@ The user under which the build runs, named ` Build Service ( @@ -50,5 +50,3 @@ 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: ![Pull request integration](../githubactions-pullrequest-integration.png "Pull request integration") - -[GitHubActionsBuilds]: ../../../../api/Cake.Issues.PullRequests.GitHubActions/GitHubActionsBuildsAliases/ diff --git a/docs/docs/documentation/pull-request-systems/github-actions/features.md b/docs/docs/documentation/pull-request-systems/github-actions/features.md new file mode 100644 index 000000000..8416a8570 --- /dev/null +++ b/docs/docs/documentation/pull-request-systems/github-actions/features.md @@ -0,0 +1,25 @@ +--- +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. + +![Pull request integration](githubactions-pullrequest-integration.png "Pull request integration") + +## 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/docs/documentation/pull-request-systems/github-actions/githubactions-annotations.png similarity index 100% rename from docs/input/docs/pull-request-systems/github-actions/githubactions-annotations.png rename to docs/docs/documentation/pull-request-systems/github-actions/githubactions-annotations.png diff --git a/docs/input/docs/pull-request-systems/github-actions/githubactions-log-output.png b/docs/docs/documentation/pull-request-systems/github-actions/githubactions-log-output.png similarity index 100% rename from docs/input/docs/pull-request-systems/github-actions/githubactions-log-output.png rename to docs/docs/documentation/pull-request-systems/github-actions/githubactions-log-output.png diff --git a/docs/input/docs/pull-request-systems/github-actions/githubactions-pullrequest-integration.png b/docs/docs/documentation/pull-request-systems/github-actions/githubactions-pullrequest-integration.png similarity index 100% rename from docs/input/docs/pull-request-systems/github-actions/githubactions-pullrequest-integration.png rename to docs/docs/documentation/pull-request-systems/github-actions/githubactions-pullrequest-integration.png diff --git a/docs/docs/documentation/pull-request-systems/github-actions/index.md b/docs/docs/documentation/pull-request-systems/github-actions/index.md new file mode 100644 index 000000000..9b29daaaf --- /dev/null +++ b/docs/docs/documentation/pull-request-systems/github-actions/index.md @@ -0,0 +1,7 @@ +--- +title: GitHub Actions +description: Support for GitHub Actions. +--- + +Support for GitHub Actions is implemented in the +[Cake.Issues.PullRequests.GitHubActions addin](https://www.nuget.org/packages/Cake.Issues.PullRequests.GitHubActions). diff --git a/docs/docs/documentation/pull-request-systems/index.md b/docs/docs/documentation/pull-request-systems/index.md new file mode 100644 index 000000000..40b483447 --- /dev/null +++ b/docs/docs/documentation/pull-request-systems/index.md @@ -0,0 +1,4 @@ +--- +title: Pull Request Systems +description: Documentation of the different pull request system implementations. +--- diff --git a/docs/input/docs/recipe/configuration.md b/docs/docs/documentation/recipe/configuration.md similarity index 95% rename from docs/input/docs/recipe/configuration.md rename to docs/docs/documentation/recipe/configuration.md index e3df226a2..c3b974746 100644 --- a/docs/input/docs/recipe/configuration.md +++ b/docs/docs/documentation/recipe/configuration.md @@ -1,13 +1,12 @@ --- -Order: 50 -Title: Configuration -Description: Available parameters to configure Cake.Issues recipes. +title: Configuration +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 recipes. -# Git repository information +## Git repository information Cake.Issues recipes require some information about current Git repository. @@ -18,19 +17,19 @@ The following providers are supported: | Provider | Description | |--------------------------------------|-------------------------------------------------------------------------------------------------------------| -| `RepositoryInfoProviderType.CakeGit` | Read repository information using [Cake.Git addin]. Requires system to be compatible with [Cake.Git addin]. | +| `RepositoryInfoProviderType.CakeGit` | Read repository information using [Cake.Git addin](https://cakebuild.net/extensions/cake-git/){target="_blank"}. Requires system to be compatible with [Cake.Git addin](https://cakebuild.net/extensions/cake-git/){target="_blank"}. | | `RepositoryInfoProviderType.Cli` | Read repository information using Git CLI. Requires Git CLI to be available in path. | -By default [Cake.Git addin] will be used. +By default [Cake.Git addin](https://cakebuild.net/extensions/cake-git/){target="_blank"} will be used. -# General +## General | 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 +## Input files | Cake.Issues.Recipe Methods | Cake.Frosting.Issues.Recipe Methods | Description | |------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------| @@ -46,14 +45,12 @@ By default [Cake.Git addin] will be used. | `IssuesParameters.InputFiles.`
    `AddMarkdownlintCliJsonLogFileContent()` | `IssuesContext.Parameters.InputFiles.`
    `AddMarkdownlintCliJsonLogFileContent()` | Adds content of a markdownlint-cli log file writting with `--json`. | | `IssuesParameters.InputFiles.`
    `AddMarkdownlintV1LogFilePath()` | `IssuesContext.Parameters.InputFiles.`
    `AddMarkdownlintV1LogFilePath()` | Adds a path to a markdownlint log file in version 1. | | `IssuesParameters.InputFiles.`
    `AddMarkdownlintV1LogFileContent()` | `IssuesContext.Parameters.InputFiles.`
    `AddMarkdownlintV1LogFileContent()` | Adds content of a markdownlint log file in version 1. | -| `IssuesParameters.InputFiles.`
    `AddEsLintJsonLogFilePath()` | `IssuesContext.Parameters.InputFiles.`
    `AddEsLintJsonLogFilePath()` | Adds a path to a ESLint log file generated by the [ESLint json formatter]. | -| `IssuesParameters.InputFiles.`
    `AddEsLintJsonLogFileContent()` | `IssuesContext.Parameters.InputFiles.`
    `AddEsLintJsonLogFileContent()` | Adds content of a ESLint log file generated by the [ESLint json formatter]. | +| `IssuesParameters.InputFiles.`
    `AddEsLintJsonLogFilePath()` | `IssuesContext.Parameters.InputFiles.`
    `AddEsLintJsonLogFilePath()` | Adds a path to a ESLint log file generated by the [ESLint json formatter](https://eslint.org/docs/user-guide/formatters/#json){target="_blank"}. | +| `IssuesParameters.InputFiles.`
    `AddEsLintJsonLogFileContent()` | `IssuesContext.Parameters.InputFiles.`
    `AddEsLintJsonLogFileContent()` | Adds content of a ESLint log file generated by the [ESLint json formatter](https://eslint.org/docs/user-guide/formatters/#json){target="_blank"}. | | `IssuesParameters.InputFiles.`
    `AddSarifLogFilePath()` | `IssuesContext.Parameters.InputFiles.`
    `AddSarifLogFilePath()` | Adds a path to a SARIF log file. | | `IssuesParameters.InputFiles.`
    `AddSarifLogFileContent()` | `IssuesContext.Parameters.InputFiles.`
    `AddSarifLogFileContent()` | Adds content of a SARIF log file. | -[ESLint json formatter]: https://eslint.org/docs/user-guide/formatters/#json - -# Report creation +## Report creation | Cake.Issues.Recipe Property | Cake.Frosting.Issues.Recipe Property | Default Value | Description | |-------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------| @@ -63,9 +60,9 @@ By default [Cake.Git addin] will be used. | `IssuesParameters.Reporting.`
    `ShouldReportIssuesToConsole` | `IssuesContext.Parameters.Reporting.`
    `ShouldReportIssuesToConsole` | `false` | Indicates whether issues should be reported to the console. | | `IssuesParameters.Reporting.`
    `ReportToConsoleSettings` | `IssuesContext.Parameters.Reporting.`
    `ReportToConsoleSettings` | | Settings for reporting issues to the console. | -[Template Gallery]: /docs/report-formats/generic/templates/ +[Template Gallery]: ../report-formats/generic/templates/index.md -# Build server integration +## Build server integration | Cake.Issues.Recipe Property | Cake.Frosting.Issues.Recipe Property | Default Value | Description | |-----------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|---------------|------------------------------------------------------------------------------------------------| @@ -74,7 +71,7 @@ By default [Cake.Git addin] will be used. | `IssuesParameters.BuildServer.`
    `ShouldPublishSarifReport` | `IssuesContext.Parameters.BuildServer.`
    `ShouldPublishSarifReport` | `true` | Indicates whether report int SARIF format shoudl 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 +## Pull request integration | Cake.Issues.Recipe Property | Cake.Frosting.Issues.Recipe Property | Default Value | Description | |----------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -86,5 +83,3 @@ By default [Cake.Git addin] will be used. | `IssuesParameters.PullRequestSystem.`
    `IssueFilters` | `IssuesContext.Parameters.PullRequestSystem.`
    `IssueFilters` | Empty | List of filter functions which should be applied before posting issues to pull requests. | | `IssuesParameters.PullRequestSystem.`
    `ShouldSetPullRequestStatus` | `IssuesContext.Parameters.PullRequestSystem.`
    `ShouldSetPullRequestStatus` | `true` | Indicates whether a status on the pull request should be set if there are any issues found. | | `IssuesParameters.PullRequestSystem.`
    `ShouldSetSeparatePullRequestStatusForEachIssueProviderAndRun` | `IssuesContext.Parameters.PullRequestSystem.`
    `ShouldSetSeparatePullRequestStatusForEachIssueProviderAndRun` | `true` | Indicates whether a separate status should be set for issues of every issue provider and run. | - -[Cake.Git addin]: https://cakebuild.net/extensions/cake-git/ diff --git a/docs/input/docs/recipe/demos.md b/docs/docs/documentation/recipe/demos.md similarity index 91% rename from docs/input/docs/recipe/demos.md rename to docs/docs/documentation/recipe/demos.md index b8cca3e9b..36fa3c149 100644 --- a/docs/input/docs/recipe/demos.md +++ b/docs/docs/documentation/recipe/demos.md @@ -1,7 +1,6 @@ --- -Order: 40 -Title: Demos -Description: Demo setups for Cake.Issues recipes. +title: Demos +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 diff --git a/docs/input/docs/recipe/overview.md b/docs/docs/documentation/recipe/overview.md similarity index 96% rename from docs/input/docs/recipe/overview.md rename to docs/docs/documentation/recipe/overview.md index b7b44b218..e6fcd8e92 100644 --- a/docs/input/docs/recipe/overview.md +++ b/docs/docs/documentation/recipe/overview.md @@ -1,8 +1,8 @@ --- -Order: 10 -Title: Overview -Description: Overview about Cake.Issues recipes. +title: Overview +description: Overview about Cake.Issues recipes. --- + 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. @@ -14,11 +14,11 @@ 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] -# Supported tools +## Supported tools See [supported tools] for a list of supported linters, build servers and pull request systems. -# Bundled addins +## Bundled addins Cake.Issues recipes will add the following addins to your build: @@ -46,8 +46,8 @@ Cake.Issues recipes will add the following addins to your build: [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 -[Git repository information configuration]: /docs/recipe/configuration#git-repository-information +[supported tools]: supported-tools.md +[Git repository information configuration]: configuration.md#git-repository-information [Cake.Git]: https://cakebuild.net/extensions/cake-git/ [Cake.Frosting.Git]: https://cakebuild.net/extensions/cake-git/ [Cake.Issues]: https://cakebuild.net/extensions/cake-issues/ diff --git a/docs/input/docs/recipe/supported-tools.md b/docs/docs/documentation/recipe/supported-tools.md similarity index 66% rename from docs/input/docs/recipe/supported-tools.md rename to docs/docs/documentation/recipe/supported-tools.md index e62805806..0b8a30fa7 100644 --- a/docs/input/docs/recipe/supported-tools.md +++ b/docs/docs/documentation/recipe/supported-tools.md @@ -1,12 +1,11 @@ --- -Order: 30 -Title: Supported tools -Description: Tools supported by Cake.Issues recipes. +title: Supported tools +description: Tools supported by Cake.Issues recipes. --- Cake.Issues recipes support reading issues from different tools and integrates with different build and pull request systems. -# Tools +## Tools Cake.Issues recipes support reading issues from output of the following tools: @@ -28,21 +27,21 @@ Cake.Issues recipes support reading issues from output of the following tools: [json formatter]: https://eslint.org/docs/user-guide/formatters/#json [SARIF]: https://sarifweb.azurewebsites.net/ -# Build systems +## Build systems Cake.Issues recipes integrates with the following build systems: -| Build System | Write issues to build server | Issues summary | Full issues report | -|--------------------------------|-----------------------------------------------------------------------------------|--------------------------------------------------------------------|--------------------------------------------------------------------| -| AppVeyor | | | | -| Azure Pipelines (Azure DevOps) | (Only first 10) | | | -| GitHub Actions | | | | +| Build System | Write issues to build server | Issues summary | Full issues report | +|--------------------------------|----------------------------------|--------------------|--------------------| +| AppVeyor | :material-check: | | :material-check: | +| Azure Pipelines (Azure DevOps) | :material-check: (Only first 10) | :material-check: | :material-check: | +| GitHub Actions | :material-check: | | | -# Pull request systems +## Pull request systems Cake.Issues recipes integrates with the following pull request systems: -| Pull Request System | Write issues to pull requests | Set pull request status | -|----------------------------|----------------------------------------------------------------------------------------------------|--------------------------------------------------------------------| -| Azure Repos (Azure DevOps) | | | -| GitHub | (When build from GitHub Actions) | | +| Pull Request System | Write issues to pull requests | Set pull request status | +|----------------------------|---------------------------------------------------|-------------------------| +| Azure Repos (Azure DevOps) | :material-check: | :material-check: | +| GitHub | :material-check: (When build from GitHub Actions) | | diff --git a/docs/input/docs/recipe/tasks.md b/docs/docs/documentation/recipe/tasks.md similarity index 97% rename from docs/input/docs/recipe/tasks.md rename to docs/docs/documentation/recipe/tasks.md index 1af33410c..040353b1a 100644 --- a/docs/input/docs/recipe/tasks.md +++ b/docs/docs/documentation/recipe/tasks.md @@ -1,7 +1,6 @@ --- -Order: 60 -Title: Tasks -Description: Tasks provided by Cake.Issues recipes. +title: Tasks +description: Tasks provided by Cake.Issues recipes. --- Cake.Issues recipes provide the following tasks to your build script: diff --git a/docs/docs/documentation/recipe/usage/index.md b/docs/docs/documentation/recipe/usage/index.md new file mode 100644 index 000000000..ba4113ced --- /dev/null +++ b/docs/docs/documentation/recipe/usage/index.md @@ -0,0 +1,4 @@ +--- +title: Usage +description: How to use Cake.Issues recipes in your build script. +--- diff --git a/docs/input/docs/recipe/usage/using-cake-frosting-issues-recipe.md b/docs/docs/documentation/recipe/usage/using-cake-frosting-issues-recipe.md similarity index 84% rename from docs/input/docs/recipe/usage/using-cake-frosting-issues-recipe.md rename to docs/docs/documentation/recipe/usage/using-cake-frosting-issues-recipe.md index 7a3715520..78d88a529 100644 --- a/docs/input/docs/recipe/usage/using-cake-frosting-issues-recipe.md +++ b/docs/docs/documentation/recipe/usage/using-cake-frosting-issues-recipe.md @@ -1,17 +1,16 @@ --- -Order: 20 -Title: Using Cake.Frosting.Issues.Recipe -Description: Basic usage of Cake.Frosting.Issues.Recipe. +title: Using Cake.Frosting.Issues.Recipe +description: Basic usage of Cake.Frosting.Issues.Recipe. --- + The [Cake.Frosting.Issues.Recipe] package can be used to easily add issue management functionality to your Cake Frosting build. -:::{.alert .alert-info} -See [Setting Up A New Frosting Project] for instructions how to create a new Cake Frosting project. -::: +!!! info + See [Setting Up A New Frosting Project] for instructions how to create a new Cake Frosting project. [Setting Up A New Frosting Project]: https://cakebuild.net/docs/getting-started/setting-up-a-new-frosting-project -# Add Cake.Frosting.Issues.Recipe to your Cake Frosting build +## Add Cake.Frosting.Issues.Recipe to your Cake Frosting build To use [Cake.Frosting.Issues.Recipe] in your Cake Frosting build you need to first add the NuGet package in your `.csproj` file: @@ -19,11 +18,10 @@ To use [Cake.Frosting.Issues.Recipe] in your Cake Frosting build you need to fir ``` -:::{.alert .alert-warning} -Replace the version (`1.0.0`) with the version of Cake.Frosting.Issues.Recipe you want to use. -::: +!!! warning + Replace the version (`1.0.0`) with the version of Cake.Frosting.Issues.Recipe you want to use. -# Register Cake.Issues tasks +## Register Cake.Issues tasks To make Cake Issues tasks available to your Cake Frosting build you need to register them. @@ -54,7 +52,7 @@ public static class Program } ``` -# Create build context +## Create build context [Cake.Frosting.Issues.Recipe] provides a build context from which you need to inherit your custom build context. The build context contains configuration parameters, but also the state of the current running build, @@ -73,7 +71,7 @@ public class BuildContext : IssuesContext } ``` -# Passing issues to Cake.Frosting.Issues.Recipe +## Passing issues to Cake.Frosting.Issues.Recipe To make issues available to [Cake.Frosting.Issues.Recipe] you need pass the log files through the corresponding methods. The tasks need to also be a dependency of `ReadIssuesTask` provided by [Cake.Frosting.Issues.Recipe]. @@ -104,7 +102,7 @@ public class RunInspectCodeTask : FrostingTask See [configuration] for a full list of available configuration parameters. -# Calling issues tasks +## Calling issues tasks [Cake.Frosting.Issues.Recipe] will add a bunch of [tasks] to your build script. @@ -121,6 +119,6 @@ public class DefaultTask : FrostingTask } ``` -[Cake.Frosting.Issues.Recipe]: ../../recipe/ -[configuration]: ../../recipe/configuration -[tasks]: ../../recipe/tasks \ No newline at end of file +[Cake.Frosting.Issues.Recipe]: ../overview.md +[configuration]: ../configuration.md +[tasks]: ../tasks.md \ No newline at end of file diff --git a/docs/input/docs/recipe/usage/using-cake-issues-recipe.md b/docs/docs/documentation/recipe/usage/using-cake-issues-recipe.md similarity index 72% rename from docs/input/docs/recipe/usage/using-cake-issues-recipe.md rename to docs/docs/documentation/recipe/usage/using-cake-issues-recipe.md index 71cbc419a..abe51a886 100644 --- a/docs/input/docs/recipe/usage/using-cake-issues-recipe.md +++ b/docs/docs/documentation/recipe/usage/using-cake-issues-recipe.md @@ -1,11 +1,11 @@ --- -Order: 10 -Title: Using Cake.Issues.Recipe -Description: Basic usage of Cake.Issues.Recipe. +title: Using Cake.Issues.Recipe +description: Basic usage of Cake.Issues.Recipe. --- + The [Cake.Issues.Recipe] package can be used to easily add issue management functionality to your build script. -# Add Cake.Issues.Recipe to your build script +## Add Cake.Issues.Recipe to your build script To use Cake.Issues.Recipe in your build script you need to first load the NuGet package: @@ -13,14 +13,13 @@ To use Cake.Issues.Recipe in your build script you need to first load the NuGet #load nuget:package=Cake.Issues.Recipe ``` -:::{.alert .alert-warning} -Please note that you always should pin NuGet packages to a specific version to make sure your builds are deterministic and -won't break due to updates to Cake.Issues.Recipe. +!!! warning + Please note that you always should pin NuGet packages to a specific version to make sure your builds are deterministic and + won't break due to updates to Cake.Issues.Recipe. -See [pinning addin versions](https://cakebuild.net/docs/tutorials/pinning-cake-version#pinning-addin-version) for details. -::: + See [pinning addin versions](https://cakebuild.net/docs/tutorials/pinning-cake-version#pinning-addin-version) for details. -# Configuring Cake.Issues.Recipe +## Configuring Cake.Issues.Recipe To make issues available to Cake.Issues.Recipe you need to set the corresponding configuration parameters. @@ -41,7 +40,7 @@ Task("Configure-CakeIssuesRecipe") See [configuration] for a full list of available configuration parameters. -# Calling issues tasks +## Calling issues tasks Cake.Issues.Recipe will add a bunch of [tasks] to your build script. @@ -63,6 +62,6 @@ Task("Default") .IsDependentOn("Issues"); ``` -[Cake.Issues.Recipe]: ../../recipe/ -[configuration]: ../../recipe/configuration -[tasks]: ../../recipe/tasks \ No newline at end of file +[Cake.Issues.Recipe]: ../overview.md +[configuration]: ../configuration.md +[tasks]: ../tasks.md \ No newline at end of file diff --git a/docs/input/docs/report-formats/console/examples.md b/docs/docs/documentation/report-formats/console/examples.md similarity index 77% rename from docs/input/docs/report-formats/console/examples.md rename to docs/docs/documentation/report-formats/console/examples.md index ea9f76c5d..5089d4ba0 100644 --- a/docs/input/docs/report-formats/console/examples.md +++ b/docs/docs/documentation/report-formats/console/examples.md @@ -1,16 +1,15 @@ --- -Order: 30 -Title: Examples -Description: Examples for using the Cake.Issues.Reporting.Console addin. +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. +!!! 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. -::: + See [pinning addin versions](https://cakebuild.net/docs/writing-builds/reproducible-builds/){target="_blank"} for details. ```csharp #tool "nuget:?package=MSBuild.Extension.Pack" diff --git a/docs/input/docs/report-formats/console/features.md b/docs/docs/documentation/report-formats/console/features.md similarity index 57% rename from docs/input/docs/report-formats/console/features.md rename to docs/docs/documentation/report-formats/console/features.md index 77b9ec143..45d0210ef 100644 --- a/docs/input/docs/report-formats/console/features.md +++ b/docs/docs/documentation/report-formats/console/features.md @@ -1,14 +1,16 @@ --- -Order: 20 -Title: Features -Description: Features of the Cake.Issues.Reporting.Console addin. +title: Features +description: Features of the Cake.Issues.Reporting.Console addin. --- + The [Cake.Issues.Reporting.Console addin] provides the following features: * Prints issues containing line and column information. * Group issues by rule -* Reports: - * Number of issues by provider - * Number of issues by priority for every provider and run + +Reports: + +* Number of issues by provider +* Number of issues by priority for every provider and run [Cake.Issues.Reporting.Console addin]: https://www.nuget.org/packages/Cake.Issues.Reporting.Console diff --git a/docs/docs/documentation/report-formats/console/index.md b/docs/docs/documentation/report-formats/console/index.md new file mode 100644 index 000000000..6faf24b3e --- /dev/null +++ b/docs/docs/documentation/report-formats/console/index.md @@ -0,0 +1,7 @@ +--- +title: Console +description: Report format to print issues to the console. +--- + +Support for printing issues to the console is implemented in the +a [Cake.Issues.Reporting.Console addin](https://www.nuget.org/packages/Cake.Issues.Reporting.Console). diff --git a/docs/input/docs/report-formats/generic/examples/custom-template.md b/docs/docs/documentation/report-formats/generic/examples/custom-template.md similarity index 75% rename from docs/input/docs/report-formats/generic/examples/custom-template.md rename to docs/docs/documentation/report-formats/generic/examples/custom-template.md index 8f3bbf242..893d0b076 100644 --- a/docs/input/docs/report-formats/generic/examples/custom-template.md +++ b/docs/docs/documentation/report-formats/generic/examples/custom-template.md @@ -1,21 +1,19 @@ --- -Order: 20 -Title: Custom template -Description: Example how to create a report using a custom template +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. -::: + +!!! 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. +!!! 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. -::: + See [pinning addin versions](https://cakebuild.net/docs/writing-builds/reproducible-builds/){target="_blank"} for details. ```csharp #tool "nuget:?package=MSBuild.Extension.Pack" @@ -101,16 +99,14 @@ Task("Create-IssueReport").Does(() => The template retrieves an `IEnumerable` as model. -:::{.alert .alert-info} -In custom templates functionality from the following assemblies are available: - -* System.dll -* System.Core.dll -* netstandard.dll -* Cake.Core.dll -* Cake.Issues.dll -* Cake.Issues.Reporting.Generic.dll +!!! info + In custom templates functionality from the following assemblies are available: -::: + * System.dll + * System.Core.dll + * netstandard.dll + * Cake.Core.dll + * Cake.Issues.dll + * Cake.Issues.Reporting.Generic.dll [create a pull request]: https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/CONTRIBUTING.md diff --git a/docs/input/docs/report-formats/generic/examples/default-template.md b/docs/docs/documentation/report-formats/generic/examples/default-template.md similarity index 75% rename from docs/input/docs/report-formats/generic/examples/default-template.md rename to docs/docs/documentation/report-formats/generic/examples/default-template.md index 7da2601bb..1d51365f5 100644 --- a/docs/input/docs/report-formats/generic/examples/default-template.md +++ b/docs/docs/documentation/report-formats/generic/examples/default-template.md @@ -1,16 +1,15 @@ --- -Order: 10 -Title: Embedded default template -Description: Example how to create a report using an embedded default template. +title: Embedded default template +description: Example how to create a report using an embedded default template. --- + The following example will create a HTML 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. +!!! 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. -::: + See [pinning addin versions](https://cakebuild.net/docs/writing-builds/reproducible-builds/){target="_blank"} for details. ```csharp #tool "nuget:?package=MSBuild.Extension.Pack" @@ -48,4 +47,4 @@ Task("Create-IssueReport").Does(() => repoRootFolder, @"c:\report.html"); }); -``` \ No newline at end of file +``` diff --git a/docs/input/docs/report-formats/generic/examples/index.cshtml b/docs/docs/documentation/report-formats/generic/examples/index.cshtml similarity index 100% rename from docs/input/docs/report-formats/generic/examples/index.cshtml rename to docs/docs/documentation/report-formats/generic/examples/index.cshtml diff --git a/docs/docs/documentation/report-formats/generic/features.md b/docs/docs/documentation/report-formats/generic/features.md new file mode 100644 index 000000000..a5c6c1cf3 --- /dev/null +++ b/docs/docs/documentation/report-formats/generic/features.md @@ -0,0 +1,16 @@ +--- +title: Features +description: Features of the Cake.Issues.Reporting.Generic addin. +--- + +The [Cake.Issues.Reporting.Generic addin](https://cakebuild.net/extensions/cake-issues-reporting-generic/){target="_blank"} +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 + +!!! info + See [Template Gallery] for a list of available out of the box and 3rd party templates. + +[Template Gallery]: templates/index.md diff --git a/docs/docs/documentation/report-formats/generic/index.md b/docs/docs/documentation/report-formats/generic/index.md new file mode 100644 index 000000000..0f41812d7 --- /dev/null +++ b/docs/docs/documentation/report-formats/generic/index.md @@ -0,0 +1,7 @@ +--- +title: Generic +description: Report format to create reports in any text based format (HTML, Markdown, ...). +--- + +Support for creating reports in any text based format like HTML or Markdown is implemented in the +[Cake.Issues.Reporting.Generic addin](https://www.nuget.org/packages/Cake.Issues.Reporting.Generic). diff --git a/docs/input/docs/report-formats/generic/templates/htmldatatable-demo-default.html b/docs/docs/documentation/report-formats/generic/templates/htmldatatable-demo-default.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldatatable-demo-default.html rename to docs/docs/documentation/report-formats/generic/templates/htmldatatable-demo-default.html diff --git a/docs/docs/documentation/report-formats/generic/templates/htmldatatable.md b/docs/docs/documentation/report-formats/generic/templates/htmldatatable.md new file mode 100644 index 000000000..f64d900be --- /dev/null +++ b/docs/docs/documentation/report-formats/generic/templates/htmldatatable.md @@ -0,0 +1,53 @@ +--- +title: HTML Data Table +description: Template for a HTML report containing a rich data table view with sorting and search functionality. +--- + +Template for a HTML report containing a rich data table view with sorting and search functionality powered by +[Simple-DataTables](https://github.com/fiduswriter/Simple-DataTables){target="_blank"}. + +![HTML Data Table](htmldatatable01.png "HTML Data Table") + +## Features + +* Separate table for issues of each issue provider. +* Table with `Severity`, `Project`, `Path`, `File`, `Location`, `Rule`, `Message`. +* Each column sortable by user. +* Paged table with possibility for user to change number of entries per page. +* Client-side full text search. +* No internet access required for displaying. + +## Requirements + +* Cake.Issues.Reporting.Generic 0.2.1 or higher + +## Usage + +To create a report using the HTML Data Table template you can use the +[GenericIssueReportTemplate.HtmlDataTable](https://cakebuild.net/api/Cake.Issues.Reporting.Generic/GenericIssueReportTemplate/62ADE81F){target="_blank"} +enum value: + +```csharp +CreateIssueReport( + issues, + GenericIssueReportFormatFromEmbeddedTemplate(GenericIssueReportTemplate.HtmlDataTable), + @"c:\repo", + @"c:\report.html"); +``` + +## Options + +This template doesn't support any options. + +## Demos + +* [Default](htmldatatable-demo-default.html){target="_blank"} + +## Source Code + +!!! info + You can use the source code as a template for your [custom template]. + +Source code is available on [GitHub](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/src/Cake.Issues.Reporting.Generic/Templates/DataTable.cshtml){target="_blank"}. + +[custom template]: ../examples/custom-template.md diff --git a/docs/input/docs/report-formats/generic/templates/htmldatatable01.png b/docs/docs/documentation/report-formats/generic/templates/htmldatatable01.png similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldatatable01.png rename to docs/docs/documentation/report-formats/generic/templates/htmldatatable01.png diff --git a/docs/input/docs/report-formats/generic/templates/htmldiagnostic-demo-default.html b/docs/docs/documentation/report-formats/generic/templates/htmldiagnostic-demo-default.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldiagnostic-demo-default.html rename to docs/docs/documentation/report-formats/generic/templates/htmldiagnostic-demo-default.html diff --git a/docs/docs/documentation/report-formats/generic/templates/htmldiagnostic.md b/docs/docs/documentation/report-formats/generic/templates/htmldiagnostic.md new file mode 100644 index 000000000..d83278ba6 --- /dev/null +++ b/docs/docs/documentation/report-formats/generic/templates/htmldiagnostic.md @@ -0,0 +1,48 @@ +--- +title: HTML Diagnostic +description: Template for a HTML report containing a list of all issues with all properties. +--- + +Template for a HTML report containing a list of all issues with all properties. + +![HTML Diagnostic](htmldiagnostic01.png "HTML Diagnostic") + +## Features + +* Unstyled table listing all properties of [IIssue](https://cakebuild.net/api/Cake.Issues/IIssue/){target="_blank"} +* No internet access required for displaying. + +## Requirements + +* No additional requirements. + +## Usage + +To create a report using the HTML diagnostic template you can use the +[GenericIssueReportTemplate.HtmlDiagnostic](https://cakebuild.net/api/Cake.Issues.Reporting.Generic/GenericIssueReportTemplate/4F88BD05){target="_blank"} +enum value: + +```csharp +CreateIssueReport( + issues, + GenericIssueReportFormatFromEmbeddedTemplate(GenericIssueReportTemplate.HtmlDiagnostic), + @"c:\repo", + @"c:\report.html"); +``` + +## Options + +This template doesn't support any options. + +## Demos + +* [Default](htmldiagnostic-demo-default.html){target="_blank"} + +## Source Code + +!!! info + You can use the source code as a template for your [custom template]. + +Source code is available on [GitHub](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/src/Cake.Issues.Reporting.Generic/Templates/Diagnostic.cshtml){target="_blank"}. + +[custom template]: ../examples/custom-template.md diff --git a/docs/input/docs/report-formats/generic/templates/htmldiagnostic01.png b/docs/docs/documentation/report-formats/generic/templates/htmldiagnostic01.png similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldiagnostic01.png rename to docs/docs/documentation/report-formats/generic/templates/htmldiagnostic01.png diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-additionalcolumns.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-additionalcolumns.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-additionalcolumns.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-additionalcolumns.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-changetitle.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-changetitle.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-changetitle.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-changetitle.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-columnhiding.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-columnhiding.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-columnhiding.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-columnhiding.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-customexportfilename.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-customexportfilename.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-customexportfilename.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-customexportfilename.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-customscriptlocation.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-customscriptlocation.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-customscriptlocation.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-customscriptlocation.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-default.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-default.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-default.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-default.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-disablefiltering.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-disablefiltering.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-disablefiltering.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-disablefiltering.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-disablegrouping.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-disablegrouping.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-disablegrouping.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-disablegrouping.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-disableheader.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-disableheader.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-disableheader.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-disableheader.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-disablesearching.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-disablesearching.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-disablesearching.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-disablesearching.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-enableexporting.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-enableexporting.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-enableexporting.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-enableexporting.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-exportformat-pdf.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-exportformat-pdf.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-exportformat-pdf.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-exportformat-pdf.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-exportformat-xlsx.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-exportformat-xlsx.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-exportformat-xlsx.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-exportformat-xlsx.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-grouping.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-grouping.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-grouping.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-grouping.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-sorting.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-sorting.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-sorting.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-sorting.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-carmine.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-carmine.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-carmine.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-carmine.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-contrast.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-contrast.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-contrast.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-contrast.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-contrastcompact.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-contrastcompact.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-contrastcompact.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-contrastcompact.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-dark.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-dark.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-dark.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-dark.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-darkcompact.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-darkcompact.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-darkcompact.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-darkcompact.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-darkmoon.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-darkmoon.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-darkmoon.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-darkmoon.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-darkviolet.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-darkviolet.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-darkviolet.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-darkviolet.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-greenmist.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-greenmist.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-greenmist.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-greenmist.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-light.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-light.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-light.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-light.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-lightcompact.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-lightcompact.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-lightcompact.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-lightcompact.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialbluedark.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialbluedark.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialbluedark.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialbluedark.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialbluedarkcompact.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialbluedarkcompact.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialbluedarkcompact.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialbluedarkcompact.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialbluelight.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialbluelight.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialbluelight.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialbluelight.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialbluelightcompact.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialbluelightcompact.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialbluelightcompact.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialbluelightcompact.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materiallimedark.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materiallimedark.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materiallimedark.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materiallimedark.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materiallimedarkcompact.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materiallimedarkcompact.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materiallimedarkcompact.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materiallimedarkcompact.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materiallimelight.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materiallimelight.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materiallimelight.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materiallimelight.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materiallimelightcompact.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materiallimelightcompact.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materiallimelightcompact.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materiallimelightcompact.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialorangedark.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialorangedark.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialorangedark.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialorangedark.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialorangedarkcompact.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialorangedarkcompact.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialorangedarkcompact.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialorangedarkcompact.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialorangelight.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialorangelight.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialorangelight.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialorangelight.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialorangelightcompact.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialorangelightcompact.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialorangelightcompact.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialorangelightcompact.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialpurpledark.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialpurpledark.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialpurpledark.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialpurpledark.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialpurpledarkcompact.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialpurpledarkcompact.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialpurpledarkcompact.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialpurpledarkcompact.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialpurplelight.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialpurplelight.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialpurplelight.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialpurplelight.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialpurplelightcompact.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialpurplelightcompact.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialpurplelightcompact.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialpurplelightcompact.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialtealdark.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialtealdark.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialtealdark.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialtealdark.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialtealdarkcompact.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialtealdarkcompact.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialtealdarkcompact.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialtealdarkcompact.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialteallight.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialteallight.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialteallight.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialteallight.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialteallightcompact.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialteallightcompact.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialteallightcompact.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-materialteallightcompact.html diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-softblue.html b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-softblue.html similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid-demo-theme-softblue.html rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid-demo-theme-softblue.html diff --git a/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid.md b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid.md new file mode 100644 index 000000000..21ff714e6 --- /dev/null +++ b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid.md @@ -0,0 +1,239 @@ +--- +title: HTML DevExtreme Data Grid +description: Template for a HTML report containing a rich data grid with sorting, filtering, grouping and search capabilities. +--- + +Template for a HTML report containing a rich data grid with sorting, filtering, grouping and search capabilities powered by [DevExtreme]. + +![HTML DevExtreme Data Grid](htmldxdatagrid01.png "HTML DevExtreme Data Grid") + +## Features + +* Table with `Provider`, `Severity`, `Project`, `Path`, `File`, `Location`, `Rule`, `Message` by default. +* Support for grouping by multiple columns by user. +* Total number of issues by each group level. +* Each column sortable by user. +* Data can be filtered by any column by user. +* Paged view. +* Client-side full text search. +* Client-side export to Microsoft Excel or PDF. +* Fully customizable through [options](#options). + +## Requirements + +* Cake.Issues.Reporting.Generic 0.3.1 or higher + +## Usage + +To create a report using the HTML DevExtreme Data Grid template you can use the [GenericIssueReportTemplate.HtmlDxDataGrid] enum value: + +```csharp +CreateIssueReport( + issues, + GenericIssueReportFormatFromEmbeddedTemplate(GenericIssueReportTemplate.HtmlDxDataGrid), + @"c:\repo", + @"c:\report.html"); +``` + +## Options + +See [HtmlDxDataGridOption] for a list of possible options. + +## Demos + +The following demo shows the template with its default options: + +* [Default](htmldxdatagrid-demo-default.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-default.cake){target="_blank"}) + +### Themes + +The template supports the teams defined in the [DevExtremeTheme] enumeration which can be set using the [HtmlDxDataGridOption.Theme]: + +```csharp +CreateIssueReport( + issues, + GenericIssueReportFormatFromEmbeddedTemplate( + GenericIssueReportTemplate.HtmlDxDataGrid, + settings => settings.WithOption(HtmlDxDataGridOption.Theme, DevExtremeTheme.MaterialBlueLight)), + @"c:\repo", + @"c:\report.html"); +``` + +* [Light Theme](htmldxdatagrid-demo-theme-light.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-light.cake){target="_blank"}) +* [Dark Theme](htmldxdatagrid-demo-theme-dark.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-dark.cake){target="_blank"}) +* [Contrast Theme](htmldxdatagrid-demo-theme-contrast.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-contrast.cake){target="_blank"}) +* [Carmine Theme](htmldxdatagrid-demo-theme-carmine.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-carmine.cake){target="_blank"}) +* [Dark Moon Theme](htmldxdatagrid-demo-theme-darkmoon.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-darkmoon.cake){target="_blank"}) +* [Soft Blue Theme](htmldxdatagrid-demo-theme-softblue.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-softblue.cake){target="_blank"}) +* [Dark Violet Theme](htmldxdatagrid-demo-theme-darkviolet.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-darkviolet.cake){target="_blank"}) +* [Green Mist Theme](htmldxdatagrid-demo-theme-greenmist.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-greenmist.cake){target="_blank"}) +* [Light Compact Theme](htmldxdatagrid-demo-theme-lightcompact.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-lightcompact.cake){target="_blank"}) +* [Dark Compact Theme](htmldxdatagrid-demo-theme-darkcompact.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-darkcompact.cake){target="_blank"}) +* [Contrast Compact Theme](htmldxdatagrid-demo-theme-contrastcompact.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-contrastcompact.cake){target="_blank"}) +* [Material Blue Light Theme](htmldxdatagrid-demo-theme-materialbluelight.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-materialbluelight.cake){target="_blank"}) +* [Material Lime Light Theme](htmldxdatagrid-demo-theme-materiallimelight.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-materiallimelight.cake){target="_blank"}) +* [Material Orange Light Theme](htmldxdatagrid-demo-theme-materialorangelight.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-materialorangelight.cake){target="_blank"}) +* [Material Purple Light Theme](htmldxdatagrid-demo-theme-materialpurplelight.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-materialpurplelight.cake){target="_blank"}) +* [Material Teal Light Theme](htmldxdatagrid-demo-theme-materialteallight.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-materialteallight.cake){target="_blank"}) +* [Material Blue Dark Theme](htmldxdatagrid-demo-theme-materialbluedark.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-materialbluedark.cake){target="_blank"}) +* [Material Lime Dark Theme](htmldxdatagrid-demo-theme-materiallimedark.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-materiallimedark.cake){target="_blank"}) +* [Material Orange Dark Theme](htmldxdatagrid-demo-theme-materialorangedark.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-materialorangedark.cake){target="_blank"}) +* [Material Purple Dark Theme](htmldxdatagrid-demo-theme-materialpurpledark.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-materialpurpledark.cake){target="_blank"}) +* [Material Teal Dark Theme](htmldxdatagrid-demo-theme-materialtealdark.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-materialtealdark.cake){target="_blank"}) +* [Material Blue Light Compact Theme](htmldxdatagrid-demo-theme-materialbluelightcompact.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-materialbluelightcompact.cake){target="_blank"}) +* [Material Lime Light Compact Theme](htmldxdatagrid-demo-theme-materiallimelightcompact.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-materiallimelightcompact.cake){target="_blank"}) +* [Material Orange Light Compact Theme](htmldxdatagrid-demo-theme-materialorangelightcompact.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-materialorangelightcompact.cake){target="_blank"}) +* [Material Purple Light Compact Theme](htmldxdatagrid-demo-theme-materialpurplelightcompact.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-materialpurplelightcompact.cake){target="_blank"}) +* [Material Teal Light Compact Theme](htmldxdatagrid-demo-theme-materialteallightcompact.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-materialteallightcompact.cake){target="_blank"}) +* [Material Blue Dark Compact Theme](htmldxdatagrid-demo-theme-materialbluedarkcompact.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-materialbluedarkcompact.cake){target="_blank"}) +* [Material Lime Dark Compact Theme](htmldxdatagrid-demo-theme-materiallimedarkcompact.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-materiallimedarkcompact.cake){target="_blank"}) +* [Material Orange Dark Compact Theme](htmldxdatagrid-demo-theme-materialorangedarkcompact.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-materialorangedarkcompact.cake){target="_blank"}) +* [Material Purple Dark Compact Theme](htmldxdatagrid-demo-theme-materialpurpledarkcompact.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-materialpurpledarkcompact.cake){target="_blank"}) +* [Material Teal Dark Compact Theme](htmldxdatagrid-demo-theme-materialtealdarkcompact.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-theme-materialtealdarkcompact.cake){target="_blank"}) + +### Column visibility + +Visible columns can be defined using the `ColumnNameVisible` option: + +```csharp +CreateIssueReport( + issues, + GenericIssueReportFormatFromEmbeddedTemplate( + GenericIssueReportTemplate.HtmlDxDataGrid, + settings => settings.WithOption(HtmlDxDataGridOption.LineVisible, false)), + @"c:\repo", + @"c:\report.html"); +``` + +Additional columns can be added using the [HtmlDxDataGridOption.AdditionalColumns] option. + +* [Show and hide columns](htmldxdatagrid-demo-columnhiding.html) + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-hide-columns.cake)) +* [Add additional columns](htmldxdatagrid-demo-additionalcolumns.html) + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-additional-columns.cake)) + +### Sorting + +Sorted columns can be defined using the [HtmlDxDataGridOption.SortedColumns] and the +`ColumnNameSortOder` options: + +```csharp +CreateIssueReport( + issues, + GenericIssueReportFormatFromEmbeddedTemplate( + GenericIssueReportTemplate.HtmlDxDataGrid, + settings => settings + .WithOption(HtmlDxDataGridOption.SortedColumns, new List { ReportColumn.RuleId }) + .WithOption(HtmlDxDataGridOption.RuleIdSortOder, ColumnSortOderDescending )), + @"c:\repo", + @"c:\report.html"); +``` + +* [Change sorting](htmldxdatagrid-demo-sorting.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-sorting.cake){target="_blank"}) + +### Grouping + +Grouping can be defined using the [HtmlDxDataGridOption.GroupedColumns] option: + +```csharp +CreateIssueReport( + issues, + GenericIssueReportFormatFromEmbeddedTemplate( + GenericIssueReportTemplate.HtmlDxDataGrid, + settings => settings.WithOption(HtmlDxDataGridOption.GroupedColumns, new List { ReportColumn.RuleId })), + @"c:\repo", + @"c:\report.html"); +``` + +* [Change grouping](htmldxdatagrid-demo-grouping.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-grouping.cake){target="_blank"}) +* [Disable grouping](htmldxdatagrid-demo-disablegrouping.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-disable-grouping.cake){target="_blank"}) + +### Exporting + +Exporting can be enabled using the [HtmlDxDataGridOption.EnableExporting] option: + +```csharp +CreateIssueReport( + issues, + GenericIssueReportFormatFromEmbeddedTemplate( + GenericIssueReportTemplate.HtmlDxDataGrid, + settings => settings.WithOption(HtmlDxDataGridOption.EnableExporting, true)), + @"c:\repo", + @"c:\report.html"); +``` + +* [Enable exporting](htmldxdatagrid-demo-enableexporting.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-enable-exporting.cake){target="_blank"}) +* [Microsoft Excel export (*.xlsx)](htmldxdatagrid-demo-exportformat-xlsx.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-exportformat-xlsx.cake){target="_blank"}) +* [PDF export (*.pdf)](htmldxdatagrid-demo-exportformat-pdf.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-exportformat-pdf.cake){target="_blank"}) +* [Custom export file name](htmldxdatagrid-demo-customexportfilename.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-custom-export-filename.cake){target="_blank"}) + +### Other features + +* [Change title](htmldxdatagrid-demo-changetitle.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-change-title.cake){target="_blank"}) +* [Disable header](htmldxdatagrid-demo-disableheader.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-disable-header.cake){target="_blank"}) +* [Disable filtering](htmldxdatagrid-demo-disablefiltering.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-disable-filtering.cake){target="_blank"}) +* [Disable searching](htmldxdatagrid-demo-disablesearching.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-disable-searching.cake){target="_blank"}) +* [Custom script location and version](htmldxdatagrid-demo-customscriptlocation.html){target="_blank"} + ([Source Code](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/demos/script-runner/build/create-reports/create-reports-htmldxdatagrid-custom-script-location.cake){target="_blank"}) + +## Source Code + +!!! info + You can use the source code as a template for your [custom template]. + +Source code is available on [GitHub]. + +[DevExtreme]: https://js.devexpress.com +[GenericIssueReportTemplate.HtmlDxDataGrid]: https://cakebuild.net/api/Cake.Issues.Reporting.Generic/GenericIssueReportTemplate/0E9E9D94 +[HtmlDxDataGridOption]: https://cakebuild.net/api/Cake.Issues.Reporting.Generic/HtmlDxDataGridOption/ +[DevExtremeTheme]: https://cakebuild.net/api/Cake.Issues.Reporting.Generic/DevExtremeTheme/ +[HtmlDxDataGridOption.Theme]: https://cakebuild.net/api/Cake.Issues.Reporting.Generic/HtmlDxDataGridOption/EA83DCAB +[HtmlDxDataGridOption.AdditionalColumns]: https://cakebuild.net/api/Cake.Issues.Reporting.Generic/HtmlDxDataGridOption/F9860912 +[HtmlDxDataGridOption.SortedColumns]: https://cakebuild.net/api/Cake.Issues.Reporting.Generic/HtmlDxDataGridOption/D578E453 +[HtmlDxDataGridOption.GroupedColumns]: https://cakebuild.net/api/Cake.Issues.Reporting.Generic/HtmlDxDataGridOption/0907599C +[HtmlDxDataGridOption.EnableExporting]: https://cakebuild.net/api/Cake.Issues.Reporting.Generic/HtmlDxDataGridOption/1441E285 +[custom template]: ../examples/custom-template.md +[GitHub]: https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/src/Cake.Issues.Reporting.Generic/Templates/DxDataGrid.cshtml diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid01.png b/docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid01.png similarity index 100% rename from docs/input/docs/report-formats/generic/templates/htmldxdatagrid01.png rename to docs/docs/documentation/report-formats/generic/templates/htmldxdatagrid01.png diff --git a/docs/docs/documentation/report-formats/generic/templates/index.md b/docs/docs/documentation/report-formats/generic/templates/index.md new file mode 100644 index 000000000..aaf0bc414 --- /dev/null +++ b/docs/docs/documentation/report-formats/generic/templates/index.md @@ -0,0 +1,4 @@ +--- +title: Template Gallery +description: Gallery of available out of the box and 3rd party templates. +--- diff --git a/docs/docs/documentation/report-formats/index.md b/docs/docs/documentation/report-formats/index.md new file mode 100644 index 000000000..c0287e92b --- /dev/null +++ b/docs/docs/documentation/report-formats/index.md @@ -0,0 +1,4 @@ +--- +title: Report Formats +description: Documentation of the different report format addins. +--- diff --git a/docs/input/docs/report-formats/sarif/examples.md b/docs/docs/documentation/report-formats/sarif/examples.md similarity index 75% rename from docs/input/docs/report-formats/sarif/examples.md rename to docs/docs/documentation/report-formats/sarif/examples.md index 31b231753..14524a177 100644 --- a/docs/input/docs/report-formats/sarif/examples.md +++ b/docs/docs/documentation/report-formats/sarif/examples.md @@ -1,16 +1,15 @@ --- -Order: 30 -Title: Examples -Description: Examples for using the Cake.Issues.Reporting.Sarif addin. +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. +!!! 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. -::: + See [pinning addin versions](https://cakebuild.net/docs/writing-builds/reproducible-builds/){target="_blank"} for details. ```csharp #tool "nuget:?package=MSBuild.Extension.Pack" @@ -48,4 +47,4 @@ Task("Create-IssueReport").Does(() => repoRootFolder, @"c:\report.sarif"); }); -``` \ No newline at end of file +``` diff --git a/docs/docs/documentation/report-formats/sarif/features.md b/docs/docs/documentation/report-formats/sarif/features.md new file mode 100644 index 000000000..2e6759412 --- /dev/null +++ b/docs/docs/documentation/report-formats/sarif/features.md @@ -0,0 +1,19 @@ +--- +title: Features +description: Features of the Cake.Issues.Reporting.Sarif addin. +--- + +The [Cake.Issues.Reporting.Sarif addin] provides the following features: + +* Creates SARIF compatible files. + +Supports the following properties in the SARIF report: + +* RuleId +* Message +* Kind +* Level +* Location +* RuleUrl + +[Cake.Issues.Reporting.Sarif addin]: https://www.nuget.org/packages/Cake.Issues.Reporting.Sarif diff --git a/docs/docs/documentation/report-formats/sarif/index.md b/docs/docs/documentation/report-formats/sarif/index.md new file mode 100644 index 000000000..269ddee5b --- /dev/null +++ b/docs/docs/documentation/report-formats/sarif/index.md @@ -0,0 +1,7 @@ +--- +title: Sarif +description: Report format to create SARIF compatible reports. +--- + +Support for creating SARIF compatible reports is implemented in the +[Cake.Issues.Reporting.Sarif addin](https://www.nuget.org/packages/Cake.Issues.Reporting.Sarif). diff --git a/docs/input/docs/resources/blog-posts.md b/docs/docs/documentation/resources/blog-posts.md similarity index 57% rename from docs/input/docs/resources/blog-posts.md rename to docs/docs/documentation/resources/blog-posts.md index 935648bfa..8de6821f6 100644 --- a/docs/input/docs/resources/blog-posts.md +++ b/docs/docs/documentation/resources/blog-posts.md @@ -1,19 +1,17 @@ --- -Order: 10 -Title: Blog posts -Description: Blog posts about the Cake Issues addins. +title: Blog posts +description: Blog posts about the Cake Issues addins. --- -:::{.alert .alert-info} -If you have written about Cake Issues we would like to hear from you. -You can add it by creating a pull request [here](https://github.com/cake-contrib/Cake.Issues.Website/tree/develop/input/docs/resources/blog-posts.md). -::: +!!! info + If you have written about Cake Issues we would like to hear from you. + You can add it by creating a pull request [here](https://github.com/cake-contrib/Cake.Issues.Website/tree/develop/input/docs/resources/blog-posts.md). -# 2018 +## 2018 * [Cake.Issues - A suite of addins for issue handling in Cake](https://cakebuild.net/blog/2018/06/cake-issues) - Pascal Berger -# 2017 +## 2017 * [Finding typos with ReSharper Command Line Tools, ReSpeller and Cake](https://tpodolak.com/blog/2017/10/27/finding-typos-resharper-command-line-tools-respeller-cake/) - Tom Podolak * [Cake build issue reporting with PRCA](https://blog.ostebaronen.dk/2017/08/cake-build-issue-reporting-with-prca.html) - Tomasz Cielecki \ No newline at end of file diff --git a/docs/input/docs/resources/presentations.md b/docs/docs/documentation/resources/presentations.md similarity index 55% rename from docs/input/docs/resources/presentations.md rename to docs/docs/documentation/resources/presentations.md index 173ecd1fa..a1f8259dc 100644 --- a/docs/input/docs/resources/presentations.md +++ b/docs/docs/documentation/resources/presentations.md @@ -1,18 +1,16 @@ --- -Order: 20 -Title: Presentations -Description: Presentations about the Cake Issues addins. +title: Presentations +description: Presentations about the Cake Issues addins. --- -:::{.alert .alert-info} -If you have done a presentation about Cake Issues we would like to hear from you. -You can add it by creating a pull request [here](https://github.com/cake-contrib/Cake.Issues.Website/tree/develop/input/docs/resources/presentations.md). -::: +!!! info + If you have done a presentation about Cake Issues we would like to hear from you. + You can add it by creating a pull request [here](https://github.com/cake-contrib/Cake.Issues.Website/tree/develop/input/docs/resources/presentations.md). -# 2019 +## 2019 * Continuous Code Inspection using Cake - .NET User Group Basel: [Video](https://www.youtube.com/watch?v=tZ6hdBrj81s) [Slides](https://gitpitch.com/pascalberger/Cake.Issues-Presentation/20190212-dotnet-usergroup-basel#/) - Pascal Berger -# 2018 +## 2018 * [Ensuring quality in your DevOps pipelines using Cake - Azure DevOps Saturday Gothenburg](https://gitpitch.com/pascalberger/Cake.Issues-Presentation/20180929-azure-devops-saturday-gothenburg) - Pascal Berger \ No newline at end of file diff --git a/docs/input/docs/usage/creating-issues/creating-issues.md b/docs/docs/documentation/usage/creating-issues/creating-issues.md similarity index 66% rename from docs/input/docs/usage/creating-issues/creating-issues.md rename to docs/docs/documentation/usage/creating-issues/creating-issues.md index a959e1d3b..86010308d 100644 --- a/docs/input/docs/usage/creating-issues/creating-issues.md +++ b/docs/docs/documentation/usage/creating-issues/creating-issues.md @@ -1,8 +1,8 @@ --- -Order: 10 -Title: Creating issues -Description: Usage instructions how to create issues. +title: Creating issues +description: Usage instructions how to create issues. --- + The `Cake.Issues` addin can be used to create issues directly in the build script. This issues can for example be used to create reports. @@ -12,12 +12,11 @@ To create issues you need to import the following core addin: #addin "Cake.Issues" ``` -:::{.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. +!!! 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. -::: + See [pinning addin versions](https://cakebuild.net/docs/writing-builds/reproducible-builds/){target="_blank"} for details. In the following task a new warning for the myfile.txt file on line 42 is created: @@ -37,4 +36,4 @@ Task("Create-Issue").Does(() => Information("Issue created with message: {0}", issues.MessageText); }); -``` \ No newline at end of file +``` diff --git a/docs/input/docs/usage/creating-reports/creating-reports.md b/docs/docs/documentation/usage/creating-reports/creating-reports.md similarity index 69% rename from docs/input/docs/usage/creating-reports/creating-reports.md rename to docs/docs/documentation/usage/creating-reports/creating-reports.md index e093dc134..7aa1c8aea 100644 --- a/docs/input/docs/usage/creating-reports/creating-reports.md +++ b/docs/docs/documentation/usage/creating-reports/creating-reports.md @@ -1,8 +1,8 @@ --- -Order: 10 -Title: Creating reports -Description: Usage instructions how to create reports. +title: Creating reports +description: Usage instructions how to create reports. --- + To create report for issues you need to import the following core addins: ```csharp @@ -19,12 +19,11 @@ and generic report format is imported: #addin "Cake.Issues.Reporting.Generic" ``` -:::{.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. +!!! 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. -::: + See [pinning addin versions](https://cakebuild.net/docs/writing-builds/reproducible-builds/){target="_blank"} for details. Finally you can define a task where you call the reporting addin with the desired issue provider and report format: @@ -40,4 +39,4 @@ Task("Create-Report").Does(() => repoRootFolder, @"c:\report.html"); }); -``` \ No newline at end of file +``` diff --git a/docs/docs/documentation/usage/creating-reports/index.md b/docs/docs/documentation/usage/creating-reports/index.md new file mode 100644 index 000000000..d54f26e7e --- /dev/null +++ b/docs/docs/documentation/usage/creating-reports/index.md @@ -0,0 +1,6 @@ +--- +title: Creating Reports +description: How to create reports using Cake.Issues.Reporting. +--- + +For report format specific examples see [Report Format Examples](../../report-formats/index.md). diff --git a/docs/docs/documentation/usage/index.md b/docs/docs/documentation/usage/index.md new file mode 100644 index 000000000..bd8e97953 --- /dev/null +++ b/docs/docs/documentation/usage/index.md @@ -0,0 +1,6 @@ +--- +title: Usage +description: How to obtain, configure, and use Cake.Issues. +--- + +How to obtain, configure, and use Cake.Issues. diff --git a/docs/input/docs/usage/reading-issues/file-linking.md b/docs/docs/documentation/usage/reading-issues/file-linking.md similarity index 90% rename from docs/input/docs/usage/reading-issues/file-linking.md rename to docs/docs/documentation/usage/reading-issues/file-linking.md index 0870ee7b9..1798021e0 100644 --- a/docs/input/docs/usage/reading-issues/file-linking.md +++ b/docs/docs/documentation/usage/reading-issues/file-linking.md @@ -1,8 +1,8 @@ --- -Order: 30 -Title: File linking -Description: Example how to define file link settings. +title: File linking +description: Example how to define file link settings. --- + File link settings can be defined while reading issues and are passed through the `IIssue.FileLink` property to reporting formats, pull request systems and build server implementations: diff --git a/docs/docs/documentation/usage/reading-issues/index.md b/docs/docs/documentation/usage/reading-issues/index.md new file mode 100644 index 000000000..56444a43a --- /dev/null +++ b/docs/docs/documentation/usage/reading-issues/index.md @@ -0,0 +1,6 @@ +--- +title: Reading Issues +description: How to read issues using Cake.Issues. +--- + +For issue provider specific examples see [Issue Provider Examples](../../issue-providers/index.md). diff --git a/docs/input/docs/usage/reading-issues/reading-issues.md b/docs/docs/documentation/usage/reading-issues/reading-issues.md similarity index 68% rename from docs/input/docs/usage/reading-issues/reading-issues.md rename to docs/docs/documentation/usage/reading-issues/reading-issues.md index ab3ad10ea..a14250a9f 100644 --- a/docs/input/docs/usage/reading-issues/reading-issues.md +++ b/docs/docs/documentation/usage/reading-issues/reading-issues.md @@ -1,8 +1,8 @@ --- -Order: 10 -Title: Reading issues -Description: Usage instructions how to read issues. +title: Reading issues +description: Usage instructions how to read issues. --- + The `Cake.Issues` addin can be used to aggregate issues from different sources. This can for example be useful to break builds based on the reported issues. @@ -21,16 +21,15 @@ and from JetBrains InspectCode are imported: #addin "Cake.Issues.InspectCode" ``` -:::{.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. +!!! 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. -::: + See [pinning addin versions](https://cakebuild.net/docs/writing-builds/reproducible-builds/){target="_blank"} for details. Finally you can define a task where you call the core addin with the desired issue providers. The following example reads issues reported as MsBuild warnings by the `XmlFileLogger` -class from [MSBuild Extension Pack] and issues reported by JetBrains InspectCode: +class from [MSBuild Extension Pack](http://www.msbuildextensionpack.com/){target="_blank"} and issues reported by JetBrains InspectCode: ```csharp Task("Read-Issues").Does(() => @@ -50,5 +49,3 @@ Task("Read-Issues").Does(() => Information("{0} issues are found.", issues.Count()); }); ``` - -[MSBuild Extension Pack]: http://www.msbuildextensionpack.com/ \ No newline at end of file diff --git a/docs/input/docs/usage/reading-issues/run-information.md b/docs/docs/documentation/usage/reading-issues/run-information.md similarity index 92% rename from docs/input/docs/usage/reading-issues/run-information.md rename to docs/docs/documentation/usage/reading-issues/run-information.md index 9af71d1a1..7535768f4 100644 --- a/docs/input/docs/usage/reading-issues/run-information.md +++ b/docs/docs/documentation/usage/reading-issues/run-information.md @@ -1,8 +1,8 @@ --- -Order: 20 -Title: Additional run information -Description: Example how to add run specific information. +title: Additional run information +description: Example how to add run specific information. --- + If a build script needs to parse multiple log files from the same tool, e.g. because multiple MsBuild solutions were built, this can be done by calling the issue provider multiple times. If the results are read into the same list and shown on the same report, diff --git a/docs/docs/documentation/usage/recipe/index.md b/docs/docs/documentation/usage/recipe/index.md new file mode 100644 index 000000000..df434914f --- /dev/null +++ b/docs/docs/documentation/usage/recipe/index.md @@ -0,0 +1,8 @@ +--- +title: Recipe +description: How to use the pre-made recipe script. +--- + +Examples how to use Cake.Issues recipes can be found under [Recipe Usage]. + +[Recipe Usage]: ../../recipe/usage/index.md diff --git a/docs/input/docs/usage/reporting-issues-to-pull-requests/custom-issue-filter.md b/docs/docs/documentation/usage/reporting-issues-to-pull-requests/custom-issue-filter.md similarity index 56% rename from docs/input/docs/usage/reporting-issues-to-pull-requests/custom-issue-filter.md rename to docs/docs/documentation/usage/reporting-issues-to-pull-requests/custom-issue-filter.md index f734b0d67..b17c27373 100644 --- a/docs/input/docs/usage/reporting-issues-to-pull-requests/custom-issue-filter.md +++ b/docs/docs/documentation/usage/reporting-issues-to-pull-requests/custom-issue-filter.md @@ -1,26 +1,24 @@ --- -Order: 20 -Title: Custom issue filter -Description: Usage instructions how to apply custom filters to issues. +title: Custom issue filter +description: Usage instructions how to apply custom filters to issues. --- + You can define custom filters which are applied to issues before they are posted as comments to pull requests. -:::{.alert .alert-info} -You can use a custom filter to only have issues introduced with the current code posted to the pull request. +!!! info + You can use a custom filter to only have issues introduced with the current code posted to the pull request. -For this you need to store your log files as artifacts on your build system, then you can define a custom filter -which retrieves the logs from the previous build, parses them using the appropriate issue provider and filters -out any issues which were already existing in the previous build. -::: + For this you need to store your log files as artifacts on your build system, then you can define a custom filter + which retrieves the logs from the previous build, parses them using the appropriate issue provider and filters + out any issues which were already existing in the previous build. The following example will filter out all issues from the rule `CA1000` from being posted to the pull request. -:::{.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. +!!! 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. -::: + See [pinning addin versions](https://cakebuild.net/docs/writing-builds/reproducible-builds/){target="_blank"} for details. ```csharp #addin "Cake.Issues" @@ -50,4 +48,4 @@ Task("ReportIssuesToPullRequest").Does(() => AzureDevOpsAuthenticationNtlm()), settings)); }); -``` \ No newline at end of file +``` diff --git a/docs/docs/documentation/usage/reporting-issues-to-pull-requests/index.md b/docs/docs/documentation/usage/reporting-issues-to-pull-requests/index.md new file mode 100644 index 000000000..53a49e221 --- /dev/null +++ b/docs/docs/documentation/usage/reporting-issues-to-pull-requests/index.md @@ -0,0 +1,6 @@ +--- +title: Reporting Issues To Pull Requests +description: How to report issues to pull requests using Cake.Issues.PullRequests. +--- + +For pull request system specific examples see [Pull Request System Examples](../../pull-request-systems/index.md) diff --git a/docs/input/docs/usage/reporting-issues-to-pull-requests/report-issues-to-pull-requests.md b/docs/docs/documentation/usage/reporting-issues-to-pull-requests/report-issues-to-pull-requests.md similarity index 71% rename from docs/input/docs/usage/reporting-issues-to-pull-requests/report-issues-to-pull-requests.md rename to docs/docs/documentation/usage/reporting-issues-to-pull-requests/report-issues-to-pull-requests.md index 8026224da..edc3f4a2c 100644 --- a/docs/input/docs/usage/reporting-issues-to-pull-requests/report-issues-to-pull-requests.md +++ b/docs/docs/documentation/usage/reporting-issues-to-pull-requests/report-issues-to-pull-requests.md @@ -1,8 +1,8 @@ --- -Order: 10 -Title: Report issues to pull requests -Description: Usage instructions how to report issues to pull requests. +title: Report issues to pull requests +description: Usage instructions how to report issues to pull requests. --- + To use report issues to pull requests you need to import the following core addins: ```csharp @@ -19,12 +19,11 @@ and support for Azure DevOps pull requests is imported: #addin "Cake.Issues.PullRequests.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. +!!! 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. -::: + See [pinning addin versions](https://cakebuild.net/docs/writing-builds/reproducible-builds/){target="_blank"} for details. Finally you can define a task where you call the core addin with the desired issue provider and pull request system: @@ -42,4 +41,4 @@ Task("ReportIssuesToPullRequest").Does(() => AzureDevOpsAuthenticationNtlm()), repoRootFolder); }); -``` \ No newline at end of file +``` diff --git a/docs/docs/index.md b/docs/docs/index.md new file mode 100644 index 000000000..aed741635 --- /dev/null +++ b/docs/docs/index.md @@ -0,0 +1,75 @@ +--- +hide: + - navigation + - toc +layout: default +search: + exclude: true +title: Home +--- + +
+ +- :material-scale-balance:{ .lg .middle } __Open-Source__ + + --- + + Cake Issues is free to use, improve, contribute and distribute. + Source code is available on [GitHub](https://github.com/cake-contrib/Cake.Issues){target="_blank"} under MIT license. + + [:octicons-arrow-right-24: Source code & license](https://github.com/cake-contrib/Cake.Issues){target="_blank"} + +- :material-globe-model:{ .lg .middle } __Rich ecosystem__ + + --- + + Unlike other Cake addins, Cake Issues consists of over 15 different addins, + working together and providing you with over 75 [aliases](https://cakebuild.net/extensions/cake-issues/){target="_blank"} which you can use in your Cake + build scripts to work with issues. + + [:octicons-arrow-right-24: Reference](https://cakebuild.net/extensions/cake-issues/){target="_blank"} + +- :material-wrench:{ .lg .middle } __Supports your tooling__ + + --- + + Read issues from different analyzers, linters or tools. + The growing range of out-of-the-box supported tools include + [MSBuild](documentation/issue-providers/msbuild/index.md), + [JetBrains InspectCode (ReSharper)](documentation/issue-providers/inspectcode/index.md), + [ESLint](documentation/issue-providers/eslint/index.md), + [Markdownlint](documentation/issue-providers/markdownlint/index.md), + [DocFX](documentation/issue-providers/docfx/index.md). + + [:octicons-arrow-right-24: Issue Providers](documentation/issue-providers/index.md) + +- :material-monitor-dashboard:{ .lg .middle } __Reporting__ + + --- + + Cake Issues provides aliases to create reports from the parsed issues. + There's a [generic reporting addin](documentation/report-formats/generic/index.md) which allows to create reports using out-of-the-box or custom Razor templates + and [an addin for creating SARIF compatible files](documentation/report-formats/sarif/index.md). + + [:octicons-arrow-right-24: Report Formats](documentation/report-formats/index.md) + +- :material-eye:{ .lg .middle } __Pull request and build workflow integration__ + + --- + + Issues found on a feature branch can be reported to pull requests or build runs giving developers instant and direct feedback. + There's out of the box support for [Azure DevOps](documentation/pull-request-systems/azure-devops/index.md), + [GitHub Actions](documentation/pull-request-systems/github-actions/index.md) and + [AppVeyor](documentation/pull-request-systems/appveyor/index.md). + + [:octicons-arrow-right-24: Pull Request Systems](documentation/pull-request-systems/index.md) + +- :material-table:{ .lg .middle } __Extensible__ + + --- + + The addins are built in a modular architecture and are providing different [extension points](documentation/extending/index.md) + which allow you to easily enhance it for supporting additional analyzers, linters, report formats and pull request systems. + + [:octicons-arrow-right-24: Documentation](documentation/extending/index.md) +
\ No newline at end of file diff --git a/docs/input/_AddinsLayout.cshtml b/docs/input/_AddinsLayout.cshtml deleted file mode 100644 index 901dae8a9..000000000 --- a/docs/input/_AddinsLayout.cshtml +++ /dev/null @@ -1,20 +0,0 @@ -@{ - Layout = "/_Master.cshtml"; - - ViewData[Keys.Title] = "Addins - " + Model.String(Keys.GroupKey); -} - -@section Infobar { -} - -@section Sidebar { - @Html.Partial("_AddinsSidebar") -} - -
-

@Model.String(Keys.GroupKey)

-
-
- @Html.Partial("_AddinsList", Model.DocumentList(Keys.GroupDocuments)) - @RenderBody() -
\ No newline at end of file diff --git a/docs/input/_AddinsList.cshtml b/docs/input/_AddinsList.cshtml deleted file mode 100644 index 4c72b1297..000000000 --- a/docs/input/_AddinsList.cshtml +++ /dev/null @@ -1,57 +0,0 @@ -@model IEnumerable - -

- This page contains core and third party addins for Cake Issues. - If you want to file an issue for any addin listed here, contact the author of the addin. -

-

- See Reference for a list of aliases provided by these addins. -

-

- If you're an addin author and want your addin listed here, follow the instructions here. -

- -@foreach(IDocument addin in Model) -{ - string description = @addin.String("Description"); - string author = @addin.String("Author"); - string nuget = @addin.String("NuGet"); - string repositoryOwner = @addin.String("repositoryOwner"); - string repositoryName = @addin.String("repositoryName"); - string documentationLink = @addin.String("documentationLink"); - - -
-
-

@addin.String("Name")

-
-
- @if(!string.IsNullOrEmpty(description)) - { -

@description

- } -
- @if(!string.IsNullOrEmpty(author)) - { -
Author
-
@author
- } - @if(!string.IsNullOrEmpty(nuget)) - { -
NuGet
-
@nuget
- } - @if(!string.IsNullOrEmpty(repositoryOwner) && !string.IsNullOrEmpty(repositoryName)) - { -
Repository
-
@(repositoryOwner)/@(repositoryName)
- } - @if(!string.IsNullOrEmpty(documentationLink)) - { -
Documentation
-
Documentation
- } -
-
-
-} \ No newline at end of file diff --git a/docs/input/_AddinsSidebar.cshtml b/docs/input/_AddinsSidebar.cshtml deleted file mode 100644 index 73ce52ff5..000000000 --- a/docs/input/_AddinsSidebar.cshtml +++ /dev/null @@ -1,6 +0,0 @@ -
  • Categories
    • -@foreach(IDocument group in Documents.FromPipeline("AddinCategories")) -{ - string selectedClass = group.String(Keys.GroupKey) == Model.String(Keys.GroupKey) ? "selected" : null; -
  • @group.String(Keys.GroupKey)
    • -} \ No newline at end of file diff --git a/docs/input/_BlogPost.cshtml b/docs/input/_BlogPost.cshtml deleted file mode 100644 index 0a7e7f25c..000000000 --- a/docs/input/_BlogPost.cshtml +++ /dev/null @@ -1,21 +0,0 @@ -@{ - Layout = "/_BlogLayout.cshtml"; -} - -@Html.Partial("_BlogPostDetails") - -@RenderBody() - -
    - -@{ - string sharingLink = Uri.EscapeDataString(Context.GetLink(Model)); - string sharingTitle = Uri.EscapeDataString(Model.String(Keys.Title)); -} - \ No newline at end of file diff --git a/docs/input/_Bottom.cshtml b/docs/input/_Bottom.cshtml deleted file mode 100644 index 884975f85..000000000 --- a/docs/input/_Bottom.cshtml +++ /dev/null @@ -1,66 +0,0 @@ -
    - GitHub -
    - - - - - - - - - \ No newline at end of file diff --git a/docs/input/_Footer.cshtml b/docs/input/_Footer.cshtml deleted file mode 100644 index e4c9d0da1..000000000 --- a/docs/input/_Footer.cshtml +++ /dev/null @@ -1,5 +0,0 @@ -

    - Copyright © BBT Software AG and contributors. -
    - Website generated by Wyam -

    diff --git a/docs/input/_Head.cshtml b/docs/input/_Head.cshtml deleted file mode 100644 index c91ece074..000000000 --- a/docs/input/_Head.cshtml +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/input/_Navbar.cshtml b/docs/input/_Navbar.cshtml deleted file mode 100644 index afa651f5e..000000000 --- a/docs/input/_Navbar.cshtml +++ /dev/null @@ -1,19 +0,0 @@ -
    - -
    - -@{ - List> pages = new List> - { - Tuple.Create("News", Context.GetLink("news")), - Tuple.Create("Documentation", Context.GetLink("docs")), - Tuple.Create("Reference", Context.GetLink("dsl")), - Tuple.Create("Addins", Context.GetLink("addins")), - Tuple.Create("API", Context.GetLink("api/Cake.Issues")) - }; - foreach(Tuple p in pages) - { - string active = Context.GetLink(Document).StartsWith(p.Item2) ? "active" : null; -
  • @Html.Raw(p.Item1)
    • - } -} \ No newline at end of file diff --git a/docs/input/addins/index.cshtml b/docs/input/addins/index.cshtml deleted file mode 100644 index 3ef866c99..000000000 --- a/docs/input/addins/index.cshtml +++ /dev/null @@ -1,12 +0,0 @@ ---- -Title: Addins -NoSidebar: false ---- -@section Infobar { -} - -@section Sidebar { - @Html.Partial("_AddinsSidebar") -} - -@Html.Partial("_AddinsList", Documents["Addins"]) diff --git a/docs/input/assets/css/fonts/glyphicons-halflings-regular.eot b/docs/input/assets/css/fonts/glyphicons-halflings-regular.eot deleted file mode 100644 index b93a4953fff68df523aa7656497ee339d6026d64..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 20127 zcma%hV{j!vx9y2-`@~L8?1^pLwlPU2wr$&<*tR|KBoo`2;LUg6eW-eW-tKDb)vH%` z^`A!Vd<6hNSRMcX|Cb;E|1qflDggj6Kmr)xA10^t-vIc3*Z+F{r%|K(GyE^?|I{=9 zNq`(c8=wS`0!RZy0g3{M(8^tv41d}oRU?8#IBFtJy*9zAN5dcxqGlMZGL>GG%R#)4J zDJ2;)4*E1pyHia%>lMv3X7Q`UoFyoB@|xvh^)kOE3)IL&0(G&i;g08s>c%~pHkN&6 z($7!kyv|A2DsV2mq-5Ku)D#$Kn$CzqD-wm5Q*OtEOEZe^&T$xIb0NUL}$)W)Ck`6oter6KcQG9Zcy>lXip)%e&!lQgtQ*N`#abOlytt!&i3fo)cKV zP0BWmLxS1gQv(r_r|?9>rR0ZeEJPx;Vi|h1!Eo*dohr&^lJgqJZns>&vexP@fs zkPv93Nyw$-kM5Mw^{@wPU47Y1dSkiHyl3dtHLwV&6Tm1iv{ve;sYA}Z&kmH802s9Z zyJEn+cfl7yFu#1^#DbtP7k&aR06|n{LnYFYEphKd@dJEq@)s#S)UA&8VJY@S2+{~> z(4?M();zvayyd^j`@4>xCqH|Au>Sfzb$mEOcD7e4z8pPVRTiMUWiw;|gXHw7LS#U< zsT(}Z5SJ)CRMXloh$qPnK77w_)ctHmgh}QAe<2S{DU^`!uwptCoq!Owz$u6bF)vnb zL`bM$%>baN7l#)vtS3y6h*2?xCk z>w+s)@`O4(4_I{L-!+b%)NZcQ&ND=2lyP+xI#9OzsiY8$c)ys-MI?TG6 zEP6f=vuLo!G>J7F4v|s#lJ+7A`^nEQScH3e?B_jC&{sj>m zYD?!1z4nDG_Afi$!J(<{>z{~Q)$SaXWjj~%ZvF152Hd^VoG14rFykR=_TO)mCn&K$ z-TfZ!vMBvnToyBoKRkD{3=&=qD|L!vb#jf1f}2338z)e)g>7#NPe!FoaY*jY{f)Bf>ohk-K z4{>fVS}ZCicCqgLuYR_fYx2;*-4k>kffuywghn?15s1dIOOYfl+XLf5w?wtU2Og*f z%X5x`H55F6g1>m~%F`655-W1wFJtY>>qNSdVT`M`1Mlh!5Q6#3j={n5#za;!X&^OJ zgq;d4UJV-F>gg?c3Y?d=kvn3eV)Jb^ zO5vg0G0yN0%}xy#(6oTDSVw8l=_*2k;zTP?+N=*18H5wp`s90K-C67q{W3d8vQGmr zhpW^>1HEQV2TG#8_P_0q91h8QgHT~8=-Ij5snJ3cj?Jn5_66uV=*pq(j}yHnf$Ft;5VVC?bz%9X31asJeQF2jEa47H#j` zk&uxf3t?g!tltVP|B#G_UfDD}`<#B#iY^i>oDd-LGF}A@Fno~dR72c&hs6bR z2F}9(i8+PR%R|~FV$;Ke^Q_E_Bc;$)xN4Ti>Lgg4vaip!%M z06oxAF_*)LH57w|gCW3SwoEHwjO{}}U=pKhjKSZ{u!K?1zm1q? zXyA6y@)}_sONiJopF}_}(~}d4FDyp|(@w}Vb;Fl5bZL%{1`}gdw#i{KMjp2@Fb9pg ziO|u7qP{$kxH$qh8%L+)AvwZNgUT6^zsZq-MRyZid{D?t`f|KzSAD~C?WT3d0rO`0 z=qQ6{)&UXXuHY{9g|P7l_nd-%eh}4%VVaK#Nik*tOu9lBM$<%FS@`NwGEbP0&;Xbo zObCq=y%a`jSJmx_uTLa{@2@}^&F4c%z6oe-TN&idjv+8E|$FHOvBqg5hT zMB=7SHq`_-E?5g=()*!V>rIa&LcX(RU}aLm*38U_V$C_g4)7GrW5$GnvTwJZdBmy6 z*X)wi3=R8L=esOhY0a&eH`^fSpUHV8h$J1|o^3fKO|9QzaiKu>yZ9wmRkW?HTkc<*v7i*ylJ#u#j zD1-n&{B`04oG>0Jn{5PKP*4Qsz{~`VVA3578gA+JUkiPc$Iq!^K|}*p_z3(-c&5z@ zKxmdNpp2&wg&%xL3xZNzG-5Xt7jnI@{?c z25=M>-VF|;an2Os$Nn%HgQz7m(ujC}Ii0Oesa(y#8>D+P*_m^X##E|h$M6tJr%#=P zWP*)Px>7z`E~U^2LNCNiy%Z7!!6RI%6fF@#ZY3z`CK91}^J$F!EB0YF1je9hJKU7!S5MnXV{+#K;y zF~s*H%p@vj&-ru7#(F2L+_;IH46X(z{~HTfcThqD%b{>~u@lSc<+f5#xgt9L7$gSK ziDJ6D*R%4&YeUB@yu@4+&70MBNTnjRyqMRd+@&lU#rV%0t3OmouhC`mkN}pL>tXin zY*p)mt=}$EGT2E<4Q>E2`6)gZ`QJhGDNpI}bZL9}m+R>q?l`OzFjW?)Y)P`fUH(_4 zCb?sm1=DD0+Q5v}BW#0n5;Nm(@RTEa3(Y17H2H67La+>ptQHJ@WMy2xRQT$|7l`8c zYHCxYw2o-rI?(fR2-%}pbs$I%w_&LPYE{4bo}vRoAW>3!SY_zH3`ofx3F1PsQ?&iq z*BRG>?<6%z=x#`NhlEq{K~&rU7Kc7Y-90aRnoj~rVoKae)L$3^z*Utppk?I`)CX&& zZ^@Go9fm&fN`b`XY zt0xE5aw4t@qTg_k=!-5LXU+_~DlW?53!afv6W(k@FPPX-`nA!FBMp7b!ODbL1zh58 z*69I}P_-?qSLKj}JW7gP!la}K@M}L>v?rDD!DY-tu+onu9kLoJz20M4urX_xf2dfZ zORd9Zp&28_ff=wdMpXi%IiTTNegC}~RLkdYjA39kWqlA?jO~o1`*B&85Hd%VPkYZT z48MPe62;TOq#c%H(`wX5(Bu>nlh4Fbd*Npasdhh?oRy8a;NB2(eb}6DgwXtx=n}fE zx67rYw=(s0r?EsPjaya}^Qc-_UT5|*@|$Q}*|>V3O~USkIe6a0_>vd~6kHuP8=m}_ zo2IGKbv;yA+TBtlCpnw)8hDn&eq?26gN$Bh;SdxaS04Fsaih_Cfb98s39xbv)=mS0 z6M<@pM2#pe32w*lYSWG>DYqB95XhgAA)*9dOxHr{t)er0Xugoy)!Vz#2C3FaUMzYl zCxy{igFB901*R2*F4>grPF}+G`;Yh zGi@nRjWyG3mR(BVOeBPOF=_&}2IWT%)pqdNAcL{eP`L*^FDv#Rzql5U&Suq_X%JfR_lC!S|y|xd5mQ0{0!G#9hV46S~A` z0B!{yI-4FZEtol5)mNWXcX(`x&Pc*&gh4k{w%0S#EI>rqqlH2xv7mR=9XNCI$V#NG z4wb-@u{PfQP;tTbzK>(DF(~bKp3;L1-A*HS!VB)Ae>Acnvde15Anb`h;I&0)aZBS6 z55ZS7mL5Wp!LCt45^{2_70YiI_Py=X{I3>$Px5Ez0ahLQ+ z9EWUWSyzA|+g-Axp*Lx-M{!ReQO07EG7r4^)K(xbj@%ZU=0tBC5shl)1a!ifM5OkF z0w2xQ-<+r-h1fi7B6waX15|*GGqfva)S)dVcgea`lQ~SQ$KXPR+(3Tn2I2R<0 z9tK`L*pa^+*n%>tZPiqt{_`%v?Bb7CR-!GhMON_Fbs0$#|H}G?rW|{q5fQhvw!FxI zs-5ZK>hAbnCS#ZQVi5K0X3PjL1JRdQO+&)*!oRCqB{wen60P6!7bGiWn@vD|+E@Xq zb!!_WiU^I|@1M}Hz6fN-m04x=>Exm{b@>UCW|c8vC`aNbtA@KCHujh^2RWZC}iYhL^<*Z93chIBJYU&w>$CGZDRcHuIgF&oyesDZ#&mA;?wxx4Cm#c0V$xYG?9OL(Smh}#fFuX(K;otJmvRP{h ze^f-qv;)HKC7geB92_@3a9@MGijS(hNNVd%-rZ;%@F_f7?Fjinbe1( zn#jQ*jKZTqE+AUTEd3y6t>*=;AO##cmdwU4gc2&rT8l`rtKW2JF<`_M#p>cj+)yCG zgKF)y8jrfxTjGO&ccm8RU>qn|HxQ7Z#sUo$q)P5H%8iBF$({0Ya51-rA@!It#NHN8MxqK zrYyl_&=}WVfQ?+ykV4*@F6)=u_~3BebR2G2>>mKaEBPmSW3(qYGGXj??m3L zHec{@jWCsSD8`xUy0pqT?Sw0oD?AUK*WxZn#D>-$`eI+IT)6ki>ic}W)t$V32^ITD zR497@LO}S|re%A+#vdv-?fXsQGVnP?QB_d0cGE+U84Q=aM=XrOwGFN3`Lpl@P0fL$ zKN1PqOwojH*($uaQFh8_)H#>Acl&UBSZ>!2W1Dinei`R4dJGX$;~60X=|SG6#jci} z&t4*dVDR*;+6Y(G{KGj1B2!qjvDYOyPC}%hnPbJ@g(4yBJrViG1#$$X75y+Ul1{%x zBAuD}Q@w?MFNqF-m39FGpq7RGI?%Bvyyig&oGv)lR>d<`Bqh=p>urib5DE;u$c|$J zwim~nPb19t?LJZsm{<(Iyyt@~H!a4yywmHKW&=1r5+oj*Fx6c89heW@(2R`i!Uiy* zp)=`Vr8sR!)KChE-6SEIyi(dvG3<1KoVt>kGV=zZiG7LGonH1+~yOK-`g0)r#+O|Q>)a`I2FVW%wr3lhO(P{ksNQuR!G_d zeTx(M!%brW_vS9?IF>bzZ2A3mWX-MEaOk^V|4d38{1D|KOlZSjBKrj7Fgf^>JyL0k zLoI$adZJ0T+8i_Idsuj}C;6jgx9LY#Ukh;!8eJ^B1N}q=Gn4onF*a2vY7~`x$r@rJ z`*hi&Z2lazgu{&nz>gjd>#eq*IFlXed(%$s5!HRXKNm zDZld+DwDI`O6hyn2uJ)F^{^;ESf9sjJ)wMSKD~R=DqPBHyP!?cGAvL<1|7K-(=?VO zGcKcF1spUa+ki<`6K#@QxOTsd847N8WSWztG~?~ z!gUJn>z0O=_)VCE|56hkT~n5xXTp}Ucx$Ii%bQ{5;-a4~I2e|{l9ur#*ghd*hSqO= z)GD@ev^w&5%k}YYB~!A%3*XbPPU-N6&3Lp1LxyP@|C<{qcn&?l54+zyMk&I3YDT|E z{lXH-e?C{huu<@~li+73lMOk&k)3s7Asn$t6!PtXJV!RkA`qdo4|OC_a?vR!kE_}k zK5R9KB%V@R7gt@9=TGL{=#r2gl!@3G;k-6sXp&E4u20DgvbY$iE**Xqj3TyxK>3AU z!b9}NXuINqt>Htt6fXIy5mj7oZ{A&$XJ&thR5ySE{mkxq_YooME#VCHm2+3D!f`{) zvR^WSjy_h4v^|!RJV-RaIT2Ctv=)UMMn@fAgjQV$2G+4?&dGA8vK35c-8r)z9Qqa=%k(FU)?iec14<^olkOU3p zF-6`zHiDKPafKK^USUU+D01>C&Wh{{q?>5m zGQp|z*+#>IIo=|ae8CtrN@@t~uLFOeT{}vX(IY*;>wAU=u1Qo4c+a&R);$^VCr>;! zv4L{`lHgc9$BeM)pQ#XA_(Q#=_iSZL4>L~8Hx}NmOC$&*Q*bq|9Aq}rWgFnMDl~d*;7c44GipcpH9PWaBy-G$*MI^F0 z?Tdxir1D<2ui+Q#^c4?uKvq=p>)lq56=Eb|N^qz~w7rsZu)@E4$;~snz+wIxi+980O6M#RmtgLYh@|2}9BiHSpTs zacjGKvwkUwR3lwTSsCHlwb&*(onU;)$yvdhikonn|B44JMgs*&Lo!jn`6AE>XvBiO z*LKNX3FVz9yLcsnmL!cRVO_qv=yIM#X|u&}#f%_?Tj0>8)8P_0r0!AjWNw;S44tst zv+NXY1{zRLf9OYMr6H-z?4CF$Y%MdbpFIN@a-LEnmkcOF>h16cH_;A|e)pJTuCJ4O zY7!4FxT4>4aFT8a92}84>q0&?46h>&0Vv0p>u~k&qd5$C1A6Q$I4V(5X~6{15;PD@ ze6!s9xh#^QI`J+%8*=^(-!P!@9%~buBmN2VSAp@TOo6}C?az+ALP8~&a0FWZk*F5N z^8P8IREnN`N0i@>O0?{i-FoFShYbUB`D7O4HB`Im2{yzXmyrg$k>cY6A@>bf7i3n0 z5y&cf2#`zctT>dz+hNF&+d3g;2)U!#vsb-%LC+pqKRTiiSn#FH#e!bVwR1nAf*TG^ z!RKcCy$P>?Sfq6n<%M{T0I8?p@HlgwC!HoWO>~mT+X<{Ylm+$Vtj9};H3$EB}P2wR$3y!TO#$iY8eO-!}+F&jMu4%E6S>m zB(N4w9O@2=<`WNJay5PwP8javDp~o~xkSbd4t4t8)9jqu@bHmJHq=MV~Pt|(TghCA}fhMS?s-{klV>~=VrT$nsp7mf{?cze~KKOD4 z_1Y!F)*7^W+BBTt1R2h4f1X4Oy2%?=IMhZU8c{qk3xI1=!na*Sg<=A$?K=Y=GUR9@ zQ(ylIm4Lgm>pt#%p`zHxok%vx_=8Fap1|?OM02|N%X-g5_#S~sT@A!x&8k#wVI2lo z1Uyj{tDQRpb*>c}mjU^gYA9{7mNhFAlM=wZkXcA#MHXWMEs^3>p9X)Oa?dx7b%N*y zLz@K^%1JaArjgri;8ptNHwz1<0y8tcURSbHsm=26^@CYJ3hwMaEvC7 z3Wi-@AaXIQ)%F6#i@%M>?Mw7$6(kW@?et@wbk-APcvMCC{>iew#vkZej8%9h0JSc? zCb~K|!9cBU+))^q*co(E^9jRl7gR4Jihyqa(Z(P&ID#TPyysVNL7(^;?Gan!OU>au zN}miBc&XX-M$mSv%3xs)bh>Jq9#aD_l|zO?I+p4_5qI0Ms*OZyyxA`sXcyiy>-{YN zA70%HmibZYcHW&YOHk6S&PQ+$rJ3(utuUra3V0~@=_~QZy&nc~)AS>v&<6$gErZC3 zcbC=eVkV4Vu0#}E*r=&{X)Kgq|8MGCh(wsH4geLj@#8EGYa})K2;n z{1~=ghoz=9TSCxgzr5x3@sQZZ0FZ+t{?klSI_IZa16pSx6*;=O%n!uXVZ@1IL;JEV zfOS&yyfE9dtS*^jmgt6>jQDOIJM5Gx#Y2eAcC3l^lmoJ{o0T>IHpECTbfYgPI4#LZq0PKqnPCD}_ zyKxz;(`fE0z~nA1s?d{X2!#ZP8wUHzFSOoTWQrk%;wCnBV_3D%3@EC|u$Ao)tO|AO z$4&aa!wbf}rbNcP{6=ajgg(`p5kTeu$ji20`zw)X1SH*x zN?T36{d9TY*S896Ijc^!35LLUByY4QO=ARCQ#MMCjudFc7s!z%P$6DESz%zZ#>H|i zw3Mc@v4~{Eke;FWs`5i@ifeYPh-Sb#vCa#qJPL|&quSKF%sp8*n#t?vIE7kFWjNFh zJC@u^bRQ^?ra|%39Ux^Dn4I}QICyDKF0mpe+Bk}!lFlqS^WpYm&xwIYxUoS-rJ)N9 z1Tz*6Rl9;x`4lwS1cgW^H_M*)Dt*DX*W?ArBf?-t|1~ge&S}xM0K;U9Ibf{okZHf~ z#4v4qc6s6Zgm8iKch5VMbQc~_V-ZviirnKCi*ouN^c_2lo&-M;YSA>W>>^5tlXObg zacX$k0=9Tf$Eg+#9k6yV(R5-&F{=DHP8!yvSQ`Y~XRnUx@{O$-bGCksk~3&qH^dqX zkf+ZZ?Nv5u>LBM@2?k%k&_aUb5Xjqf#!&7%zN#VZwmv65ezo^Y4S#(ed0yUn4tFOB zh1f1SJ6_s?a{)u6VdwUC!Hv=8`%T9(^c`2hc9nt$(q{Dm2X)dK49ba+KEheQ;7^0) ziFKw$%EHy_B1)M>=yK^=Z$U-LT36yX>EKT zvD8IAom2&2?bTmX@_PBR4W|p?6?LQ+&UMzXxqHC5VHzf@Eb1u)kwyfy+NOM8Wa2y@ zNNDL0PE$F;yFyf^jy&RGwDXQwYw6yz>OMWvJt98X@;yr!*RQDBE- zE*l*u=($Zi1}0-Y4lGaK?J$yQjgb+*ljUvNQ!;QYAoCq@>70=sJ{o{^21^?zT@r~hhf&O;Qiq+ ziGQQLG*D@5;LZ%09mwMiE4Q{IPUx-emo*;a6#DrmWr(zY27d@ezre)Z1BGZdo&pXn z+);gOFelKDmnjq#8dL7CTiVH)dHOqWi~uE|NM^QI3EqxE6+_n>IW67~UB#J==QOGF zp_S)c8TJ}uiaEiaER}MyB(grNn=2m&0yztA=!%3xUREyuG_jmadN*D&1nxvjZ6^+2 zORi7iX1iPi$tKasppaR9$a3IUmrrX)m*)fg1>H+$KpqeB*G>AQV((-G{}h=qItj|d zz~{5@{?&Dab6;0c7!!%Se>w($RmlG7Jlv_zV3Ru8b2rugY0MVPOOYGlokI7%nhIy& z-B&wE=lh2dtD!F?noD{z^O1~Tq4MhxvchzuT_oF3-t4YyA*MJ*n&+1X3~6quEN z@m~aEp=b2~mP+}TUP^FmkRS_PDMA{B zaSy(P=$T~R!yc^Ye0*pl5xcpm_JWI;@-di+nruhqZ4gy7cq-)I&s&Bt3BkgT(Zdjf zTvvv0)8xzntEtp4iXm}~cT+pi5k{w{(Z@l2XU9lHr4Vy~3ycA_T?V(QS{qwt?v|}k z_ST!s;C4!jyV5)^6xC#v!o*uS%a-jQ6< z)>o?z7=+zNNtIz1*F_HJ(w@=`E+T|9TqhC(g7kKDc8z~?RbKQ)LRMn7A1p*PcX2YR zUAr{);~c7I#3Ssv<0i-Woj0&Z4a!u|@Xt2J1>N-|ED<3$o2V?OwL4oQ%$@!zLamVz zB)K&Ik^~GOmDAa143{I4?XUk1<3-k{<%?&OID&>Ud%z*Rkt*)mko0RwC2=qFf-^OV z=d@47?tY=A;=2VAh0mF(3x;!#X!%{|vn;U2XW{(nu5b&8kOr)Kop3-5_xnK5oO_3y z!EaIb{r%D{7zwtGgFVri4_!yUIGwR(xEV3YWSI_+E}Gdl>TINWsIrfj+7DE?xp+5^ zlr3pM-Cbse*WGKOd3+*Qen^*uHk)+EpH-{u@i%y}Z!YSid<}~kA*IRSk|nf+I1N=2 zIKi+&ej%Al-M5`cP^XU>9A(m7G>58>o|}j0ZWbMg&x`*$B9j#Rnyo0#=BMLdo%=ks zLa3(2EinQLXQ(3zDe7Bce%Oszu%?8PO648TNst4SMFvj=+{b%)ELyB!0`B?9R6aO{i-63|s@|raSQGL~s)9R#J#duFaTSZ2M{X z1?YuM*a!!|jP^QJ(hAisJuPOM`8Y-Hzl~%d@latwj}t&0{DNNC+zJARnuQfiN`HQ# z?boY_2?*q;Qk)LUB)s8(Lz5elaW56p&fDH*AWAq7Zrbeq1!?FBGYHCnFgRu5y1jwD zc|yBz+UW|X`zDsc{W~8m$sh@VVnZD$lLnKlq@Hg^;ky!}ZuPdKNi2BI70;hrpvaA4+Q_+K)I@|)q1N-H zrycZU`*YUW``Qi^`bDX-j7j^&bO+-Xg$cz2#i##($uyW{Nl&{DK{=lLWV3|=<&si||2)l=8^8_z+Vho-#5LB0EqQ3v5U#*DF7 zxT)1j^`m+lW}p$>WSIG1eZ>L|YR-@Feu!YNWiw*IZYh03mq+2QVtQ}1ezRJM?0PA< z;mK(J5@N8>u@<6Y$QAHWNE};rR|)U_&bv8dsnsza7{=zD1VBcxrALqnOf-qW(zzTn zTAp|pEo#FsQ$~*$j|~Q;$Zy&Liu9OM;VF@#_&*nL!N2hH!Q6l*OeTxq!l>dEc{;Hw zCQni{iN%jHU*C;?M-VUaXxf0FEJ_G=C8)C-wD!DvhY+qQ#FT3}Th8;GgV&AV94F`D ztT6=w_Xm8)*)dBnDkZd~UWL|W=Glu!$hc|1w7_7l!3MAt95oIp4Xp{M%clu&TXehO z+L-1#{mjkpTF@?|w1P98OCky~S%@OR&o75P&ZHvC}Y=(2_{ib(-Al_7aZ^U?s34#H}= zGfFi5%KnFVCKtdO^>Htpb07#BeCXMDO8U}crpe1Gm`>Q=6qB4i=nLoLZ%p$TY=OcP z)r}Et-Ed??u~f09d3Nx3bS@ja!fV(Dfa5lXxRs#;8?Y8G+Qvz+iv7fiRkL3liip}) z&G0u8RdEC9c$$rdU53=MH`p!Jn|DHjhOxHK$tW_pw9wCTf0Eo<){HoN=zG!!Gq4z4 z7PwGh)VNPXW-cE#MtofE`-$9~nmmj}m zlzZscQ2+Jq%gaB9rMgVJkbhup0Ggpb)&L01T=%>n7-?v@I8!Q(p&+!fd+Y^Pu9l+u zek(_$^HYFVRRIFt@0Fp52g5Q#I`tC3li`;UtDLP*rA{-#Yoa5qp{cD)QYhldihWe+ zG~zuaqLY~$-1sjh2lkbXCX;lq+p~!2Z=76cvuQe*Fl>IFwpUBP+d^&E4BGc{m#l%Kuo6#{XGoRyFc%Hqhf|%nYd<;yiC>tyEyk z4I+a`(%%Ie=-*n z-{mg=j&t12)LH3R?@-B1tEb7FLMePI1HK0`Ae@#)KcS%!Qt9p4_fmBl5zhO10n401 zBSfnfJ;?_r{%R)hh}BBNSl=$BiAKbuWrNGQUZ)+0=Mt&5!X*D@yGCSaMNY&@`;^a4 z;v=%D_!K!WXV1!3%4P-M*s%V2b#2jF2bk!)#2GLVuGKd#vNpRMyg`kstw0GQ8@^k^ zuqK5uR<>FeRZ#3{%!|4X!hh7hgirQ@Mwg%%ez8pF!N$xhMNQN((yS(F2-OfduxxKE zxY#7O(VGfNuLv-ImAw5+h@gwn%!ER;*Q+001;W7W^waWT%@(T+5k!c3A-j)a8y11t zx4~rSN0s$M8HEOzkcWW4YbKK9GQez2XJ|Nq?TFy;jmGbg;`m&%U4hIiarKmdTHt#l zL=H;ZHE?fYxKQQXKnC+K!TAU}r086{4m}r()-QaFmU(qWhJlc$eas&y?=H9EYQy8N$8^bni9TpDp zkA^WRs?KgYgjxX4T6?`SMs$`s3vlut(YU~f2F+id(Rf_)$BIMibk9lACI~LA+i7xn z%-+=DHV*0TCTJp~-|$VZ@g2vmd*|2QXV;HeTzt530KyK>v&253N1l}bP_J#UjLy4) zBJili9#-ey8Kj(dxmW^ctorxd;te|xo)%46l%5qE-YhAjP`Cc03vT)vV&GAV%#Cgb zX~2}uWNvh`2<*AuxuJpq>SyNtZwzuU)r@@dqC@v=Ocd(HnnzytN+M&|Qi#f4Q8D=h ziE<3ziFW%+!yy(q{il8H44g^5{_+pH60Mx5Z*FgC_3hKxmeJ+wVuX?T#ZfOOD3E4C zRJsj#wA@3uvwZwHKKGN{{Ag+8^cs?S4N@6(Wkd$CkoCst(Z&hp+l=ffZ?2m%%ffI3 zdV7coR`R+*dPbNx=*ivWeNJK=Iy_vKd`-_Hng{l?hmp=|T3U&epbmgXXWs9ySE|=G zeQ|^ioL}tveN{s72_&h+F+W;G}?;?_s@h5>DX(rp#eaZ!E=NivgLI zWykLKev+}sHH41NCRm7W>K+_qdoJ8x9o5Cf!)|qLtF7Izxk*p|fX8UqEY)_sI_45O zL2u>x=r5xLE%s|d%MO>zU%KV6QKFiEeo12g#bhei4!Hm+`~Fo~4h|BJ)%ENxy9)Up zOxupSf1QZWun=)gF{L0YWJ<(r0?$bPFANrmphJ>kG`&7E+RgrWQi}ZS#-CQJ*i#8j zM_A0?w@4Mq@xvk^>QSvEU|VYQoVI=TaOrsLTa`RZfe8{9F~mM{L+C`9YP9?OknLw| zmkvz>cS6`pF0FYeLdY%>u&XpPj5$*iYkj=m7wMzHqzZ5SG~$i_^f@QEPEC+<2nf-{ zE7W+n%)q$!5@2pBuXMxhUSi*%F>e_g!$T-_`ovjBh(3jK9Q^~OR{)}!0}vdTE^M+m z9QWsA?xG>EW;U~5gEuKR)Ubfi&YWnXV;3H6Zt^NE725*`;lpSK4HS1sN?{~9a4JkD z%}23oAovytUKfRN87XTH2c=kq1)O5(fH_M3M-o{{@&~KD`~TRot-gqg7Q2U2o-iiF}K>m?CokhmODaLB z1p6(6JYGntNOg(s!(>ZU&lzDf+Ur)^Lirm%*}Z>T)9)fAZ9>k(kvnM;ab$ptA=hoh zVgsVaveXbMpm{|4*d<0>?l_JUFOO8A3xNLQOh%nVXjYI6X8h?a@6kDe5-m&;M0xqx z+1U$s>(P9P)f0!{z%M@E7|9nn#IWgEx6A6JNJ(7dk`%6$3@!C!l;JK-p2?gg+W|d- ziEzgk$w7k48NMqg$CM*4O~Abj3+_yUKTyK1p6GDsGEs;}=E_q>^LI-~pym$qhXPJf z2`!PJDp4l(TTm#|n@bN!j;-FFOM__eLl!6{*}z=)UAcGYloj?bv!-XY1TA6Xz;82J zLRaF{8ayzGa|}c--}|^xh)xgX>6R(sZD|Z|qX50gu=d`gEwHqC@WYU7{%<5VOnf9+ zB@FX?|UL%`8EIAe!*UdYl|6wRz6Y>(#8x92$#y}wMeE|ZM2X*c}dKJ^4NIf;Fm zNwzq%QcO?$NR-7`su!*$dlIKo2y(N;qgH@1|8QNo$0wbyyJ2^}$iZ>M{BhBjTdMjK z>gPEzgX4;g3$rU?jvDeOq`X=>)zdt|jk1Lv3u~bjHI=EGLfIR&+K3ldcc4D&Um&04 z3^F*}WaxR(ZyaB>DlmF_UP@+Q*h$&nsOB#gwLt{1#F4i-{A5J@`>B9@{^i?g_Ce&O z<<}_We-RUFU&&MHa1#t56u_oM(Ljn7djja!T|gcxSoR=)@?owC*NkDarpBj=W4}=i1@)@L|C) zQKA+o<(pMVp*Su(`zBC0l1yTa$MRfQ#uby|$mlOMs=G`4J|?apMzKei%jZql#gP@IkOaOjB7MJM=@1j(&!jNnyVkn5;4lvro1!vq ztXiV8HYj5%)r1PPpIOj)f!>pc^3#LvfZ(hz}C@-3R(Cx7R427*Fwd!XO z4~j&IkPHcBm0h_|iG;ZNrYdJ4HI!$rSyo&sibmwIgm1|J#g6%>=ML1r!kcEhm(XY& zD@mIJt;!O%WP7CE&wwE3?1-dt;RTHdm~LvP7K`ccWXkZ0kfFa2S;wGtx_a}S2lslw z$<4^Jg-n#Ypc(3t2N67Juasu=h)j&UNTPNDil4MQMTlnI81kY46uMH5B^U{~nmc6+ z9>(lGhhvRK9ITfpAD!XQ&BPphL3p8B4PVBN0NF6U49;ZA0Tr75AgGw7(S=Yio+xg_ zepZ*?V#KD;sHH+15ix&yCs0eSB-Z%D%uujlXvT#V$Rz@$+w!u#3GIo*AwMI#Bm^oO zLr1e}k5W~G0xaO!C%Mb{sarxWZ4%Dn9vG`KHmPC9GWZwOOm11XJp#o0-P-${3m4g( z6~)X9FXw%Xm~&99tj>a-ri})ZcnsfJtc10F@t9xF5vq6E)X!iUXHq-ohlO`gQdS&k zZl})3k||u)!_=nNlvMbz%AuIr89l#I$;rG}qvDGiK?xTd5HzMQkw*p$YvFLGyQM!J zNC^gD!kP{A84nGosi~@MLKqWQNacfs7O$dkZtm4-BZ~iA8xWZPkTK!HpA5zr!9Z&+icfAJ1)NWkTd!-9`NWU>9uXXUr;`Js#NbKFgrNhTcY4GNv*71}}T zFJh?>=EcbUd2<|fiL+H=wMw8hbX6?+_cl4XnCB#ddwdG>bki* zt*&6Dy&EIPluL@A3_;R%)shA-tDQA1!Tw4ffBRyy;2n)vm_JV06(4Or&QAOKNZB5f(MVC}&_!B>098R{Simr!UG}?CW1Ah+X+0#~0`X)od zLYablwmFxN21L))!_zc`IfzWi`5>MxPe(DmjjO1}HHt7TJtAW+VXHt!aKZk>y6PoMsbDXRJnov;D~Ur~2R_7(Xr)aa%wJwZhS3gr7IGgt%@;`jpL@gyc6bGCVx!9CE7NgIbUNZ!Ur1RHror0~ zr(j$^yM4j`#c2KxSP61;(Tk^pe7b~}LWj~SZC=MEpdKf;B@on9=?_n|R|0q;Y*1_@ z>nGq>)&q!;u-8H)WCwtL&7F4vbnnfSAlK1mwnRq2&gZrEr!b1MA z(3%vAbh3aU-IX`d7b@q`-WiT6eitu}ZH9x#d&qx}?CtDuAXak%5<-P!{a`V=$|XmJ zUn@4lX6#ulB@a=&-9HG)a>KkH=jE7>&S&N~0X0zD=Q=t|7w;kuh#cU=NN7gBGbQTT z;?bdSt8V&IIi}sDTzA0dkU}Z-Qvg;RDe8v>468p3*&hbGT1I3hi9hh~Z(!H}{+>eUyF)H&gdrX=k$aB%J6I;6+^^kn1mL+E+?A!A}@xV(Qa@M%HD5C@+-4Mb4lI=Xp=@9+^x+jhtOc zYgF2aVa(uSR*n(O)e6tf3JEg2xs#dJfhEmi1iOmDYWk|wXNHU?g23^IGKB&yHnsm7 zm_+;p?YpA#N*7vXCkeN2LTNG`{QDa#U3fcFz7SB)83=<8rF)|udrEbrZL$o6W?oDR zQx!178Ih9B#D9Ko$H(jD{4MME&<|6%MPu|TfOc#E0B}!j^MMpV69D#h2`vsEQ{(?c zJ3Lh!3&=yS5fWL~;1wCZ?)%nmK`Eqgcu)O6rD^3%ijcxL50^z?OI(LaVDvfL0#zjZ z2?cPvC$QCzpxpt5jMFp05OxhK0F!Q`rPhDi5)y=-0C} zIM~ku&S@pl1&0=jl+rlS<4`riV~LC-#pqNde@44MB(j%)On$0Ko(@q?4`1?4149Z_ zZi!5aU@2vM$dHR6WSZpj+VboK+>u-CbNi7*lw4K^ZxxM#24_Yc`jvb9NPVi75L+MlM^U~`;a7`4H0L|TYK>%hfEfXLsu1JGM zbh|8{wuc7ucV+`Ys1kqxsj`dajwyM;^X^`)#<+a~$WFy8b2t_RS{8yNYKKlnv+>vB zX(QTf$kqrJ;%I@EwEs{cIcH@Z3|#^S@M+5jsP<^`@8^I4_8MlBb`~cE^n+{{;qW2q z=p1=&+fUo%T{GhVX@;56kH8K_%?X=;$OTYqW1L*)hzelm^$*?_K;9JyIWhsn4SK(| zSmXLTUE8VQX{se#8#Rj*lz`xHtT<61V~fb;WZUpu(M)f#;I+2_zR+)y5Jv?l`CxAinx|EY!`IJ*x9_gf_k&Gx2alL!hK zUWj1T_pk|?iv}4EP#PZvYD_-LpzU!NfcLL%fK&r$W8O1KH9c2&GV~N#T$kaXGvAOl)|T zuF9%6(i=Y3q?X%VK-D2YIYFPH3f|g$TrXW->&^Ab`WT z7>Oo!u1u40?jAJ8Hy`bv}qbgs8)cF0&qeVjD?e+3Ggn1Im>K77ZSpbU*08 zfZkIFcv?y)!*B{|>nx@cE{KoutP+seQU?bCGE`tS0GKUO3PN~t=2u7q_6$l;uw^4c zVu^f{uaqsZ{*a-N?2B8ngrLS8E&s6}Xtv9rR9C^b`@q8*iH)pFzf1|kCfiLw6u{Z%aC z!X^5CzF6qofFJgklJV3oc|Qc2XdFl+y5M9*P8}A>Kh{ zWRgRwMSZ(?Jw;m%0etU5BsWT-Dj-5F;Q$OQJrQd+lv`i6>MhVo^p*^w6{~=fhe|bN z*37oV0kji)4an^%3ABbg5RC;CS50@PV5_hKfXjYx+(DqQdKC^JIEMo6X66$qDdLRc z!YJPSKnbY`#Ht6`g@xGzJmKzzn|abYbP+_Q(v?~~ z96%cd{E0BCsH^0HaWt{y(Cuto4VE7jhB1Z??#UaU(*R&Eo+J`UN+8mcb51F|I|n*J zJCZ3R*OdyeS9hWkc_mA7-br>3Tw=CX2bl(=TpVt#WP8Bg^vE_9bP&6ccAf3lFMgr` z{3=h@?Ftb$RTe&@IQtiJfV;O&4fzh)e1>7seG; z=%mA4@c7{aXeJnhEg2J@Bm;=)j=O=cl#^NNkQ<{r;Bm|8Hg}bJ-S^g4`|itx)~!LN zXtL}?f1Hs6UQ+f0-X6&TBCW=A4>bU0{rv8C4T!(wD-h>VCK4YJk`6C9$by!fxOYw- zV#n+0{E(0ttq_#16B} ze8$E#X9o{B!0vbq#WUwmv5Xz6{(!^~+}sBW{xctdNHL4^vDk!0E}(g|W_q;jR|ZK< z8w>H-8G{%R#%f!E7cO_^B?yFRKLOH)RT9GJsb+kAKq~}WIF)NRLwKZ^Q;>!2MNa|} z-mh?=B;*&D{Nd-mQRcfVnHkChI=DRHU4ga%xJ%+QkBd|-d9uRI76@BT(bjsjwS+r) zvx=lGNLv1?SzZ;P)Gnn>04fO7Culg*?LmbEF0fATG8S@)oJ>NT3pYAXa*vX!eUTDF ziBrp(QyDqr0ZMTr?4uG_Nqs6f%S0g?h`1vO5fo=5S&u#wI2d4+3hWiolEU!=3_oFo zfie?+4W#`;1dd#X@g9Yj<53S<6OB!TM8w8})7k-$&q5(smc%;r z(BlXkTp`C47+%4JA{2X}MIaPbVF!35P#p;u7+fR*46{T+LR8+j25oduCfDzDv6R-hU{TVVo9fz?^N3ShMt!t0NsH)pB zRK8-S{Dn*y3b|k^*?_B70<2gHt==l7c&cT>r`C#{S}J2;s#d{M)ncW(#Y$C*lByLQ z&?+{dR7*gpdT~(1;M(FfF==3z`^eW)=5a9RqvF-)2?S-(G zhS;p(u~_qBum*q}On@$#08}ynd0+spzyVco0%G6;<-i5&016cV5UKzhQ~)fX03|>L z8ej+HzzgVr6_5ZUpa4HW0Ca!=r1%*}Oo;2no&Zz8DfR)L!@r<5 z2viSZpmvo5XqXyAz{Ms7`7kX>fnr1gi4X~7KpznRT0{Xc5Cfz@43PjBMBoH@z_{~( z(Wd}IPJ9hH+%)Fc)0!hrV+(A;76rhtI|YHbEDeERV~Ya>SQg^IvlazFkSK(KG9&{q zkPIR~EeQaaBmwA<20}mBO?)N$(z1@p)5?%}rM| zGF()~Z&Kx@OIDRI$d0T8;JX@vj3^2%pd_+@l9~a4lntZ;AvUIjqIZbuNTR6@hNJoV zk4F;ut)LN4ARuyn2M6F~eg-e#UH%2P;8uPGFW^vq1vj8mdIayFOZo(tphk8C7hpT~ z1Fv8?b_LNR3QD9J+!v=p%}# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/input/assets/css/fonts/glyphicons-halflings-regular.ttf b/docs/input/assets/css/fonts/glyphicons-halflings-regular.ttf deleted file mode 100644 index 1413fc609ab6f21774de0cb7e01360095584f65b..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 45404 zcmd?Sd0-pWwLh*qi$?oCk~i6sWlOeWJC3|4juU5JNSu9hSVACzERcmjLV&P^utNzg zIE4Kr1=5g!SxTX#Ern9_%4&01rlrW`Z!56xXTGQR4C z3vR~wXq>NDx$c~e?;ia3YjJ*$!C>69a?2$lLyhpI!CFfJsP=|`8@K0|bbMpWwVUEygg0=0x_)HeHpGSJagJNLA3c!$EuOV>j$wi! zbo{vZ(s8tl>@!?}dmNHXo)ABy7ohD7_1G-P@SdJWT8*oeyBVYVW9*vn}&VI4q++W;Z+uz=QTK}^C75!`aFYCX# zf7fC2;o`%!huaTNJAB&VWrx=szU=VLhwnbT`vc<#<`4WI6n_x@AofA~2d90o?1L3w z9!I|#P*NQ)$#9aASijuw>JRld^-t)Zhmy|i-`Iam|IWkguaMR%lhi4p~cX-9& zjfbx}yz}s`4-6>D^+6FzihR)Y!GsUy=_MWi_v7y#KmYi-{iZ+s@ekkq!@Wxz!~BQwiI&ti z>hC&iBe2m(dpNVvSbZe3DVgl(dxHt-k@{xv;&`^c8GJY%&^LpM;}7)B;5Qg5J^E${ z7z~k8eWOucjX6)7q1a%EVtmnND8cclz8R1=X4W@D8IDeUGXxEWe&p>Z*voO0u_2!! zj3dT(Ki+4E;uykKi*yr?w6!BW2FD55PD6SMj`OfBLwXL5EA-9KjpMo4*5Eqs^>4&> z8PezAcn!9jk-h-Oo!E9EjX8W6@EkTHeI<@AY{f|5fMW<-Ez-z)xCvW3()Z#x0oydB zzm4MzY^NdpIF9qMp-jU;99LjlgY@@s+=z`}_%V*xV7nRV*Kwrx-i`FzI0BZ#yOI8# z!SDeNA5b6u9!Imj89v0(g$;dT_y|Yz!3V`i{{_dez8U@##|X9A};s^7vEd!3AcdyVlhVk$v?$O442KIM1-wX^R{U7`JW&lPr3N(%kXfXT_`7w^? z=#ntx`tTF|N$UT?pELvw7T*2;=Q-x@KmDUIbLyXZ>f5=y7z1DT<7>Bp0k;eItHF?1 zErzhlD2B$Tm|^7DrxnTYm-tgg`Mt4Eivp5{r$o9e)8(fXBO4g|G^6Xy?y$SM*&V52 z6SR*%`%DZC^w(gOWQL?6DRoI*hBNT)xW9sxvmi@!vI^!mI$3kvAMmR_q#SGn3zRb_ zGe$=;Tv3dXN~9XuIHow*NEU4y&u}FcZEZoSlXb9IBOA}!@J3uovp}yerhPMaiI8|SDhvWVr z^BE&yx6e3&RYqIg;mYVZ*3#A-cDJ;#ms4txEmwm@g^s`BB}KmSr7K+ruIoKs=s|gOXP|2 zb1!)87h9?(+1^QRWb(Vo8+@G=o24gyuzF3ytfsKjTHZJ}o{YznGcTDm!s)DRnmOX} z3pPL4wExoN$kyc2>#J`k+<67sy-VsfbQ-1u+HkyFR?9G`9r6g4*8!(!c65Be-5hUg zZHY$M0k(Yd+DT1*8)G(q)1&tDl=g9H7!bZTOvEEFnBOk_K=DXF(d4JOaH zI}*A3jGmy{gR>s}EQzyJa_q_?TYPNXRU1O;fcV_&TQZhd{@*8Tgpraf~nT0BYktu*n{a~ub^UUqQPyr~yBY{k2O zgV)honv{B_CqY|*S~3up%Wn%7i*_>Lu|%5~j)}rQLT1ZN?5%QN`LTJ}vA!EE=1`So z!$$Mv?6T)xk)H8JTrZ~m)oNXxS}pwPd#);<*>zWsYoL6iK!gRSBB{JCgB28C#E{T? z5VOCMW^;h~eMke(w6vLlKvm!!TyIf;k*RtK)|Q>_@nY#J%=h%aVb)?Ni_By)XNxY)E3`|}_u}fn+Kp^3p4RbhFUBRtGsDyx9Eolg77iWN z2iH-}CiM!pfYDIn7;i#Ui1KG01{3D<{e}uWTdlX4Vr*nsb^>l0%{O?0L9tP|KGw8w z+T5F}md>3qDZQ_IVkQ|BzuN08uN?SsVt$~wcHO4pB9~ykFTJO3g<4X({-Tm1w{Ufo zI03<6KK`ZjqVyQ(>{_aMxu7Zm^ck&~)Q84MOsQ-XS~{6j>0lTl@lMtfWjj;PT{nlZ zIn0YL?kK7CYJa)(8?unZ)j8L(O}%$5S#lTcq{rr5_gqqtZ@*0Yw4}OdjL*kBv+>+@ z&*24U=y{Nl58qJyW1vTwqsvs=VRAzojm&V zEn6=WzdL1y+^}%Vg!ap>x%%nFi=V#wn# zUuheBR@*KS)5Mn0`f=3fMwR|#-rPMQJg(fW*5e`7xO&^UUH{L(U8D$JtI!ac!g(Ze89<`UiO@L+)^D zjPk2_Ie0p~4|LiI?-+pHXuRaZKG$%zVT0jn!yTvvM^jlcp`|VSHRt-G@_&~<4&qW@ z?b#zIN)G(}L|60jer*P7#KCu*Af;{mpWWvYK$@Squ|n-Vtfgr@ZOmR5Xpl;0q~VILmjk$$mgp+`<2jP z@+nW5Oap%fF4nFwnVwR7rpFaOdmnfB$-rkO6T3#w^|*rft~acgCP|ZkgA6PHD#Of| zY%E!3tXtsWS`udLsE7cSE8g@p$ceu*tI71V31uA7jwmXUCT7+Cu3uv|W>ZwD{&O4Nfjjvl43N#A$|FWxId! z%=X!HSiQ-#4nS&smww~iXRn<-`&zc)nR~js?|Ei-cei$^$KsqtxNDZvl1oavXK#Pz zT&%Wln^Y5M95w=vJxj0a-ko_iQt(LTX_5x#*QfQLtPil;kkR|kz}`*xHiLWr35ajx zHRL-QQv$|PK-$ges|NHw8k6v?&d;{A$*q15hz9{}-`e6ys1EQ1oNNKDFGQ0xA!x^( zkG*-ueZT(GukSnK&Bs=4+w|(kuWs5V_2#3`!;f}q?>xU5IgoMl^DNf+Xd<=sl2XvkqviJ>d?+G@Z5nxxd5Sqd$*ENUB_mb8Z+7CyyU zA6mDQ&e+S~w49csl*UePzY;^K)Fbs^%?7;+hFc(xz#mWoek4_&QvmT7Fe)*{h-9R4 zqyXuN5{)HdQ6yVi#tRUO#M%;pL>rQxN~6yoZ)*{{!?jU)RD*oOxDoTjVh6iNmhWNC zB5_{R=o{qvxEvi(khbRS`FOXmOO|&Dj$&~>*oo)bZz%lPhEA@ zQ;;w5eu5^%i;)w?T&*=UaK?*|U3~{0tC`rvfEsRPgR~16;~{_S2&=E{fE2=c>{+y} zx1*NTv-*zO^px5TA|B```#NetKg`19O!BK*-#~wDM@KEllk^nfQ2quy25G%)l72<> zzL$^{DDM#jKt?<>m;!?E2p0l12`j+QJjr{Lx*47Nq(v6i3M&*P{jkZB{xR?NOSPN% zU>I+~d_ny=pX??qjF*E78>}Mgts@_yn`)C`wN-He_!OyE+gRI?-a>Om>Vh~3OX5+& z6MX*d1`SkdXwvb7KH&=31RCC|&H!aA1g_=ZY0hP)-Wm6?A7SG0*|$mC7N^SSBh@MG z9?V0tv_sE>X==yV{)^LsygK2=$Mo_0N!JCOU?r}rmWdHD%$h~~G3;bt`lH& zAuOOZ=G1Mih**0>lB5x+r)X^8mz!0K{SScj4|a=s^VhUEp#2M=^#WRqe?T&H9GnWa zYOq{+gBn9Q0e0*Zu>C(BAX=I-Af9wIFhCW6_>TsIH$d>|{fIrs&BX?2G>GvFc=<8` zVJ`#^knMU~65dWGgXcht`Kb>{V2oo%<{NK|iH+R^|Gx%q+env#Js*(EBT3V0=w4F@W+oLFsA)l7Qy8mx_;6Vrk;F2RjKFvmeq} zro&>@b^(?f))OoQ#^#s)tRL>b0gzhRYRG}EU%wr9GjQ#~Rpo|RSkeik^p9x2+=rUr}vfnQoeFAlv=oX%YqbLpvyvcZ3l$B z5bo;hDd(fjT;9o7g9xUg3|#?wU2#BJ0G&W1#wn?mfNR{O7bq747tc~mM%m%t+7YN}^tMa24O4@w<|$lk@pGx!;%pKiq&mZB z?3h<&w>un8r?Xua6(@Txu~Za9tI@|C4#!dmHMzDF_-_~Jolztm=e)@vG11bZQAs!tFvd9{C;oxC7VfWq377Y(LR^X_TyX9bn$)I765l=rJ%9uXcjggX*r?u zk|0!db_*1$&i8>d&G3C}A`{Fun_1J;Vx0gk7P_}8KBZDowr*8$@X?W6v^LYmNWI)lN92yQ;tDpN zOUdS-W4JZUjwF-X#w0r;97;i(l}ZZT$DRd4u#?pf^e2yaFo zbm>I@5}#8FjsmigM8w_f#m4fEP~r~_?OWB%SGWcn$ThnJ@Y`ZI-O&Qs#Y14To( zWAl>9Gw7#}eT(!c%D0m>5D8**a@h;sLW=6_AsT5v1Sd_T-C4pgu_kvc?7+X&n_fct znkHy(_LExh=N%o3I-q#f$F4QJpy>jZBW zRF7?EhqTGk)w&Koi}QQY3sVh?@e-Z3C9)P!(hMhxmXLC zF_+ZSTQU`Gqx@o(~B$dbr zHlEUKoK&`2gl>zKXlEi8w6}`X3kh3as1~sX5@^`X_nYl}hlbpeeVlj#2sv)CIMe%b zBs7f|37f8qq}gA~Is9gj&=te^wN8ma?;vF)7gce;&sZ64!7LqpR!fy)?4cEZposQ8 zf;rZF7Q>YMF1~eQ|Z*!5j0DuA=`~VG$Gg6B?Om1 z6fM@`Ck-K*k(eJ)Kvysb8sccsFf@7~3vfnC=<$q+VNv)FyVh6ZsWw}*vs>%k3$)9| zR9ek-@pA23qswe1io)(Vz!vS1o*XEN*LhVYOq#T`;rDkgt86T@O`23xW~;W_#ZS|x zvwx-XMb7_!hIte-#JNpFxskMMpo2OYhHRr0Yn8d^(jh3-+!CNs0K2B!1dL$9UuAD= zQ%7Ae(Y@}%Cd~!`h|wAdm$2WoZ(iA1(a_-1?znZ%8h72o&Mm*4x8Ta<4++;Yr6|}u zW8$p&izhdqF=m8$)HyS2J6cKyo;Yvb>DTfx4`4R{ zPSODe9E|uflE<`xTO=r>u~u=NuyB&H!(2a8vwh!jP!yfE3N>IiO1jI>7e&3rR#RO3_}G23W?gwDHgSgekzQ^PU&G5z&}V5GO? zfg#*72*$DP1T8i`S7=P;bQ8lYF9_@8^C(|;9v8ZaK2GnWz4$Th2a0$)XTiaxNWfdq z;yNi9veH!j)ba$9pke8`y2^63BP zIyYKj^7;2don3se!P&%I2jzFf|LA&tQ=NDs{r9fIi-F{-yiG-}@2`VR^-LIFN8BC4 z&?*IvLiGHH5>NY(Z^CL_A;yISNdq58}=u~9!Ia7 zm7MkDiK~lsfLpvmPMo!0$keA$`%Tm`>Fx9JpG^EfEb(;}%5}B4Dw!O3BCkf$$W-dF z$BupUPgLpHvr<<+QcNX*w@+Rz&VQz)Uh!j4|DYeKm5IC05T$KqVV3Y|MSXom+Jn8c zgUEaFW1McGi^44xoG*b0JWE4T`vka7qTo#dcS4RauUpE{O!ZQ?r=-MlY#;VBzhHGU zS@kCaZ*H73XX6~HtHd*4qr2h}Pf0Re@!WOyvres_9l2!AhPiV$@O2sX>$21)-3i+_ z*sHO4Ika^!&2utZ@5%VbpH(m2wE3qOPn-I5Tbnt&yn9{k*eMr3^u6zG-~PSr(w$p> zw)x^a*8Ru$PE+{&)%VQUvAKKiWiwvc{`|GqK2K|ZMy^Tv3g|zENL86z7i<c zW`W>zV1u}X%P;Ajn+>A)2iXZbJ5YB_r>K-h5g^N=LkN^h0Y6dPFfSBh(L`G$D%7c` z&0RXDv$}c7#w*7!x^LUes_|V*=bd&aP+KFi((tG*gakSR+FA26%{QJdB5G1F=UuU&koU*^zQA=cEN9}Vd?OEh| zgzbFf1?@LlPkcXH$;YZe`WEJ3si6&R2MRb}LYK&zK9WRD=kY-JMPUurX-t4(Wy{%` zZ@0WM2+IqPa9D(^*+MXw2NWwSX-_WdF0nMWpEhAyotIgqu5Y$wA=zfuXJ0Y2lL3#ji26-P3Z?-&0^KBc*`T$+8+cqp`%g0WB zTH9L)FZ&t073H4?t=(U6{8B+uRW_J_n*vW|p`DugT^3xe8Tomh^d}0k^G7$3wLgP& zn)vTWiMA&=bR8lX9H=uh4G04R6>C&Zjnx_f@MMY!6HK5v$T%vaFm;E8q=`w2Y}ucJ zkz~dKGqv9$E80NTtnx|Rf_)|3wxpnY6nh3U9<)fv2-vhQ6v=WhKO@~@X57N-`7Ppc zF;I7)eL?RN23FmGh0s;Z#+p)}-TgTJE%&>{W+}C`^-sy{gTm<$>rR z-X7F%MB9Sf%6o7A%ZHReD4R;imU6<9h81{%avv}hqugeaf=~^3A=x(Om6Lku-Pn9i zC;LP%Q7Xw*0`Kg1)X~nAsUfdV%HWrpr8dZRpd-#%)c#Fu^mqo|^b{9Mam`^Zw_@j@ zR&ZdBr3?@<@%4Z-%LT&RLgDUFs4a(CTah_5x4X`xDRugi#vI-cw*^{ncwMtA4NKjByYBza)Y$hozZCpuxL{IP&=tw6ZO52WY3|iwGf&IJCn+u(>icK zZB1~bWXCmwAUz|^<&ysd#*!DSp8}DLNbl5lRFat4NkvItxy;9tpp9~|@ z;JctShv^Iq4(z+y7^j&I?GCdKMVg&jCwtCkc4*@O7HY*veGDBtAIn*JgD$QftP}8= zxFAdF=(S>Ra6(4slk#h%b?EOU-96TIX$Jbfl*_7IY-|R%H zF8u|~hYS-YwWt5+^!uGcnKL~jM;)ObZ#q68ZkA?}CzV-%6_vPIdzh_wHT_$mM%vws9lxUj;E@#1UX?WO2R^41(X!nk$+2oJGr!sgcbn1f^yl1 z#pbPB&Bf;1&2+?};Jg5qgD1{4_|%X#s48rOLE!vx3@ktstyBsDQWwDz4GYlcgu$UJ zp|z_32yN72T*oT$SF8<}>e;FN^X&vWNCz>b2W0rwK#<1#kbV)Cf`vN-F$&knLo5T& z8!sO-*^x4=kJ$L&*h%rQ@49l?7_9IG99~xJDDil00<${~D&;kiqRQqeW5*22A`8I2 z(^@`qZoF7_`CO_e;8#qF!&g>UY;wD5MxWU>azoo=E{kW(GU#pbOi%XAn%?W{b>-bTt&2?G=E&BnK9m0zs{qr$*&g8afR_x`B~o zd#dxPpaap;I=>1j8=9Oj)i}s@V}oXhP*{R|@DAQXzQJekJnmuQ;vL90_)H_nD1g6e zS1H#dzg)U&6$fz0g%|jxDdz|FQN{KJ&Yx0vfuzAFewJjv`pdMRpY-wU`-Y6WQnJ(@ zGVb!-8DRJZvHnRFiR3PG3Tu^nCn(CcZHh7hQvyd7i6Q3&ot86XI{jo%WZqCPcTR0< zMRg$ZE=PQx66ovJDvI_JChN~k@L^Pyxv#?X^<)-TS5gk`M~d<~j%!UOWG;ZMi1af< z+86U0=sm!qAVJAIqqU`Qs1uJhQJA&n@9F1PUrYuW!-~IT>l$I!#5dBaiAK}RUufjg{$#GdQBkxF1=KU2E@N=i^;xgG2Y4|{H>s` z$t`k8c-8`fS7Yfb1FM#)vPKVE4Uf(Pk&%HLe z%^4L>@Z^9Z{ZOX<^e)~adVRkKJDanJ6VBC_m@6qUq_WF@Epw>AYqf%r6qDzQ~AEJ!jtUvLp^CcqZ^G-;Kz3T;O4WG45Z zFhrluCxlY`M+OKr2SeI697btH7Kj`O>A!+2DTEQ=48cR>Gg2^5uqp(+y5Sl09MRl* zp|28!v*wvMd_~e2DdKDMMQ|({HMn3D%%ATEecGG8V9>`JeL)T0KG}=}6K8NiSN5W< z79-ZdYWRUb`T}(b{RjN8>?M~opnSRl$$^gT`B27kMym5LNHu-k;A;VF8R(HtDYJHS zU7;L{a@`>jd0svOYKbwzq+pWSC(C~SPgG~nWR3pBA8@OICK$Cy#U`kS$I;?|^-SBC zBFkoO8Z^%8Fc-@X!KebF2Ob3%`8zlVHj6H;^(m7J35(_bS;cZPd}TY~qixY{MhykQ zV&7u7s%E=?i`}Ax-7dB0ih47w*7!@GBt<*7ImM|_mYS|9_K7CH+i}?*#o~a&tF-?C zlynEu1DmiAbGurEX2Flfy$wEVk7AU;`k#=IQE*6DMWafTL|9-vT0qs{A3mmZGzOyN zcM9#Rgo7WgB_ujU+?Q@Ql?V-!E=jbypS+*chI&zA+C_3_@aJal}!Q54?qsL0In({Ly zjH;e+_SK8yi0NQB%TO+Dl77jp#2pMGtwsgaC>K!)NimXG3;m7y`W+&<(ZaV>N*K$j zLL~I+6ouPk6_(iO>61cIsinx`5}DcKSaHjYkkMuDoVl>mKO<4$F<>YJ5J9A2Vl}#BP7+u~L8C6~D zsk`pZ$9Bz3teQS1Wb|8&c2SZ;qo<#F&gS;j`!~!ADr(jJXMtcDJ9cVi>&p3~{bqaP zgo%s8i+8V{UrYTc9)HiUR_c?cfx{Yan2#%PqJ{%?Wux4J;T$#cumM0{Es3@$>}DJg zqe*c8##t;X(4$?A`ve)e@YU3d2Balcivot{1(ahlE5qg@S-h(mPNH&`pBX$_~HdG48~)$x5p z{>ghzqqn_t8~pY<5?-To>cy^6o~mifr;KWvx_oMtXOw$$d6jddXG)V@a#lL4o%N@A zNJlQAz6R8{7jax-kQsH6JU_u*En%k^NHlvBB!$JAK!cYmS)HkLAkm0*9G3!vwMIWv zo#)+EamIJHEUV|$d|<)2iJ`lqBQLx;HgD}c3mRu{iK23C>G{0Mp1K)bt6OU?xC4!_ zZLqpFzeu&+>O1F>%g-%U^~yRg(-wSp@vmD-PT#bCWy!%&H;qT7rfuRCEgw67V!Qob z&tvPU@*4*$YF#2_>M0(75QxqrJr3Tvh~iDeFhxl=MzV@(psx%G8|I{~9;tv#BBE`l z3)_98eZqFNwEF1h)uqhBmT~mSmT8k$7vSHdR97K~kM)P9PuZdS;|Op4A?O<*%!?h` zn`}r_j%xvffs46x2hCWuo0BfIQWCw9aKkH==#B(TJ%p}p-RuIVzsRlaPL_Co{&R0h zQrqn=g1PGjQg3&sc2IlKG0Io#v%@p>tFwF)RG0ahYs@Zng6}M*d}Xua)+h&?$`%rb z;>M=iMh5eIHuJ5c$aC`y@CYjbFsJnSPH&}LQz4}za9YjDuao>Z^EdL@%saRm&LGQWXs*;FzwN#pH&j~SLhDZ+QzhplV_ij(NyMl z;v|}amvxRddO81LJFa~2QFUs z+Lk zZck)}9uK^buJNMo4G(rSdX{57(7&n=Q6$QZ@lIO9#<3pA2ceDpO_340B*pHlh_y{>i&c1?vdpN1j>3UN-;;Yq?P+V5oY`4Z(|P8SwWq<)n`W@AwcQ?E9 zd5j8>FT^m=MHEWfN9jS}UHHsU`&SScib$qd0i=ky0>4dz5ADy70AeIuSzw#gHhQ_c zOp1!v6qU)@8MY+ zMNIID?(CysRc2uZQ$l*QZVY)$X?@4$VT^>djbugLQJdm^P>?51#lXBkdXglYm|4{L zL%Sr?2f`J+xrcN@=0tiJt(<-=+v>tHy{XaGj7^cA6felUn_KPa?V4ebfq7~4i~GKE zpm)e@1=E;PP%?`vK6KVPKXjUXyLS1^NbnQ&?z>epHCd+J$ktT1G&L~T)nQeExe;0Z zlei}<_ni ztFo}j7nBl$)s_3odmdafVieFxc)m!wM+U`2u%yhJ90giFcU1`dR6BBTKc2cQ*d zm-{?M&%(={xYHy?VCx!ogr|4g5;V{2q(L?QzJGsirn~kWHU`l`rHiIrc-Nan!hR7zaLsPr4uR zG{En&gaRK&B@lyWV@yfFpD_^&z>84~_0Rd!v(Nr%PJhFF_ci3D#ixf|(r@$igZiWw za*qbXIJ_Hm4)TaQ=zW^g)FC6uvyO~Hg-#Z5Vsrybz6uOTF>Rq1($JS`imyNB7myWWpxYL(t7`H8*voI3Qz6mvm z$JxtArLJ(1wlCO_te?L{>8YPzQ})xJlvc5wv8p7Z=HviPYB#^#_vGO#*`<0r%MR#u zN_mV4vaBb2RwtoOYCw)X^>r{2a0kK|WyEYoBjGxcObFl&P*??)WEWKU*V~zG5o=s@ z;rc~uuQQf9wf)MYWsWgPR!wKGt6q;^8!cD_vxrG8GMoFGOVV=(J3w6Xk;}i)9(7*U zwR4VkP_5Zx7wqn8%M8uDj4f1aP+vh1Wue&ry@h|wuN(D2W;v6b1^ z`)7XBZ385zg;}&Pt@?dunQ=RduGRJn^9HLU&HaeUE_cA1{+oSIjmj3z+1YiOGiu-H zf8u-oVnG%KfhB8H?cg%@#V5n+L$MO2F4>XoBjBeX>css^h}Omu#)ExTfUE^07KOQS znMfQY2wz?!7!{*C^)aZ^UhMZf=TJNDv8VrrW;JJ9`=|L0`w9DE8MS>+o{f#{7}B4P z{I34>342vLsP}o=ny1eZkEabr@niT5J2AhByUz&i3Ck0H*H`LRHz;>3C_ru!X+EhJ z6(+(lI#4c`2{`q0o9aZhI|jRjBZOV~IA_km7ItNtUa(Wsr*Hmb;b4=;R(gF@GmsRI`pF+0tmq0zy~wnoJD(LSEwHjTOt4xb0XB-+ z&4RO{Snw4G%gS9w#uSUK$Zbb#=jxEl;}6&!b-rSY$0M4pftat-$Q)*y!bpx)R%P>8 zrB&`YEX2%+s#lFCIV;cUFUTIR$Gn2%F(3yLeiG8eG8&)+cpBlzx4)sK?>uIlH+$?2 z9q9wk5zY-xr_fzFSGxYp^KSY0s%1BhsI>ai2VAc8&JiwQ>3RRk?ITx!t~r45qsMnj zkX4bl06ojFCMq<9l*4NHMAtIxDJOX)H=K*$NkkNG<^nl46 zHWH1GXb?Og1f0S+8-((5yaeegCT62&4N*pNQY;%asz9r9Lfr;@Bl${1@a4QAvMLbV6JDp>8SO^q1)#(o%k!QiRSd0eTmzC< zNIFWY5?)+JTl1Roi=nS4%@5iF+%XztpR^BSuM~DX9q`;Mv=+$M+GgE$_>o+~$#?*y zAcD4nd~L~EsAjXV-+li6Lua4;(EFdi|M2qV53`^4|7gR8AJI;0Xb6QGLaYl1zr&eu zH_vFUt+Ouf4SXA~ z&Hh8K@ms^`(hJfdicecj>J^Aqd00^ccqN!-f-!=N7C1?`4J+`_f^nV!B3Q^|fuU)7 z1NDNT04hd4QqE+qBP+>ZE7{v;n3OGN`->|lHjNL5w40pePJ?^Y6bFk@^k%^5CXZ<+4qbOplxpe)l7c6m%o-l1oWmCx%c6@rx85hi(F=v(2 zJ$jN>?yPgU#DnbDXPkHLeQwED5)W5sH#-eS z%#^4dxiVs{+q(Yd^ShMN3GH)!h!@W&N`$L!SbElXCuvnqh{U7lcCvHI#{ZjwnKvu~ zAeo7Pqot+Ohm{8|RJsTr3J4GjCy5UTo_u_~p)MS&Z5UrUc|+;Mc(YS+ju|m3Y_Dvt zonVtpBWlM718YwaN3a3wUNqX;7TqvAFnVUoD5v5WTh~}r)KoLUDw%8Rrqso~bJqd> z_T!&Rmr6ebpV^4|knJZ%qmzL;OvG3~A*loGY7?YS%hS{2R0%NQ@fRoEK52Aiu%gj( z_7~a}eQUh8PnyI^J!>pxB(x7FeINHHC4zLDT`&C*XUpp@s0_B^!k5Uu)^j_uuu^T> z8WW!QK0SgwFHTA%M!L`bl3hHjPp)|wL5Var_*A1-H8LV?uY5&ou{hRjj>#X@rxV>5%-9hbP+v?$4}3EfoRH;l_wSiz{&1<+`Y5%o%q~4rdpRF0jOsCoLnWY5x?V)0ga>CDo`NpqS) z@x`mh1QGkx;f)p-n^*g5M^zRTHz%b2IkLBY{F+HsjrFC9_H(=9Z5W&Eymh~A_FUJ} znhTc9KG((OnjFO=+q>JQZJbeOoUM77M{)$)qQMcxK9f;=L;IOv_J>*~w^YOW744QZ zoG;!b9VD3ww}OX<8sZ0F##8hvfDP{hpa3HjaLsKbLJ8 z0WpY2E!w?&cWi7&N%bOMZD~o7QT*$xCRJ@{t31~qx~+0yYrLXubXh2{_L699Nl_pn z6)9eu+uUTUdjHXYs#pX^L)AIb!FjjNsTp7C399w&B{Q4q%yKfmy}T2uQdU|1EpNcY zDk~(h#AdxybjfzB+mg6rdU9mDZ^V>|U13Dl$Gj+pAL}lR2a1u!SJXU_YqP9N{ose4 zk+$v}BIHX60WSGVWv;S%zvHOWdDP(-ceo(<8`y@Goy%4wDu>57QZNJc)f>Ls+}9h7 z^N=#3q3|l?aG8K#HwiW2^PJu{v|x5;awYfahC?>_af3$LmMc4%N~JwVlRZa4c+eW2 zE!zosAjOv&UeCeu;Bn5OQUC=jtZjF;NDk9$fGbxf3d29SUBekX1!a$Vmq_VK*MHQ4)eB!dQrHH)LVYNF%-t8!d`@!cb z2CsKs3|!}T^7fSZm?0dJ^JE`ZGxA&a!jC<>6_y67On0M)hd$m*RAzo_qM?aeqkm`* zXpDYcc_>TFZYaC3JV>{>mp(5H^efu!Waa7hGTAts29jjuVd1vI*fEeB?A&uG<8dLZ z(j6;-%vJ7R0U9}XkH)1g>&uptXPHBEA*7PSO2TZ+dbhVxspNW~ZQT3fApz}2 z_@0-lZODcd>dLrYp!mHn4k>>7kibI!Em+Vh*;z}l?0qro=aJt68joCr5Jo(Vk<@i) z5BCKb4p6Gdr9=JSf(2Mgr=_6}%4?SwhV+JZj3Ox^_^OrQk$B^v?eNz}d^xRaz&~ zKVnlLnK#8^y=If2f1zmb~^5lPLe?%l}>?~wN4IN((2~U{e9fKhLMtYFj)I$(y zgnKv?R+ZpxA$f)Q2l=aqE6EPTK=i0sY&MDFJp!vQayyvzh4wee<}kybNthRlX>SHh z7S}9he^EBOqzBCww^duHu!u+dnf9veG{HjW!}aT7aJqzze9K6-Z~8pZAgdm1n~aDs z8_s7?WXMPJ3EPJHi}NL&d;lZP8hDhAXf5Hd!x|^kEHu`6QukXrVdLnq5zbI~oPo?7 z2Cbu8U?$K!Z4_yNM1a(bL!GRe!@{Qom+DxjrJ!B99qu5b*Ma%^&-=6UEbC+S2zX&= zQ!%bgJTvmv^2}hhvNQg!l=kbapAgM^hruE3k@jTxsG(B6d=4thBC*4tzVpCYXFc$a zeqgVB^zua)y-YjpiibCCdU%txXYeNFnXcbNj*D?~)5AGjL+!!ij_4{5EWKGav0^={~M^q}baAFOPzxfUM>`KPf|G z&hsaR*7(M6KzTj8Z?;45zX@L#xU{4n$9Q_<-ac(y4g~S|Hyp^-<*d8+P4NHe?~vfm z@y309=`lGdvN8*jw-CL<;o#DKc-%lb0i9a3%{v&2X($|Qxv(_*()&=xD=5oBg=$B0 zU?41h9)JKvP0yR{KsHoC>&`(Uz>?_`tlLjw1&5tPH3FoB%}j;yffm$$s$C=RHi`I3*m@%CPqWnP@B~%DEe;7ZT{9!IMTo1hT3Q347HJ&!)BM2 z3~aClf>aFh0_9||4G}(Npu`9xYY1*SD|M~9!CCFn{-J$u2&Dg*=5$_nozpoD2nxqq zB!--eA8UWZlcEDp4r#vhZ6|vq^9sFvRnA9HpHch5Mq4*T)oGbruj!U8Lx_G%Lby}o zTQ-_4A7b)5A42vA0U}hUJq6&wQ0J%$`w#ph!EGmW96)@{AUx>q6E>-r^Emk!iCR+X zdIaNH`$}7%57D1FyTccs3}Aq0<0Ei{`=S7*>pyg=Kv3nrqblqZcpsCWSQl^uMSsdj zYzh73?6th$c~CI0>%5@!Ej`o)Xm38u0fp9=HE@Sa6l2oX9^^4|Aq%GA z3(AbFR9gA_2T2i%Ck5V2Q2WW-(a&(j#@l6wE4Z`xg#S za#-UWUpU2U!TmIo`CN0JwG^>{+V#9;zvx;ztc$}@NlcyJr?q(Y`UdW6qhq!aWyB5xV1#Jb{I-ghFNO0 zFU~+QgPs{FY1AbiU&S$QSix>*rqYVma<-~s%ALhFyVhAYepId1 zs!gOB&weC18yhE-v6ltKZMV|>JwTX+X)Y_EI(Ff^3$WTD|Ea-1HlP;6L~&40Q&5{0 z$e$2KhUgH8ucMJxJV#M%cs!d~#hR^nRwk|uuCSf6irJCkSyI<%CR==tftx6d%;?ef zYIcjZrP@APzbtOeUe>m-TW}c-ugh+U*RbL1eIY{?>@8aW9bb1NGRy@MTse@>= za%;5=U}X%K2tKTYe9gjMcBvX%qrC&uZ`d(t)g)X8snf?vBe3H%dG=bl^rv8Z@YN$gd9yveHY0@Wt0$s zh^7jCp(q+6XDoekb;=%y=Wr8%6;z0ANH5dDR_VudDG|&_lYykJaiR+(y{zpR=qL3|2e${8 z2V;?jgHj7}Kl(d8C9xWRjhpf_)KOXl+@c4wrHy zL3#9U(`=N59og2KqVh>nK~g9>fX*PI0`>i;;b6KF|8zg+k2hViCt}4dfMdvb1NJ-Rfa7vL2;lPK{Lq*u`JT>S zoM_bZ_?UY6oV6Ja14X^;LqJPl+w?vf*C!nGK;uU^0GRN|UeFF@;H(Hgp8x^|;ygh? zIZx3DuO(lD01ksanR@Mn#lti=p28RTNYY6yK={RMFiVd~k8!@a&^jicZ&rxD3CCI! zVb=fI?;c#f{K4Pp2lnb8iF2mig)|6JEmU86Y%l}m>(VnI*Bj`a6qk8QL&~PFDxI8b z2mcsQBe9$q`Q$LfG2wdvK`M1}7?SwLAV&)nO;kAk`SAz%x9CDVHVbUd$O(*aI@D|s zLxJW7W(QeGpQY<$dSD6U$ja(;Hb3{Zx@)*fIQaW{8<$KJ&fS0caI2Py^clOq9@Irt z7th7F?7W`j{&UmM==Lo~T&^R7A?G=K_e-zfTX|)i`pLitlNE(~tq*}sS1x2}Jlul6 z5+r#4SpQu8h{ntIv#qCVH`uG~+I8l+7ZG&d`Dm!+(rZQDV*1LS^WfH%-!5aTAxry~ z4xl&rot5ct{xQ$w$MtVTUi6tBFSJWq2Rj@?HAX1H$eL*fk{Hq;E`x|hghRkipYNyt zKCO=*KSziiVk|+)qQCGrTYH9X!Z0$k{Nde~0Wl`P{}ca%nv<6fnYw^~9dYxTnTZB&&962jX0DM&wy&8fdxX8xeHSe=UU&Mq zRTaUKnQO|A>E#|PUo+F=Q@dMdt`P*6e92za(TH{5C*2I2S~p?~O@hYiT>1(n^Lqqn zqewq3ctAA%0E)r53*P-a8Ak32mGtUG`L^WVcm`QovX`ecB4E9X60wrA(6NZ7z~*_DV_e z8$I*eZ8m=WtChE{#QzeyHpZ%7GwFHlwo2*tAuloI-j2exx3#x7EL^&D;Re|Kj-XT- zt908^soV2`7s+Hha!d^#J+B)0-`{qIF_x=B811SZlbUe%kvPce^xu7?LY|C z@f1gRPha1jq|=f}Se)}v-7MWH9)YAs*FJ&v3ZT9TSi?e#jarin0tjPNmxZNU_JFJG z+tZi!q)JP|4pQ)?l8$hRaPeoKf!3>MM-bp06RodLa*wD=g3)@pYJ^*YrwSIO!SaZo zDTb!G9d!hb%Y0QdYxqNSCT5o0I!GDD$Z@N!8J3eI@@0AiJmD7brkvF!pJGg_AiJ1I zO^^cKe`w$DsO|1#^_|`6XTfw6E3SJ(agG*G9qj?JiqFSL|6tSD6vUwK?Cwr~gg)Do zp@$D~7~66-=p4`!!UzJDKAymb!!R(}%O?Uel|rMH>OpRGINALtg%gpg`=}M^Q#V5( zMgJY&gF)+;`e38QHI*c%B}m94o&tOfae;og&!J2;6ENW}QeL73jatbI1*9X~y=$Dm%6FwDcnCyMRL}zo`0=y7=}*Uw zo3!qZncAL{HCgY!+}eKr{P8o27ye+;qJP;kOB%RpSesGoHLT6tcYp*6v~Z9NCyb6m zP#qds0jyqXX46qMNhXDn3pyIxw2f_z;L_X9EIB}AhyC`FYI}G3$WnW>#NMy{0aw}nB%1=Z4&*(FaCn5QG(zvdG^pQRU25;{wwG4h z@kuLO0F->{@g2!;NNd!PfqM-;@F0;&wK}0fT9UrH}(8A5I zt33(+&U;CLN|8+71@g z(s!f-kZZZILUG$QXm9iYiE*>2w;gpM>lgM{R9vT3q>qI{ELO2hJHVi`)*jzOk$r)9 zq}$VrE0$GUCm6A3H5J-=Z9i*biw8ng zi<1nM0lo^KqRY@Asucc#DMmWsnCS;5uPR)GL3pL=-IqSd>4&D&NKSGHH?pG;=Xo`w zw~VV9ddkwbp~m>9G0*b?j7-0fOwR?*U#BE#n7A=_fDS>`fwatxQ+`FzhBGQUAyIRZ??eJt46vHBlR>9m!vfb6I)8!v6TmtZ%G6&E|1e zOtx5xy%yOSu+<9Ul5w5N=&~4Oph?I=ZKLX5DXO(*&Po>5KjbY7s@tp$8(fO|`Xy}Y z;NmMypLoG7r#Xz4aHz7n)MYZ7Z1v;DFHLNV{)to;(;TJ=bbMgud96xRMME#0d$z-S z-r1ROBbW^&YdQWA>U|Y>{whex#~K!ZgEEk=LYG8Wqo28NFv)!t!~}quaAt}I^y-m| z8~E{9H2VnyVxb_wCZ7v%y(B@VrM6lzk~|ywCi3HeiSV`TF>j+Ijd|p*kyn;=mqtf8&DK^|*f+y$38+9!sis9N=S)nINm9=CJ<;Y z!t&C>MIeyou4XLM*ywT_JuOXR>VkpFwuT9j5>667A=CU*{TBrMTgb4HuW&!%Yt`;#md7-`R`ouOi$rEd!ErI zo#>qggAcx?C7`rQ2;)~PYCw%CkS(@EJHZ|!!lhi@Dp$*n^mgrrImsS~(ioGak>3)w zvop0lq@IISuA0Ou*#1JkG{U>xSQV1e}c)!d$L1plFX5XDXX5N7Ns{kT{y5|6MfhBD+esT)e7&CgSW8FxsXTAY=}?0A!j_V9 zJ;IJ~d%av<@=fNPJ9)T3qE78kaz64E>dJaYab5uaU`n~Zdp2h{8DV%SKE5G^$LfuOTRRjB;TnT(Jk$r{Pfe4CO!SM_7d)I zquW~FVCpSycJ~c*B*V8?Qqo=GwU8CkmmLFugfHQ7;A{yCy1OL-+X=twLYg9|H=~8H znnN@|tCs^ZLlCBl5wHvYF}2vo>a6%mUWpTds_mt*@wMN4-r`%NTA%+$(`m6{MNpi@ zMx)8f>U4hd!row@gM&PVo&Hx+lV@$j9yWTjTue zG9n0DP<*HUmJ7ZZWwI2x+{t3QEfr6?T}2iXl=6e0b~)J>X3`!fXd9+2wc1%cj&F@Z zgYR|r5Xd5jy9;YW&=4{-0rJ*L5CgDPj9^3%bp-`HkyBs`j1iTUGD4?WilZ6RO8mIE z+~Joc?GID6K96dyuv(dWREK9Os~%?$$FxswxQsoOi8M?RnL%B~Lyk&(-09D0M?^Jy zWjP)n(b)TF<-|CG%!Vz?8Fu&6iU<>oG#kGcrcrrBlfZMVl0wOJvsq%RL9To%iCW@)#& zZAJWhgzYAq)#NTNb~3GBcD%ZZOc43!YWSyA7TD6xkk)n^FaRAz73b}%9d&YisBic(?mv=Iq^r%Ug zzHq-rRrhfOOF+yR=AN!a9*Rd#sM9ONt5h~w)yMP7Dl9lfpi$H0%GPW^lS4~~?vI8Z z%^ToK#NOe0ExmUsb`lLO$W*}yXNOxPe@zD*90uTDULnH6C?InP3J=jYEO2d)&e|mP z1DSd0QOZeuLWo*NqZzopA+LXy9)fJC00NSX=_4Mi1Z)YyZVC>C!g}cY(Amaj%QN+bev|Xxd2OPD zk!dfkY6k!(sDBvsFC2r^?}hb81(WG5Lt9|riT`2?P;B%jaf5UX<~OJ;uAL$=Ien+V zC!V8u0v?CUa)4*Q+Q_u zkx{q;NjLcvyMuU*{+uDsCQ4U{JLowYby-tn@hatL zy}X>9y08#}oytdn^qfFesF)Tt(2!XGw#r%?7&zzFFh2U;#U9XBO8W--#gOpfbJ`Ey z|M8FCKlWQrOJwE;@Sm02l9OBr7N}go4V8ur)}M@m2uWjggb)DC4s`I4d7_8O&E(j; z?3$9~R$QDxNM^rNh9Y;6P7w+bo2q}NEd6f&_raor-v`UCaTM3TT8HK2-$|n{N@U>_ zL-`P7EXoEU5JRMa)?tNUEe8XFis+w8g9k(QQ)%?&Oac}S`2V$b?%`DwXBgja&&fR@ zH_XidF$p1wA)J|Wk1;?lCl?fgc)=TB3>Y8;BoMqHwJqhL)Tgydv9(?(TBX)fq%=~C zmLj!iX-kn7QA(9snzk0LRf<%SzO&~IhLor6A3f*U^UcoAygRe!H#@UCv$JUP&vPxs zeDj$1%#<2T1!e|!7xI+~_VXLl5|jHqvOhU7ZDUGee;HnkcPP=_k_FFxPjXg*9KyI+ zIh0@+s)1JDSuKMeaDZ3|<_*J8{TUFDLl|mXmY8B>Wj_?4mC#=XjsCKPEO=p0c&t&Z zd1%kHxR#o9S*C?du*}tEHfAC7WetnvS}`<%j=o7YVna)6pw(xzkUi7f#$|^y4WQ{7 zu@@lu=j6xr*11VEIY+`B{tgd(c3zO8%nGk0U^%ec6h)G_`ki|XQXr!?NsQkxzV6Bn1ea9L+@ z(Zr7CU_oXaW>VOdfzENm+FlFQ7Se0ROrNdw(QLvb6{f}HRQ{$Je>(c&rws#{dFI^r zZ4^(`J*G0~Pu_+p5AAh>RRpkcbaS2a?Fe&JqxDTp`dIW9;DL%0wxX5;`KxyA4F{(~_`93>NF@bj4LF!NC&D6Zm+Di$Q-tb2*Q z&csGmXyqA%Z9s(AxNO3@Ij=WGt=UG6J7F;r*uqdQa z?7j!nV{8eQE-cwY7L(3AEXF3&V*9{DpSYdyCjRhv#&2johwf{r+k`QB81%!aRVN<& z@b*N^xiw_lU>H~@4MWzgHxSOGVfnD|iC7=hf0%CPm_@@4^t-nj#GHMug&S|FJtr?i z^JVrobltd(-?Ll>)6>jwgX=dUy+^n_ifzM>3)an3iOzpG9Tu;+96TP<0Jm_PIqof3 zMn=~M!#Ky{CTN_2f7Y-i#|gW~32RCWKA4-J9sS&>kYpTOx#xVNLCo)A$LUme^fVNH z@^S7VU^UJ0YR8?Oy$^IYuG*bm|g;@aX~i60%`7XLy*AYpYvZ^F^U(!|RW z*C!rJ@+7TGdL=nNd1gv^%B+;Fcr$y)i0!GRsZXRHPs>QVGVR{9r_#&Qd(wL|5;H;> zD>HUw=4CF++&{7$<8G@j*nGjhEO%BQYfjeItp4mPvY*JYb1HKd!{HJ9*)(3%BR%{Pp?AM&*yHAJsW({ivOzj*qS!-7|XEn6@zo z3L*tBT%<4RxoAh>q{0n_JBmgW6&8hx?kL(_^k%VL>?xjAyrKBmSl`$=V|SK}ELl}@ zd|d0eo#RfG`bw9SK3%r4Y+rdvc}w}~ixV%tqawbdqvE-WcgE+BUpxMT%F@btm76MG zn=oQRWWuTm+a{dy)Oc2V4yX(@M{QAkx>(QB59*`dLT`Pz3Lsj9iB=HSHAiCq()ns|Cr)1*c605Cx}3V&x}Lg?b+6Q?)z7Kl zQh&1Hx`y6JY-Cwvd*ozeps}a1xAA0CR+Da;+O(i)P1C;SjOI}Dtmf6tPqo-Bl`U78 zv$kYgPntPp@G)n1an9tEoL*Vumu9`>_@I(;+5+fBa-*?fEx=mTEjZ7wq}#@Gd5_cW z!mP{N=yqEntDo)|>oy6{9cu+-3*GTnmb^`O0^FzRPO^&aG`f@F_R*aQ_e{F+_9%NW z4KG_B`@X3EVV9L>?_RNDMddA>w=e0KfAiw5?#i1NFT%Zz#nuv(&!yIU>lVxmzYKQ` zzJ*0w9<&L4aJ6A;0j|_~i>+y(q-=;2Xxhx2v%CYY^{} z^J@LO()eLo|7!{ghQ+(u$wxO*xY#)cL(|miH2_ck2yN{mu4O9=hBW*pM_()-_YdH#Ru{JtwJ^R2}3?!>>m1pohh zrn(!xCjE0Q&EH1QK?zA%sxVh&H99cObJUY$veZhQ)MLu-h%`!*G)s$2k;~+A z)Kk->Ri?`oGDEJEtI*wijm(s5f$W78FH{+qBxiU{~kq((J3uK{m z$|C8K#j-?hm8H@x%VfFqpnvu@xn1s%J7uNZC9C99a<_b1J|mx%)$%!6gPU|~<@2&m zz99GDp`|a%m*iggvfL;4%X;~WY>)@!tMWB@P`)k?$;0x9JSrRI8?s3rlgH(o@`OAo zn{f*gZ#t2u6K??hx|aElOM`Xd0t+SAIUEHvFw%?Wsm$s zUXq{6UU?a>Nc@@Xlb_2k9M1Ctr<#+O?yd}rv z_wu&=_t$!Yngd@N_AUj}T; z#*Ce|%XZr_sQcsWcsl{pCnnj+c8ZNIMmx<;w=-g$Q>BU;9k;w|zQ;4!W32Xg2Cd?{ zvmO3kuKQ^Hv;o>6ZHP8ZJ2`4~Bx?N;cf<0fi=!*G^^WzbTF3e$b&d^qqB{>nqLG81 zs94bBh%|Vj+hLu=!8(b9brJ>ZBns9^6s(gdSVyP9qnu2_I{Sg8j-rloG6{d`De5We zDe5WeY3ga}Y3ga}Y3ga}Y3ga}Y3ga}d8y~6o|k%F>UpW>rJk31Ug~+N=cS&HdOqs; zsOO`ek9t1p`Kafko{xGy>iMbXr=FjBxZMYc8a#gL`Kjlpo}YSt>iMY`pk9DF0qO*( z6QE9jIsxhgs1u-0kUBx8D@eT{^@7w3QZGooAoYUO3sNscy%6<6)C*BBM7L`dk$Xk%6}eZQXgo#!75P`>Uy*-B{uTLGUy*-B{uTLGUy*-B{uTLG))v8{5gt_uj9!t5)^yb-JtjRGrhi zYInOUNJxNyf_yKX01)K=WP|Si>HqEj|B{eUl?MR<)%<1&{(~)D+NPwKxWqT-@~snp zg9KCz1VTZDiS?UH`PRk1VPM{29cgT9=D?!Wc_@}qzggFv;gb@2cJQAYWWtpEZ7?y@jSVqjx${B5UV@SO|wH<<0; z{><1KdVI%Ki}>~<`46C0AggwUwx-|QcU;iiZ{NZu`ur>hd*|Hb(|6veERqxu=b@5Bab=rqptGxd{QJg!4*-i_$sES~)AB46}Fjg|ea#e@?J}z%CUJ zOsLWRQR1#ng^sD)A4FDuY!iUhzlgfJh(J@BRqd&P#v2B`+saBx>m+M&q7vk-75$NH%T5pi%m z5FX?`2-5l53=a&GkC9^NZCLpN5(DMKMwwab$FDIs?q>4!!xBS}75gX_5;(luk;3Vl zLCLd5a_8`Iyz}K}+#RMwu6DVk3O_-}n>aE!4NaD*sQn`GxY?cHe!Bl9n?u&g6?aKm z-P8z&;Q3gr;h`YIxX%z^o&GZZg1=>_+hP2$$-DnL_?7?3^!WAsY4I7|@K;aL<>OTK zByfjl2PA$T83*LM9(;espx-qB%wv7H2i6CFsfAg<9V>Pj*OpwX)l?^mQfr$*OPPS$ z=`mzTYs{*(UW^ij1U8UfXjNoY7GK*+YHht(2oKE&tfZuvAyoN(;_OF>-J6AMmS5fB z^sY6wea&&${+!}@R1f$5oC-2J>J-A${@r(dRzc`wnK>a7~8{Y-scc|ETOI8 zjtNY%Y2!PI;8-@a=O}+{ap1Ewk0@T`C`q!|=KceX9gK8wtOtIC96}-^7)v23Mu;MH zhKyLGOQMujfRG$p(s`(2*nP4EH7*J57^=|%t(#PwCcW7U%e=8Jb>p6~>RAlY4a*ts=pl}_J{->@kKzxH|8XQ5{t=E zV&o`$D#ZHdv&iZWFa)(~oBh-Osl{~CS0hfM7?PyWUWsr5oYlsyC1cwULoQ4|Y5RHA2*rN+EnFPnu z`Y_&Yz*#550YJwDy@brZU>0pWV^RxRjL221@2ABq)AtA%Cz?+FG(}Yh?^v)1Lnh%D zeM{{3&-4#F9rZhS@DT0E(WRkrG!jC#5?OFjZv*xQjUP~XsaxL2rqRKvPW$zHqHr8Urp2Z)L z+)EvQeoeJ8c6A#Iy9>3lxiH3=@86uiTbnnJJJoypZ7gco_*HvKOH97B? zWiwp>+r}*Zf9b3ImxwvjL~h~j<<3shN8$k-$V1p|96I!=N6VBqmb==Bec|*;HUg?) z4!5#R*(#Fe)w%+RH#y{8&%%!|fQ5JcFzUE;-yVYR^&Ek55AXb{^w|@j|&G z|6C-+*On%j;W|f8mj?;679?!qY86c{(s1-PI2Wahoclf%1*8%JAvRh1(0)5Vu37Iz z`JY?RW@qKr+FMmBC{TC7k@}fv-k8t6iO}4K-i3WkF!Lc=D`nuD)v#Na zA|R*no51fkUN3^rmI;tty#IK284*2Zu!kG13!$OlxJAt@zLU`kvsazO25TpJLbK&;M8kw*0)*14kpf*)3;GiDh;C(F}$- z1;!=OBkW#ctacN=je*Pr)lnGzX=OwgNZjTpVbFxqb;8kTc@X&L2XR0A7oc!Mf2?u9 zcctQLCCr+tYipa_k=;1ETIpHt!Jeo;iy^xqBES^Ct6-+wHi%2g&)?7N^Yy zUrMIu){Jk)luDa@7We5U!$$3XFNbyRT!YPIbMKj5$IEpTX1IOtVP~(UPO2-+9ZFi6 z-$3<|{Xb#@tABt0M0s1TVCWKwveDy^S!!@4$s|DAqhsEv--Z}Dl)t%0G>U#ycJ7cy z^8%;|pg32=7~MJmqlC-x07Sd!2YX^|2D`?y;-$a!rZ3R5ia{v1QI_^>gi(HSS_e%2 zUbdg^zjMBBiLr8eSI^BqXM6HKKg#@-w`a**w(}RMe%XWl3MipvBODo*hi?+ykYq)z ziqy4goZw0@VIUY65+L7DaM5q=KWFd$;W3S!Zi>sOzpEF#(*3V-27N;^pDRoMh~(ZD zJLZXIam0lM7U#)119Hm947W)p3$%V`0Tv+*n=&ybF&}h~FA}7hEpA&1Y!BiYIb~~D z$TSo9#3ee02e^%*@4|*+=Nq6&JG5>zX4k5f?)z*#pI-G(+j|jye%13CUdcSP;rNlY z#Q!X%zHf|V)GWIcEz-=fW6AahfxI~y7w7i|PK6H@@twdgH>D_R@>&OtKl}%MuAQ7I zcpFmV^~w~8$4@zzh~P~+?B~%L@EM3x(^KXJSgc6I=;)B6 zpRco2LKIlURPE*XUmZ^|1vb?w*ZfF}EXvY13I4af+()bAI5V?BRbFp`Sb{8GRJHd* z4S2s%4A)6Uc=PK%4@PbJ<{1R6+2THMk0c+kif**#ZGE)w6WsqH z`r^DL&r8|OEAumm^qyrryd(HQ9olv$ltnVGB{aY?_76Uk%6p;e)2DTvF(;t=Q+|8b zqfT(u5@BP);6;jmRAEV057E*2d^wx@*aL1GqWU|$6h5%O@cQtVtC^isd%gD7PZ_Io z_BDP5w(2*)Mu&JxS@X%%ByH_@+l>y07jIc~!@;Raw)q_;9oy@*U#mCnc7%t85qa4? z%_Vr5tkN^}(^>`EFhag;!MpRh!&bKnveQZAJ4)gEJo1@wHtT$Gs6IpznN$Lk-$NcM z3ReVC&qcXvfGX$I0nfkS$a|Pm%x+lq{WweNc;K>a1M@EAVWs2IBcQPiEJNt}+Ea8~WiapASoMvo(&PdUO}AfC~>ZGzqWjd)4no( ziLi#e3lOU~sI*XPH&n&J0cWfoh*}eWEEZW%vX?YK!$?w}htY|GALx3;YZoo=JCF4@ zdiaA-uq!*L5;Yg)z-_`MciiIwDAAR3-snC4V+KA>&V%Ak;p{1u>{Lw$NFj)Yn0Ms2*kxUZ)OTddbiJM}PK!DM}Ot zczn?EZXhx3wyu6i{QMz_Ht%b?K&-@5r;8b076YDir`KXF0&2i9NQ~#JYaq*}Ylb}^ z<{{6xy&;dQ;|@k_(31PDr!}}W$zF7Jv@f%um0M$#=8ygpu%j(VU-d5JtQwT714#f0z+Cm$F9JjGr_G!~NS@L9P;C1? z;Ij2YVYuv}tzU+HugU=f9b1Wbx3418+xj$RKD;$gf$0j_A&c;-OhoF*z@DhEW@d9o zbQBjqEQnn2aG?N9{bmD^A#Um6SDKsm0g{g_<4^dJjg_l_HXdDMk!p`oFv8+@_v_9> zq;#WkQ!GNGfLT7f8m60H@$tu?p;o_It#TApmE`xnZr|_|cb3XXE)N^buLE`9R=Qbg zXJu}6r07me2HU<)S7m?@GzrQDTE3UH?FXM7V+-lT#l}P(U>Fvnyw8T7RTeP`R579m zj=Y>qDw1h-;|mX-)cSXCc$?hr;43LQt)7z$1QG^pyclQ1Bd!jbzsVEgIg~u9b38;> zfsRa%U`l%did6HzPRd;TK{_EW;n^Ivp-%pu0%9G-z@Au{Ry+EqEcqW=z-#6;-!{WA z;l+xC6Zke>dl+(R1q7B^Hu~HmrG~Kt575mzve>x*cL-shl+zqp6yuGX)DDGm`cid! znlnZY=+a5*xQ=$qM}5$N+o!^(TqTFHDdyCcL8NM4VY@2gnNXF|D?5a558Lb*Yfm4) z_;0%2EF7k{)i(tTvS`l5he^KvW%l&-suPwpIlWB_Za1Hfa$@J!emrcyPpTKKM@NqL z?X_SqHt#DucWm<3Lp}W|&YyQE27zbGP55=HtZmB(k*WZA79f##?TweCt{%5yuc+Kx zgfSrIZI*Y57FOD9l@H0nzqOu|Bhrm&^m_RK6^Z<^N($=DDxyyPLA z+J)E(gs9AfaO`5qk$IGGY+_*tEk0n_wrM}n4G#So>8Dw6#K7tx@g;U`8hN_R;^Uw9JLRUgOQ?PTMr4YD5H7=ryv)bPtl=<&4&% z*w6k|D-%Tg*F~sh0Ns(h&mOQ_Qf{`#_XU44(VDY8b})RFpLykg10uxUztD>gswTH} z&&xgt>zc(+=GdM2gIQ%3V4AGxPFW0*l0YsbA|nFZpN~ih4u-P!{39d@_MN)DC%d1w z7>SaUs-g@Hp7xqZ3Tn)e z7x^sC`xJ{V<3YrmbB{h9i5rdancCEyL=9ZOJXoVHo@$$-%ZaNm-75Z-Ry9Z%!^+STWyv~To>{^T&MW0-;$3yc9L2mhq z;ZbQ5LGNM+aN628)Cs16>p55^T^*8$Dw&ss_~4G5Go63gW^CY+0+Z07f2WB4Dh0^q z-|6QgV8__5>~&z1gq0FxDWr`OzmR}3aJmCA^d_eufde7;d|OCrKdnaM>4(M%4V`PxpCJc~UhEuddx9)@)9qe_|i z)0EA%&P@_&9&o#9eqZCUCbh?`j!zgih5sJ%c4(7_#|Xt#r7MVL&Q+^PQEg3MBW;4T zG^4-*8L%s|A}R%*eGdx&i}B1He(mLygTmIAc^G(9Si zK7e{Ngoq>r-r-zhyygK)*9cj8_%g z)`>ANlipCdzw(raeqP-+ldhyUv_VOht+!w*>Sh+Z7(7(l=9~_Vk ztsM|g1xW`?)?|@m2jyAgC_IB`Mtz(O`mwgP15`lPb2V+VihV#29>y=H6ujE#rdnK` zH`EaHzABs~teIrh`ScxMz}FC**_Ii?^EbL(n90b(F0r0PMQ70UkL}tv;*4~bKCiYm zqngRuGy`^c_*M6{*_~%7FmOMquOEZXAg1^kM`)0ZrFqgC>C%RJvQSo_OAA(WF3{euE}GaeA?tu5kF@#62mM$a051I zNhE>u>!gFE8g#Jj95BqHQS%|>DOj71MZ?EYfM+MiJcX?>*}vKfGaBfQFZ3f^Q-R1# znhyK1*RvO@nHb|^i4Ep_0s{lZwCNa;Ix<{E5cUReguJf+72QRZIc%`9-Vy)D zWKhb?FbluyDTgT^naN%l2|rm}oO6D0=3kfXO2L{tqj(kDqjbl(pYz9DykeZlk4iW5 zER`)vqJxx(NOa;so@buE!389-YLbEi@6rZG0#GBsC+Z0fzT6+d7deYVU;dy!rPXiE zmu73@Jr&~K{-9MVQD}&`)e>yLNWr>Yh8CXae9XqfvVQ&eC_;#zpoaMxZ0GpZz7xjx z`t_Q-F?u=vrRPaj3r<9&t6K=+egimiJ8D4gh-rUYvaVy zG($v+3zk5sMuOhjxkH7bQ}(5{PD3Mg?!@8PkK&w>n7tO8FmAmoF30_#^B~c(Q_`4L zYWOoDVSnK|1=p{+@`Fk^Qb81Xf89_S`RSTzv(a4ID%71nll%{Wad$!CKfeTKkyC?n zCkMKHU#*nz_(tO$M)UP&ZfJ#*q(0Gr!E(l5(ce<3xut+_i8XrK8?Xr7_oeHz(bZ?~8q5q~$Rah{5@@7SMN zx9PnJ-5?^xeW2m?yC_7A#WK*B@oIy*Y@iC1n7lYKj&m7vV;KP4TVll=II)$39dOJ^czLRU>L> z68P*PFMN+WXxdAu=Hyt3g$l(GTeTVOZYw3KY|W0Fk-$S_`@9`K=60)bEy?Z%tT+Iq z7f>%M9P)FGg3EY$ood+v$pdsXvG? zd2q3abeu-}LfAQWY@=*+#`CX8RChoA`=1!hS1x5dOF)rGjX4KFg!iPHZE2E=rv|A} zro(8h38LLFljl^>?nJkc+wdY&MOOlVa@6>vBki#gKhNVv+%Add{g6#-@Z$k*ps}0Y zQ=8$)+Nm||)mVz^aa4b-Vpg=1daRaOU)8@BY4jS>=5n#6abG@(F2`=k-eQ9@u# zxfNFHv=z2w@{p1dzSOgHokX1AUGT0DY4jQI@YMw)EWQ~q5wmR$KQ}Y;(HPMSQCwzu zdli|G?bj(>++CP)yQ4s6YfpDc3KqPmquQSxg%*EnTWumWugbDW5ef%8j-rT#3rJu? z)5n;4b2c*;2LIW%LmvUu6t1~di~}0&Svy}QX#ER|hDFZwl!~zUP&}B1oKAxIzt~so zb!GaJYOb#&qRUjEI1xe_`@7qv_-LggQ$JE8+{ryT4%ldwC5ete+{G3C#g@^oxfY3#F zcLlj(l2G8>tC<5XWV|6_DZQZ7ow?MD8EZ9mM2oV~WoV-uoExmbwpzc6eMV}%J_{3l zW(4t2a-o}XRlU|NSiYn!*nR(Sc>*@TuU*(S77gfCi7+WR%2b;4#RiyxWR3(u5BIdf zo@#g4wQjtG3T$PqdX$2z8Zi|QP~I^*9iC+(!;?qkyk&Q7v>DLJGjS44q|%yBz}}>i z&Ve%^6>xY<=Pi9WlwpWB%K10Iz`*#gS^YqMeV9$4qFchMFO}(%y}xs2Hn_E}s4=*3 z+lAeCKtS}9E{l(P=PBI;rsYVG-gw}-_x;KwUefIB@V%RLA&}WU2XCL_?hZHoR<7ED zY}4#P_MmX(_G_lqfp=+iX|!*)RdLCr-1w`4rB_@bI&Uz# z!>9C3&LdoB$r+O#n);WTPi;V52OhNeKfW6_NLnw zpFTuLC^@aPy~ZGUPZr;)=-p|b$-R8htO)JXy{ecE5a|b{{&0O%H2rN&9(VHxmvNly zbY?sVk}@^{aw)%#J}|UW=ucLWs%%j)^n7S%8D1Woi$UT}VuU6@Sd6zc2+t_2IMBxd zb4R#ykMr8s5gKy=v+opw6;4R&&46$V+OOpDZwp3iR0Osqpjx))joB*iX+diVl?E~Q zc|$qmb#T#7Kcal042LUNAoPTPUxF-iGFw>ZFnUqU@y$&s8%h-HGD`EoNBbe#S>Y-4 zlkeAP>62k~-N zHQqXXyN67hGD6CxQIq_zoepU&j0 zYO&}<4cS^2sp!;5))(aAD!KmUED#QGr48DVlwbyft31WlS2yU<1>#VMp?>D1BCFfB z_JJ-kxTB{OLI}5XcPHXUo}x~->VP%of!G_N-(3Snvq`*gX3u0GR&}*fFwHo3-vIw0 zeiWskq3ZT9hTg^je{sC^@+z3FAd}KNhbpE5RO+lsLgv$;1igG7pRwI|;BO7o($2>mS(E z$CO@qYf5i=Zh6-xB=U8@mR7Yjk%OUp;_MMBfe_v1A(Hqk6!D})x%JNl838^ZA13Xu zz}LyD@X2;5o1P61Rc$%jcUnJ>`;6r{h5yrEbnbM$$ntA@P2IS1PyW^RyG0$S2tUlh z8?E(McS?7}X3nAAJs2u_n{^05)*D7 zW{Y>o99!I9&KQdzgtG(k@BT|J*;{Pt*b|?A_})e98pXCbMWbhBZ$t&YbNQOwN^=F) z_yIb_az2Pyya2530n@Y@s>s>n?L79;U-O9oPY$==~f1gXro5Y z*3~JaenSl_I}1*&dpYD?i8s<7w%~sEojqq~iFnaYyLgM#so%_ZZ^WTV0`R*H@{m2+ zja4MX^|#>xS9YQo{@F1I)!%RhM{4ZUapHTKgLZLcn$ehRq(emb8 z9<&Nx*RLcS#)SdTxcURrJhxPM2IBP%I zf1bWu&uRf{60-?Gclb5(IFI*!%tU*7d`i!l@>TaHzYQqH4_Y*6!Wy0d-B#Lz7Rg3l zqKsvXUk9@6iKV6#!bDy5n&j9MYpcKm!vG7z*2&4G*Yl}iccl*@WqKZWQSJCgQSj+d ze&}E1mAs^hP}>`{BJ6lv*>0-ft<;P@`u&VFI~P3qRtufE11+|#Y6|RJccqo27Wzr}Tp|DH z`G4^v)_8}R24X3}=6X&@Uqu;hKEQV^-)VKnBzI*|Iskecw~l?+R|WKO*~(1LrpdJ? z0!JKnCe<|m*WR>m+Qm+NKNH<_yefIml z+x32qzkNRrhR^IhT#yCiYU{3oq196nC3ePkB)f%7X1G^Ibog$ZnYu4(HyHUiFB`6x zo$ty-8pknmO|B9|(5TzoHG|%>s#7)CM(i=M7Nl=@GyDi-*ng6ahK(&-_4h(lyUN-oOa$` zo+P;C4d@m^p9J4c~rbi$rq9nhGxayFjhg+Rqa{l#`Y z!(P6K7fK3T;y!VZhGiC#)|pl$QX?a)a9$(4l(usVSH>2&5pIu5ALn*CqBt)9$yAl; z-{fOmgu><7YJ5k>*0Q~>lq72!XFX6P5Z{vW&zLsraKq5H%Z26}$OKDMv=sim;K?vsoVs(JNbgTU8-M%+ zN(+7Xl}`BDl=KDkUHM9fLlV)gN&PqbyX)$86!Wv!y+r*~kAyjFUKPDWL3A)m$@ir9 zjJ;uQV9#3$*`Dqo1Cy5*;^8DQcid^Td=CivAP+D;gl4b7*xa9IQ-R|lY5tIpiM~9- z%Hm9*vDV@_1FfiR|Kqh_5Ml0sm?abD>@peo(cnhiSWs$uy&$RYcd+m`6%X9FN%?w}s~Q=3!pJzbN~iJ}bbM*PPi@!E0eN zhKcuT=kAsz8TQo76CMO+FW#hr6da({mqpGK2K4T|xv9SNIXZ}a=4_K5pbz1HE6T}9 zbApW~m0C`q)S^F}B9Kw5!eT)Bj_h9vlCX8%VRvMOg8PJ*>PU>%yt-hyGOhjg!2pZR4{ z=VR_*?Hw|aai##~+^H>3p$W@6Zi`o4^iO2Iy=FPdEAI58Ebc~*%1#sh8KzUKOVHs( z<3$LMSCFP|!>fmF^oESZR|c|2JI3|gucuLq4R(||_!8L@gHU8hUQZKn2S#z@EVf3? zTroZd&}JK(mJLe>#x8xL)jfx$6`okcHP?8i%dW?F%nZh=VJ)32CmY;^y5C1^?V0;M z<3!e8GZcPej-h&-Osc>6PU2f4x=XhA*<_K*D6U6R)4xbEx~{3*ldB#N+7QEXD^v=I z+i^L+V7_2ld}O2b-(#bmv*PyZI4|U#Q5|22a(-VLOTZc3!9ns1RI-? zA<~h|tPH0y*bO1#EMrsWN>4yJM7vqFZr?uw$H8*PhiHRQg1U9YoscX-G|gck+SSRX!(e7@~eeUEw+POsT;=W9J&=EV`cUc{PIg_#TQVGnZsQbCs7#Q-)v#BicxLw#Fb?#)8TYbu zN)5R=MI1i7FHhF|X}xEl=sW~`-kf;fOR^h1yjthSw?%#F{HqrY2$q>7!nbw~nZ8q9 zh{vY! z%i=H!!P&wh z7_E%pB7l5)*VU>_O-S~d5Z!+;f{pQ4e86*&);?G<9*Q$JEJ!ZxY;Oj5&@^eg0Zs!iLCAR`2K?MSFzjX;kHD6)^`&=EZOIdW>L#O`J zf~$M4}JiV}v6B-e{NUBGFgj-*H%NG zfY0X(@|S8?V)drF;2OQcpDl2LV=~=%gGx?_$fbSsi@%J~taHcMTLLpjNF8FkjnjyM zW;4sSf6RHaa~LijL#EJ0W2m!BmQP(f=%Km_N@hsBFw%q#7{Er?y1V~UEPEih87B`~ zv$jE%>Ug9&=o+sZVZL7^+sp)PSrS;ZIJac4S-M>#V;T--4FXZ*>CI7w%583<{>tb6 zOZ8gZ#B0jplyTbzto2VOs)s9U%trre`m=RlKf{I_Nwdxn(xNG%zaVNurEYiMV3*g| z``3;{j7`UyfFrjlEbIJN{0db|r>|LA@=vX9CHFZYiexnkn$b%8Rvw0TZOQIXa;oTI zv@j;ZP+#~|!J(aBz9S{wL7W%Dr1H)G-XUNt9-lP?ijJ-XEj1e*CI~-Xz@4(Xg;UoG z{uzBf-U+(SHe}6oG%;A*93Zb=oE>uTb^%qsL>|bQf?7_6=KIiPU`I|r;YcZ!YG7y~ zQu@UldAwz$^|uoz3mz1;An-WVBtefSh-pv<`n&TU3oM!hrEI?l@v8A4#^$4t&~T32 zl*J=1q~h+60sNc43>0aVvhzyfjshgPYZoQ(OOh>LbUIoblb@1z~zp?))n?^)q6WGuDh}gMUaA9|X z3qq-XlcNldy5==T4rq*~g@XVY!9sYZjo#R7 zr{n)r5^S{9+$+8l7IVB*3_k5%-TBY@C%`P@&tZf>82sm#nfw7L%92>nN$663yW!yt zhS>EfLcE_Z)gv-Y^h1;xj(<4nD4GY{C-nWUgQc9cMmH{qpa!uEznrGF^?bbJHApScQ$j>$JZHAX80DdXu z--AMgrA0$Otdd#N9#!cg2Z~N8&lj1d+wDh+^ZObWJ$J)_h(&2#msu>q0B$DEERy{1 zCJN{7M@%#E@8pda`@u!v@{gcT3bA*>g*xYLXlbb&o@1vX*x+l}Voys6o~^_7>#GB| z*r!R%kA9k%J`?m>1tMHB9x$ZRe0$r~ui}X}jOC)9LH=Po*2SLdtf3^4?VKnu2ox&mV~0oDgi` z;9d}P$g~9%ThTK8s}5ow2V4?(-lU*ed8ro|}mU}pk% z;bqB0bx3AOk<0Joeh}Vl@_7Po&C`Cg>>gff>e7fu41U3Ic{JQu1W%+!Gvz3GDO2ixKd;KF6UEw8F_cDAh08gB>@ zaRH2Q96sBJ>`4aXvrF0xPtIWoA1pPsRQtU~xDtnEfTJnl{A9u5pR^K8=UdNq%T8F$)FbN> zgK+_(BF#D>R>kK!M#OT~=@@}3yAYqm33?{Bv?2iBr|-aRK0@uapzuXI)wE0=R@m^7 zQ`wLBn(M*wg!mgmQT1d!@3<2z>~rmDW)KG0*B4>_R6LjiI0^9QT8gtDDT|Lclxppm z+OeL6H3QpearJAB%1ellZ6d*)wBQ(hPbE=%?y6i^uf%`RXm*JW*WQ%>&J+=V(=qf{ zri~yItvTZbII+7S0>4Q0U9@>HnMP$X>8TqAfD(vAh};2P{QK)ik`a6$W$nG<{bR2Ufd!^iE z#1K58$gW!xpeYHeehuhQCXZ9p%N8m zB+l~T_u-Ycr!U>!?xu!!*6rNxq37{`DhMMfY6NpD3Jw zkYQDstvt30Hc_SaZuuMP2YrdW@HsPMbf^Y9lI<9$bnMil2X7`Ba-DGLbzgqP>mxwe zf1&JkDH54D3nLar2KjJ3z`*R+rUABq4;>>4Kjc2iQEj7pVLcZYZ~pteAG4rm1{>PQy=!QiV5G|tVk)53 zP?Azw+N)Yq3zZ`dW7Q9Bq@Y*jSK0<1f`HM;_>GH57pf_S%Ounz_yhTY8lplQSM`xx zU{r-Deqs+*I~sLI$Oq`>i`J1kJ(+yNOYy$_>R3Jfi680<|^u#J@aY%Q>O zqfI~sCbk#3--^zMkV&Yj0D(R^rK}+_npgPr_4^kYuG=pO%$C_7v{s@-{M-P@RL3^<`kO@b=YdKMuccfO1ZW# zeRYE%D~CMAgPlo?T!O6?b|pOZv{iMWb;sN=jF%=?$Iz_5zH?K;aFGU^8l7u%zHgiy z%)~y|k;Es-7YX69AMj^epGX#&^c@pp+lc}kKc`5CjPN4Z$$e58$Yn*J?81%`0~A)D zPg-db*pj-t4-G9>ImW4IMi*v#9z^9VD9h@9t;3jMAUVxt=oor+16yHf{lT|G4 zya6{4#BxFw!!~UTRwXXawKU4iz$$GMY6=Z8VM{2@0{=5A0+A#p6$aT3ubRyWMWPq9 zCEH5(Il0v4e4=Yxg(tDglfYAy!UpC>&^4=x7#6_S&Ktds)a8^`^tp6RnRd{KImB^o z2n=t#>iKx<*evmvoE{+fH#@WXGWs$)Uxrtf?r>AaxV0?kf0o@oDboJ6z0cgP@A$;k>SK1UqC?Q_ zk_I?j74;}uNXhOf_5ZxQSgB4otDEb9JJrX1kq`-o%T>g%M5~xXf!2_4P~K64tKgXq z&KHZ0@!cPvUJG4kw-0;tPo$zJrU-Nop>Uo65Pm|yaNvKjhi7V1g98;^N1~V3% zTR>yWa+X2FJ_wpPwz3i^6AGwOa_VMS-&`*KoKgF2&oR10Jn6{!pvVG@n=Jk@vjNuY zL~P7aDGhg~O9G^!bHi$8?G9v9Gp0cmekYkK;(q=47;~gI>h-kx-ceM{ml$#8KI$4ltyjaqP zki^cyDERloAb)dcDBU4na9C(pfD{P@eBGA}0|Rb)p{ISqi60=^FUEdF!ok{Gs;vb) zfj9(#1QA64w*ud^YsN5&PeiI>c`VioE8h)e}W%S9NMA55Gs zrWL6l+@3CKd@8(UQLTwe12SGWMqRn+j)QZRj*g)Xua)%ayzpqs{pD(WWESJYL3{M$ z%qkpM`jFoqLYVv6{IbCkL?fEiJj$VG=$taup&RL9e{s(Sgse2xVJlw0h74EXJKt2eX|dxz{->0)3W`JN7Bv!rLvRZc z0tAOZ2yVe4g9iq826qXAg`f!*+}(o1;1FDb>kKexumFS40KvK0yH1_@Z=LgWZ+}(Y zwYsa;OLz6tTA%gS=>8$=Z7pLh>|K2QElL)E=Q*(n*H`8R`8={-@4mTD-SWBOYRxV? zmF(-rJB8^Wlp?319rTrh^?QEP?|Msxrv?WbJ-+id+V#F2Y4(JPJ6U9bv+U1cIIH^W z)lg$_=g^Ma>2~Pyd_YOAv29Cb-U6DJO?NxnW7~QP*SmYi*vdUVuW#LWQ_u0`hymZi zaQS3Nb^4`ro$>0G%zbXmr5|D|iq0R<;S@?kr0j5Ruq87-Z1>crx%EzVZ9#U;{?}ti zW2W%*9MQg3Nbh%Ti6LhDd|-aFSgXoPG`mHlUU1iCHr>ru>DX?W_#13(`u*!Plu2OP z6jk=2>BC0l)aw;HCmxoYD1i4b%m$1`DYC_^L~ zIEAnFcHvad=-aO3(_MI=9#`z6-9*_!&$?<%meb5;jGd5Qp=MGf z6BD{%`L#TAOq%z%@*ib95Ey7NbUF=BlszVk3Iu3imD&*91N-ij%hW?W@~2TtdHTfP z#n0@Xd7X8Dyu36n{k#PwQ~T~X7mAO^cNV+z<HO@3X-# z_@rAn$k~(l@kciCC;&Qd*fWRI>=;fL{UPlciNDWyj$bX<#r^(r;EE8wwUVQm&7~QY zCXRj!**r^xybAEPq>h3W$uvI1j=yNIyzkE_D7fpGw)OV{U*Uwm{xB;mEg2(|y|ICd zMdQVqzMb-=XM6|E-a9kNh)^9lY`-DjhhHD1w5lufRcy+QLgJ47!fFne86#F; zX{ufroVBEZJOY?rDo!;Te6aOZ^1SO!dYRxQ*2njyA~dCWawn)>!*k7~>8Ikt&e*0>>V5ZbO|*1+2LFOqVe zXHb!aMk03^h%&9L8GMy7UDI2Kev>V@(R}*Iu6x+!Hn4~D@wj`P%#Hdbf(lK{+DD7f zJ&(v*mhn_e(R$^5L#bM^^Q@-!*b!l|+Xrb(q*MRFJYnrE7*xko!SJOy9LngR2|q5k zY`Ioiu+YBfzF{Labszk-E#*BYQk>$()=xWEGZRKwY)*UxP}0dGuPLZOkNJDI9Hy zFjfwiK6RjhH#rHW#B0(MW}i%V`943<6@Z*Nd^JEP5uZonXm=u%AM>{H^U@&Jy*i0s za_Da^xI6pMtXzHc{e~_ZcnKP*;=YL2Z^RmzDl{dJTk7*}E_h*NvgnhnxVKB59Duh~ zqouS_WoOR*{UvUw_K#OWz;gMracr%8>QQ&V*jv!8)ho;U8}9~8EU{N<=Z_gR%IpMT zbkePUG_afm=#|iIfFmdqkpLMGxY5D$`?I}&T7>TexU@v zkBx09kG)O;09ckj#(_Uov6vv{{HOcr-%H#DUQ@*GzF8Zh{iSM13%fuB%>wjdU@3Nf zlnYE!GTyNrqes|;nLFXfWU*Wg-9wmr=NBd$nCk+H?iwNvcd0Wab^3CT9a`>3V~oWI z9=_H+N-Q=MQ(io4u4mpdQ;k&5FXnKV5M7R`@WJ9h(GrAirO#XXOU{qQpk^B^Vd=Dt{wiqT zg-#j9J~@o%H2;W9mg)o6@*Vo;BSs2*4HAHpDk02mndAsov08R_48zJZ@J)s7+hyCo zy*0L#y)?AqZt-wX%+_Vx`8*A95OLHvs1$k~{h-_N_vov_gHJE=`X>L?5K+ zD?u59=mjtImMvd1GsDytuYp{IyUkW&?h zF>$#`n$~bZ)KN0B$XGeMYh&`;g8 zo_2-koaO6+8O!+L>SpIQbG(i;QW9UJi{Ecewlo?s&D!^>i$|#jaW}#HJuxt|W48=? zb^Y&O$a1s5ddr8DIt!sD!t=y1g(d4GR(s;s-HfV$GXl&m;+sAAxB^rk(3_NjE$p#L z*t4em?tA0d+XwRxN^OQwzbDZMuSE0J1)Ky{mq)^t4bnSl*)s>zNM@mMdtd78&ebHN z`!(|lE5q-p+TsRaNnMXwALaN5QIZ2IUi^Z22tsN5>nvIO+YU}Q*xh6}ee6@rR~<&1 z(PB4z>9ZBUMXZwSMmd9-aKKsmJeJq^G|#JclOh*xf0?^e0(`40nsg1z)(48;4}B_( zGwPI)yo|{oX{dVDL-5-aMGr;~vU1cPtJP5JM(sswz&Q`e<@0?y{YhsO9YK8EYJA;L z>7oG_Mts+(wCBC*Md82#XdKw&J*IizR?9k^rf1r{Ot-&>V^ke{9nI9zavlcNkIJtN z7T>?o|4rENk-?|lewZ(EfdR;%BUrzKJ^UkCpsM)EA9QHBVV8trT&*O(9?FO{MLTFL z=5P0H+T6C^jAuX0k4U;~GM!x`!X2N~3_n?qXY$HI>x@(DHEy&Q3ucT1R6fj28wX!I zC=&d$@bJ_v^%?W2Ngl}e8ww`b%BrN-PzGH;$@B2Ky1?%GMkm#~Okj(-Admyy;qya| zOi73kr_pwt?5Nj3p=&H>81!w#>Agj z(QXx{j0r=pTl>micAI_5vUw<3`Sht?Z}-j2Wx~F8DKCUQrsXl2?W8hur42(F_ zsSJ)_36&x6A|YkY6c<2a94SXbv~d>4CC4nkDPvf9Z5Fys^6^5r0j5=E>Cgy_Dk@tS z%?c}9!qB?t6t8(XMH%le8UeNWp@Nsma~Ql+^3Bo%_npMryeQJz4V=BAqE~T?dejng z3ge{fjCHoNAfYBvsfq;G%VL|j7t z`X0sy1EEgpyD;)tS1x+fnv-?C@glP0{RCW}Ma?3qpoq_&IJAYOy3G#s`rsh5=3>`K zkj``=;|*x5HSjZC zXNvPLh372q;=+6ja|SC!R-`JcL}}wwskajjTUGTpL(1zkN-p?BA2lmf+J3WsB7!k`0Brx8^cLTF9h)r+LZ$vsZo}`OpOs)?c6$hclR!R#MAeh|_DY|9r zy+_3c%IO9h9X?ksp?an&>Lw;QeQ`T-Ku6HaK~H?E9-Z5$cZu{YU;1+-6B$|JD;%!^ zt(4l>F8}a-UkC4YtOxFHckhl4VKr6P$P_O*U!)IDory%}Wz`YeFx6TO{y2Y${SBm?H9cTWV=WWJ z`_*CGso!ZN>l@~_jkeXtV}fczfA{TUkyeD>)i3|NFGcCsBmK3HXp&ol_@GVs7PIpfULy!hi zs+%KYgS%(n7_z_}6)hblk~W#LZ@&2)fwm6xkFP%&Ju|MFWbNiTwy{{g-pV1RK`L&=RE2D z4|g;~vd8xd|teYS%w!IlT4W$&FTrk-hcTADX!P?*f1YWEIRwq$Ys%^(Z9w&HT$>} zsMD#6Df=uJrX!JHP7<>Or;e_Cf=}`!`qR=i8fBj)$6Lxx{HRzd8Tnzd0p>kSps{OG zKJkml>bUj8$u|F=``l(-aMxWBC@CGZ#FXClQZ<4|&%jN}Tkg#q8z)=>Ly{$i0`rjU zvt|QddO&i=91e?h3>s~i;+6{ z8X4i6a1wDLrSuE#W(zhan+U*Zq+8p3a))JFVF4ffaV51K^YgTso~3;Y*NmM; zx8T?y-N0uyWY(8=me-HUC9xtABvX5~%yg+Cp&XF$Bq=OcK6T*D7eZ2EmIoCFWm{$S z1PNw8HDpe5hHeCusN8kdeb&f2#=3M^A~7YwJ7FRrhq*)PG9x?JIAaC{MV}5}g#7R$-Ly%)4=IUkRCGOR|XTMjn&okRmFjaO^YF5^* z@)#MCBOBezD)*xQNxydlUyN?dW{fS(s-T`gv*0BEnk}`BdmrbmPO8q8y(X$AA}*RH%I7Av!~84pudHb&%Q5-j zt?=6x(iR?<^_7X0v6Ys#VAL}dKk^hcjI=|EY;kPcZ_w<*H`_*|N7SacaM1ERD@6ab zg`!iTm7$URV+lpW_{V$ruR&A>jrX68k4x2wo$45}&wf7o<|o(@B!u-L@bKyQBAGwy z4#}UrRAu>^>Vb6k2-th^>WjvP;Nl|i3WrjWv3ISkj{m{eAcQIW^_ndxSX@|8T(ASJ z?_$fcP2u*6uOBk-{d>^ z0vWlfGQMvysI%R=iE|A+!!Nw?C917EU*_$`;;)px?s83CRd3i_jBN)k#nR5t$dJ(+ z_sP;wG@Ad)^(3LRj7q}0b2O(b`|i0~5SYb%Sjk^*5ISZ-Ab+}DGu$-X1n^TF1Ndw_ zF|e*1)cI2%`TR&AW~XpqpFb!=3cHbS>np9hYD_Mr5}y5Y`SY^r7isA2Q4(z zazRQEqWDKT2zIEbjSYdCPi1ZOGz80Nsl}gxO^DWMY0AV<2K&OL{&^6#@L1?lXu#6xSMh%3^5c*}oM6DQGY#(a^@z<&D zF(43I9e&5`h|A$5!+UFuOH0>F3$shBV4`0#M4RSB8=6F0ZgIbq<2LQ$Hh^(kAJu=! zt8ZGXTacD{(3W{V1$j_{Jc)Ka7t6u}ho`4kF+4@t_0!mCBn z)}o%eA}L)_L?=jw6BIfll7tb3n}?*yLt&XADa=rW>qz=_6s9ziOd5sXjil>FVFx3r zf>Feewk0v#W9>Gp4GacTRr>Sd2T6dWi-{YX`v!D)kCWzG5xQB=?es5ON(%nkwUhNl zV>@xkWWWv*N+{e$(SrExvN6BXzU(Hxlx27{VYHf+LpIbTO+Yu(ltMk<;)3A(LU@ytVYFkYvTa79idMtUFhfxx?P!)2F`prNWW#Fub#l>N2s@nh&n_ zA4{#}|AIs9|A4P0ZF%fy=hDN!t#ifH<)4u2kirK~JUpjQ-J+~cXOZI&dIts;P}UeXslP6zKvpEKSN-$y>kJ^nw2tC9bv zo(|lT@?vZ!{_l|d^8Yh)eEBh*5ABh+Lzjw+?V)o z#P-W7361>E(Y4;@`sv;VKn G`u_lkUM?>H diff --git a/docs/input/assets/css/fonts/glyphicons-halflings-regular.woff2 b/docs/input/assets/css/fonts/glyphicons-halflings-regular.woff2 deleted file mode 100644 index 64539b54c3751a6d9adb44c8e3a45ba5a73b77f0..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 18028 zcmV(~K+nH-Pew8T0RR9107h&84*&oF0I^&E07eM_0Rl|`00000000000000000000 z0000#Mn+Uk92y`7U;vDA2m}!b3WBL5f#qcZHUcCAhI9*rFaQJ~1&1OBl~F%;WnyLq z8)b|&?3j;$^FW}&KmNW53flIFARDZ7_Wz%hpoWaWlgHTHEHf()GI0&dMi#DFPaEt6 zCO)z0v0~C~q&0zBj^;=tv8q{$8JxX)>_`b}WQGgXi46R*CHJ}6r+;}OrvwA{_SY+o zK)H-vy{l!P`+NG*`*x6^PGgHH4!dsolgU4RKj@I8Xz~F6o?quCX&=VQ$Q{w01;M0? zKe|5r<_7CD z=eO3*x!r$aX2iFh3;}xNfx0v;SwBfGG+@Z;->HhvqfF4r__4$mU>Dl_1w;-9`~5rF~@!3;r~xP-hZvOfOx)A z#>8O3N{L{naf215f>m=bzbp7_(ssu&cx)Qo-{)!)Yz3A@Z0uZaM2yJ8#OGlzm?JO5gbrj~@)NB4@?>KE(K-$w}{};@dKY#K3+Vi64S<@!Z{(I{7l=!p9 z&kjG^P~0f46i13(w!hEDJga;*Eb z`!n|++@H8VaKG<9>VDh(y89J#=;Z$ei=GnD5TesW#|Wf)^D+9NKN4J3H5PF_t=V+Z zdeo8*h9+8&Zfc?>>1|E4B7MAx)^uy$L>szyXre7W|81fjy+RZ1>Gd}@@${~PCOXo) z$#HZd3)V3@lNGG%(3PyIbvyJTOJAWcN@Uh!FqUkx^&BuAvc)G}0~SKI`8ZZXw$*xP zum-ZdtPciTAUn$XWb6vrS=JX~f5?M%9S(=QsdYP?K%Odn0S0-Ad<-tBtS3W06I^FK z8}d2eR_n!(uK~APZ-#tl@SycxkRJ@5wmypdWV{MFtYBUY#g-Vv?5AEBj1 z`$T^tRKca*sn7gt%s@XUD-t>bij-4q-ilku9^;QJ3Mpc`HJ_EX4TGGQ-Og)`c~qm51<|gp7D@ zp#>Grssv^#A)&M8>ulnDM_5t#Al`#jaFpZ<#YJ@>!a$w@kEZ1<@PGs#L~kxOSz7jj zEhb?;W)eS}0IQQuk4~JT30>4rFJ3!b+77}>$_>v#2FFEnN^%(ls*o80pv0Q>#t#%H z@`Yy-FXQ9ULKh{Up&oA_A4B!(x^9&>i`+T|eD!&QOLVd(_avv-bFX~4^>o{%mzzrg_i~SBnr%DeE|i+^}|8?kaV(Z32{`vA^l!sp15>Z72z52FgXf z^8ZITvJ9eXBT1~iQjW|Q`Fac^ak$^N-vI^*geh5|*CdMz;n16gV_zk|Z7q8tFfCvU zJK^Pptnn0Rc~egGIAK}uv99VZm2WLPezQQ5K<`f zg{8Ll|GioPYfNheMj-7-S87=w4N0WxHP`1V6Y)0M&SkYzVrwp>yfsEF7wj&T0!}dB z)R~gGfP9pOR;GY_e0~K^^oJ-3AT+m~?Al!{>>5gNe17?OWz)$)sMH*xuQiB>FT2{i zQ>6U_8}Ay~r4li;jzG+$&?S12{)+<*k9 z<^SX#xY|jvlvTxt(m~C7{y{3g>7TX#o2q$xQO|fc<%8rE@A3=UW(o?gVg?gDV!0q6O!{MlX$6-Bu_m&0ms66 znWS&zr{O_4O&{2uCLQvA?xC5vGZ}KV1v6)#oTewgIMSnBur0PtM0&{R5t#UEy3I9) z`LVP?3f;o}sz*7g5qdTxJl^gk3>;8%SOPH@B)rmFOJ)m6?PlYa$y=RX%;}KId{m9R#2=LNwosF@OTivgMqxpRGe}5=LtAn?VVl6VWCFLD z7l#^^H8jY~42hR)OoVF#YDW(md!g(&pJ;yMj|UBAQa}UH?ED@%ci=*(q~Opn>kE2Q z_4Kgf|0kEA6ary41A;)^Ku(*nirvP!Y>{FZYBLXLP6QL~vRL+uMlZ?jWukMV*(dsn zL~~KA@jU)(UeoOz^4Gkw{fJsYQ%|UA7i79qO5=DOPBcWlv%pK!A+)*F`3WJ}t9FU3 zXhC4xMV7Z%5RjDs0=&vC4WdvD?Zi5tg4@xg8-GLUI>N$N&3aS4bHrp%3_1u9wqL)i z)XQLsI&{Hd&bQE!3m&D0vd!4D`l1$rt_{3NS?~lj#|$GN5RmvP(j3hzJOk=+0B*2v z)Bw133RMUM%wu_+$vbzOy?yk#kvR?xGsg-ipX4wKyXqd zROKp5))>tNy$HByaEHK%$mqd>-{Yoj`oSBK;w>+eZ&TVcj^DyXjo{DDbZ>vS2cCWB z(6&~GZ}kUdN(*2-nI!hvbnVy@z2E#F394OZD&Jb04}`Tgaj?MoY?1`{ejE2iud51% zQ~J0sijw(hqr_Ckbj@pm$FAVASKY(D4BS0GYPkSMqSDONRaFH+O2+jL{hIltJSJT~e)TNDr(}=Xt7|UhcU9eoXl&QZRR<9WomW%&m)FT~j zTgGd3-j}Uk%CRD;$@X)NNV9+RJbifYu>yr{FkO;p>_&njI> zyBHh_72bW;8}oGeY0gpHOxiV597j7mY<#?WMmkf5x~Kfk*re(&tG_mX<3&2cON*2u%V29tsXUv{#-ijs2>EuNH-x3) zPBpi+V6gI=wn}u164_j8xi-y(B?Au2o;UO=r6&)i5S3Mx*)*{_;u}~i4dh$`VgUS- zMG6t*?DXDYX0D2Oj31MI!HF>|aG8rjrOPnxHu4wZl;!=NGjjDoBpXf?ntrwt^dqxm zs(lE@*QB3NH)!`rH)5kks-D89g@UX&@DU9jvrsY)aI=9b4nPy3bfdX_U;#?zsan{G>DKob2LnhCJv8o}duQK)qP{7iaaf2=K`a-VNcfC582d4a z>sBJA*%S|NEazDxXcGPW_uZ&d7xG`~JB!U>U(}acUSn=FqOA~(pn^!aMXRnqiL0;? zebEZYouRv}-0r;Dq&z9>s#Rt1HL`0p4bB)A&sMyn|rE_9nh z?NO*RrjET8D4s(-`nS{MrdYtv*kyCnJKbsftG2D#ia@;42!8xd?a3P(&Y?vCf9na< zQ&Ni*1Qel&Xq{Z?=%f0SRqQt5m|Myg+8T=GDc)@^};=tM>9IDr7hdvE9-M@@<0pqv45xZTeNecbL- zWFQt4t`9>j8~X%lz}%We>Kzh_=`XO}!;4!OWH?=p*DOs#Nt({k^IvtBEL~Qafn)I^ zm*k{y7_bIs9YE}0B6%r`EIUH8US+MGY!KQA1fi-jCx9*}oz2k1nBsXp;4K<_&SN}}w<)!EylI_)v7}3&c)V;Cfuj*eJ2yc8LK=vugqTL><#65r6%#2e| zdYzZ)9Uq7)A$ol&ynM!|RDHc_7?FlWqjW>8TIHc`jExt)f5W|;D%GC#$u!%B*S%Z0 zsj&;bIU2jrt_7%$=!h4Q29n*A^^AI8R|stsW%O@?i+pN0YOU`z;TVuPy!N#~F8Z29 zzZh1`FU(q31wa>kmw{$q=MY>XBprL<1)Py~5TW4mgY%rg$S=4C^0qr+*A^T)Q)Q-U zGgRb9%MdE-&i#X3xW=I`%xDzAG95!RG9)s?v_5+qx`7NdkQ)If5}BoEp~h}XoeK>kweAMxJ8tehagx~;Nr_WP?jXa zJ&j7%Ef3w*XWf?V*nR)|IOMrX;$*$e23m?QN` zk>sC^GE=h6?*Cr~596s_QE@>Nnr?{EU+_^G=LZr#V&0fEXQ3IWtrM{=t^qJ62Sp=e zrrc>bzX^6yFV!^v7;>J9>j;`qHDQ4uc92eVe6nO@c>H=ouLQot``E~KLNqMqJ7(G+?GWO9Ol+q$w z!^kMv!n{vF?RqLnxVk{a_Ar;^sw0@=+~6!4&;SCh^utT=I zo&$CwvhNOjQpenw2`5*a6Gos6cs~*TD`8H9P4=#jOU_`%L!W;$57NjN%4 z39(61ZC#s7^tv`_4j}wMRT9rgDo*XtZwN-L;Qc$6v8kKkhmRrxSDkUAzGPgJ?}~_t zkwoGS4=6lsD`=RL|8L3O9L()N)lmEn-M15fRC{dhZ}7eYV%O-R^gsAp{q4 z!C1}_T8gy^v@SZ5R&Li5JMJy+K8iZw3LOGA0pN1~y@w7RRl#F()ii6Y5mr~Mdy@Kz z@FT4cm^I&#Fu_9IX(HAFP{XLbRALqm&)>m_we>a`hfv?eE|t z?YdDp2yAhj-~vuw^wzVDuj%w?exOcOT(ls(F*ceCe(C5HlN{lcQ;}|mRPqFDqLEzw zR7ldY+M6xe$$qLwekmk{Z&5cME$gpC?-8)f0m$rqaS|mj9ATNJvvyCgs(f2{r;2E!oy$k5{jik#(;S>do<#m0wVcU<}>)VtYmF9O0%(C>GDzPgh6X z9OkQLMR~y7=|MtaU!LDPPY7O)L{X#SC+M|v^X2CZ?$GS>U_|aC(VA(mIvCNk+biD| zSpj>gd(v>_Cbq>~-x^Y3o|?eHmuC?E&z>;Ij`%{$Pm$hI}bl0Kd`9KD~AchY+goL1?igDxf$qxL9< z4sW@sD)nwWr`T>e2B8MQN|p*DVTT8)3(%AZ&D|@Zh6`cJFT4G^y6`(UdPLY-&bJYJ z*L06f2~BX9qX}u)nrpmHPG#La#tiZ23<>`R@u8k;ueM6 znuSTY7>XEc+I-(VvL?Y>)adHo(cZ;1I7QP^q%hu#M{BEd8&mG_!EWR7ZV_&EGO;d(hGGJzX|tqyYEg2-m0zLT}a{COi$9!?9yK zGN7&yP$a|0gL`dPUt=4d^}?zrLN?HfKP0_gdRvb}1D73Hx!tXq>7{DWPV;^X{-)cm zFa^H5oBDL3uLkaFDWgFF@HL6Bt+_^g~*o*t`Hgy3M?nHhWvTp^|AQDc9_H< zg>IaSMzd7c(Sey;1SespO=8YUUArZaCc~}}tZZX80w%)fNpMExki-qB+;8xVX@dr; z#L52S6*aM-_$P9xFuIui;dN#qZ_MYy^C^hrY;YAMg;K`!ZpKKFc z9feHsool)`tFSS}Su|cL0%F;h!lpR+ym|P>kE-O`3QnHbJ%gJ$dQ_HPTT~>6WNX41 zoDEUpX-g&Hh&GP3koF4##?q*MX1K`@=W6(Gxm1=2Tb{hn8{sJyhQBoq}S>bZT zisRz-xDBYoYxt6--g2M1yh{#QWFCISux}4==r|7+fYdS$%DZ zXVQu{yPO<)Hn=TK`E@;l!09aY{!TMbT)H-l!(l{0j=SEj@JwW0a_h-2F0MZNpyucb zPPb+4&j?a!6ZnPTB>$t`(XSf-}`&+#rI#`GB> zl=$3HORwccTnA2%>$Nmz)u7j%_ywoGri1UXVNRxSf(<@vDLKKxFo;5pTI$R~a|-sQ zd5Rfwj+$k1t0{J`qOL^q>vZUHc7a^`cKKVa{66z?wMuQAfdZBaVVv@-wamPmes$d! z>gv^xx<0jXOz;7HIQS z4RBIFD?7{o^IQ=sNQ-k!ao*+V*|-^I2=UF?{d>bE9avsWbAs{sRE-y`7r zxVAKA9amvo4T}ZAHSF-{y1GqUHlDp4DO9I3mz5h8n|}P-9nKD|$r9AS3gbF1AX=2B zyaK3TbKYqv%~JHKQH8v+%zQ8UVEGDZY|mb>Oe3JD_Z{+Pq%HB+J1s*y6JOlk`6~H) zKt)YMZ*RkbU!GPHzJltmW-=6zqO=5;S)jz{ zFSx?ryqSMxgx|Nhv3z#kFBTuTBHsViaOHs5e&vXZ@l@mVI37<+^KvTE51!pB4Tggq zz!NlRY2ZLno0&6bA|KHPYOMY;;LZG&_lzuLy{@i$&B(}_*~Zk2 z>bkQ7u&Ww%CFh{aqkT{HCbPbRX&EvPRp=}WKmyHc>S_-qbwAr0<20vEoJ(!?-ucjE zKQ+nSlRL^VnOX0h+WcjGb6WI(8;7bsMaHXDb6ynPoOXMlf9nLKre;w*#E_whR#5!! z!^%_+X3eJVKc$fMZP;+xP$~e(CIP1R&{2m+iTQhDoC8Yl@kLM=Wily_cu>7C1wjVU z-^~I0P06ZSNVaN~A`#cSBH2L&tk6R%dU1(u1XdAx;g+5S^Hn9-L$v@p7CCF&PqV{Z?R$}4EJi36+u2JP7l(@fYfP!=e#76LGy^f>~vs0%s*x@X8`|5 zGd6JOHsQ=feES4Vo8%1P_7F5qjiIm#oRT0kO1(?Z_Dk6oX&j=Xd8Klk(;gk3S(ZFnc^8Gc=d;8O-R9tlGyp=2I@1teAZpGWUi;}`n zbJOS_Z2L16nVtDnPpMn{+wR9&yU9~C<-ncppPee`>@1k7hTl5Fn_3_KzQ)u{iJPp3 z)df?Xo%9ta%(dp@DhKuQj4D8=_!*ra#Ib&OXKrsYvAG%H7Kq|43WbayvsbeeimSa= z8~{7ya9ZUAIgLLPeuNmSB&#-`Je0Lja)M$}I41KHb7dQq$wgwX+EElNxBgyyLbA2* z=c1VJR%EPJEw(7!UE?4w@94{pI3E%(acEYd8*Wmr^R7|IM2RZ-RVXSkXy-8$!(iB* zQA`qh2Ze!EY6}Zs7vRz&nr|L60NlIgnO3L*Yz2k2Ivfen?drnVzzu3)1V&-t5S~S? zw#=Sdh>K@2vA25su*@>npw&7A%|Uh9T1jR$mV*H@)pU0&2#Se`7iJlOr$mp79`DKM z5vr*XLrg7w6lc4&S{So1KGKBqcuJ!E|HVFB?vTOjQHi)g+FwJqX@Y3q(qa#6T@3{q zhc@2T-W}XD9x4u+LCdce$*}x!Sc#+rH-sCz6j}0EE`Tk*irUq)y^za`}^1gFnF)C!yf_l_}I<6qfbT$Gc&Eyr?!QwJR~RE4!gKVmqjbI+I^*^ z&hz^7r-dgm@Mbfc#{JTH&^6sJCZt-NTpChB^fzQ}?etydyf~+)!d%V$0faN(f`rJb zm_YaJZ@>Fg>Ay2&bzTx3w^u-lsulc{mX4-nH*A(32O&b^EWmSuk{#HJk}_ULC}SB(L7`YAs>opp9o5UcnB^kVB*rmW6{s0&~_>J!_#+cEWib@v-Ms`?!&=3fDot`oH9v&$f<52>{n2l* z1FRzJ#yQbTHO}}wt0!y8Eh-0*|Um3vjX-nWH>`JN5tWB_gnW%; zUJ0V?_a#+!=>ahhrbGvmvObe8=v1uI8#gNHJ#>RwxL>E^pT05Br8+$@a9aDC1~$@* zicSQCbQcr=DCHM*?G7Hsovk|{$3oIwvymi#YoXeVfWj{Gd#XmnDgzQPRUKNAAI44y z{1WG&rhIR4ipmvBmq$BZ*5tmPIZmhhWgq|TcuR{6lA)+vhj(cH`0;+B^72{&a7ff* zkrIo|pd-Yxm+VVptC@QNCDk0=Re%Sz%ta7y{5Dn9(EapBS0r zLbDKeZepar5%cAcb<^;m>1{QhMzRmRem=+0I3ERot-)gb`i|sII^A#^Gz+x>TW5A& z3PQcpM$lDy`zb%1yf!e8&_>D02RN950KzW>GN6n@2so&Wu09x@PB=&IkIf|zZ1W}P zAKf*&Mo5@@G=w&290aG1@3=IMCB^|G4L7*xn;r3v&HBrD4D)Zg+)f~Ls$7*P-^i#B z4X7ac=0&58j^@2EBZCs}YPe3rqgLAA1L3Y}o?}$%u~)7Rk=LLFbAdSy@-Uw6lv?0K z&P@@M`o2Rll3GoYjotf@WNNjHbe|R?IKVn*?Rzf9v9QoFMq)ODF~>L}26@z`KA82t z43e!^z&WGqAk$Ww8j6bc3$I|;5^BHwt`?e)zf|&+l#!8uJV_Cwy-n1yS0^Q{W*a8B zTzTYL>tt&I&9vzGQUrO?YIm6C1r>eyh|qw~-&;7s7u1achP$K3VnXd8sV8J7ZTxTh z5+^*J5%_#X)XL2@>h(Gmv$@)fZ@ikR$v(2Rax89xscFEi!3_;ORI0dBxw)S{r50qf zg&_a*>2Xe{s@)7OX9O!C?^6fD8tc3bQTq9}fxhbx2@QeaO9Ej+2m!u~+u%Q6?Tgz{ zjYS}bleKcVhW~1$?t*AO^p!=Xkkgwx6OTik*R3~yg^L`wUU9Dq#$Z*iW%?s6pO_f8 zJ8w#u#Eaw7=8n{zJ}C>w{enA6XYHfUf7h)!Qaev)?V=yW{b@-z`hAz;I7^|DoFChP z1aYQnkGauh*ps6x*_S77@z1wwGmF8ky9fMbM$dr*`vsot4uvqWn)0vTRwJqH#&D%g zL3(0dP>%Oj&vm5Re%>*4x|h1J2X*mK5BH1?Nx_#7( zepgF`+n)rHXj!RiipusEq!X81;QQBXlTvLDj=Qub(ha&D=BDx3@-V*d!D9PeXUY?l zwZ0<4=iY!sUj4G>zTS+eYX7knN-8Oynl=NdwHS*nSz_5}*5LQ@=?Yr?uj$`C1m2OR zK`f5SD2|;=BhU#AmaTKe9QaSHQ_DUj1*cUPa*JICFt1<&S3P3zsrs^yUE;tx=x^cmW!Jq!+hohv_B> zPDMT0D&08dC4x@cTD$o1$x%So1Ir(G3_AVQMvQ13un~sP(cEWi$2%5q93E7t{3VJf%K? zuwSyDke~7KuB2?*#DV8YzJw z&}SCDexnUPD!%4|y~7}VzvJ4ch)WT4%sw@ItwoNt(C*RP)h?&~^g##vnhR0!HvIYx z0td2yz9=>t3JNySl*TszmfH6`Ir;ft@RdWs3}!J88UE|gj_GMQ6$ZYphUL2~4OY7} zB*33_bjkRf_@l;Y!7MIdb~bVe;-m78Pz|pdy=O*3kjak63UnLt!{^!!Ljg0rJD3a~ z1Q;y5Z^MF<=Hr}rdoz>yRczx+p3RxxgJE2GX&Si)14B@2t21j4hnnP#U?T3g#+{W+Zb z5s^@>->~-}4|_*!5pIzMCEp|3+i1XKcfUxW`8|ezAh>y{WiRcjSG*asw6;Ef(k#>V ztguN?EGkV_mGFdq!n#W)<7E}1#EZN8O$O|}qdoE|7K?F4zo1jL-v}E8v?9qz(d$&2 zMwyK&xlC9rXo_2xw7Qe0caC?o?Pc*-QAOE!+UvRuKjG+;dk|jQhDDBe?`XT7Y5lte zqSu0t5`;>Wv%|nhj|ZiE^IqA_lZu7OWh!2Y(627zb=r7Ends}wVk7Q5o09a@ojhH7 zU0m&h*8+j4e|OqWyJ&B`V`y=>MVO;K9=hk^6EsmVAGkLT{oUtR{JqSRY{Qi{kKw1k z6s;0SMPJOLp!som|A`*q3t0wIj-=bG8a#MC)MHcMSQU98Juv$?$CvYX)(n`P^!`5| zv3q@@|G@6wMqh;d;m4qvdibx2Yjml}vG9mDv&!0ne02M#D`Bo}xIB0VWh8>>WtNZQ z$&ISlJX;*ORQIO;k62qA{^6P%3!Z=Y1EbmY02{w^yB$`;%!{kur&XTGDiO2cjA)lr zsY^XZWy^DSAaz;kZ_VG?uWnJR7qdN18$~)>(kOoybY0~QYu9||K#|$Mby{3GduV~N zk9H7$7=RSo+?CUYF502`b76ytBy}sFak&|HIwRvB=0D|S`c#QCJPq zP)uOWI)#(n&{6|C4A^G~%B~BY21aOMoz9RuuM`Ip%oBz+NoAlb7?#`E^}7xXo!4S? zFg8I~G%!@nXi8&aJSGFcZAxQf;0m}942=i#p-&teLvE{AKm7Sl2f}Io?!IqbC|J;h z`=5LFOnU5?^w~SV@YwNZx$k_(kLNxZDE z3cf08^-rIT_>A$}B%IJBPcN^)4;90BQtiEi!gT#+EqyAUZ|}*b_}R>SGloq&6?opL zuT_+lwQMgg6!Cso$BwUA;k-1NcrzyE>(_X$B0HocjY~=Pk~Q08+N}(|%HjO_i+*=o z%G6C6A30Ch<0UlG;Zdj@ed!rfUY_i9mYwK8(aYuzcUzlTJ1yPz|Bb-9b33A9zRhGl>Ny-Q#JAq-+qtI@B@&w z$;PJbyiW=!py@g2hAi0)U1v=;avka`gd@8LC4=BEbNqL&K^UAQ5%r95#x%^qRB%KLaqMnG|6xKAm}sx!Qwo}J=2C;NROi$mfADui4)y(3wVA3k~{j^_5%H)C6K zlYAm1eY**HZOj($)xfKIQFtIVw$4&yvz9>(Crs>Gh{ zya6-FG7Dgi92#K)64=9Csj5?Zqe~_9TwSI!2quAwa1w-*uC5!}xY`?tltb0Hq740< zsq2QelPveZ4chr$=~U3!+c&>xyfvA1`)owOqj=i4wjY=A1577Gwg&Ko7;?il9r|_* z8P&IDV_g2D{in5OLFxsO!kx3AhO$5aKeoM|!q|VokqMlYM@HtsRuMtBY%I35#5$+G zpp|JOeoj^U=95HLemB04Yqv{a8X<^K9G2`&ShM_6&Bi1n?o?@MXsDj9Z*A3>#XK%J zRc*&SlFl>l)9DyRQ{*%Z+^e1XpH?0@vhpXrnPPU*d%vOhKkimm-u3c%Q^v3RKp9kx@A2dS?QfS=iigGr7m><)YkV=%LA5h@Uj@9=~ABPMJ z1UE;F&;Ttg5Kc^Qy!1SuvbNEqdgu3*l`=>s5_}dUv$B%BJbMiWrrMm7OXOdi=GOmh zZBvXXK7VqO&zojI2Om9};zCB5i|<210I{iwiGznGCx=FT89=Ef)5!lB1cZ6lbzgDn07*he}G&w7m!;|E(L-?+cz@0<9ZI~LqYQE7>HnPA436}oeN2Y(VfG6 zxNZuMK3Crm^Z_AFeHc~CVRrSl0W^?+Gbteu1g8NGYa3(8f*P{(ZT>%!jtSl6WbYVv zmE(37t0C8vJ6O-5+o*lL9XRcFbd~GSBGbGh3~R!67g&l)7n!kJlWd)~TUyXus#!&G6sR%(l(h1$xyrR5j_jM1zj#giA&@(Xl26@n<9>folx!92bQ z24h570+<)4!$!IQ(5yOU|4_E6aN@4v0+{Kx~Z z;q7fp%0cHziuI%!kB~w}g9@V+1wDz0wFlzX2UOvOy|&;e;t!lAR8tV2KQHgtfk8Uf zw;rs!(4JPODERk4ckd5I2Vq|0rd@@Mwd8MID%0^fITjYIQom^q;qhP8@|eJx{?5xX zc1@Fj*kDknlk{c-rnCloQ3hGh7OU+@efO3>fkRMcM>J?AeVP& zlfzX%cdp=N+4S#E*%^=BQ+N`A7C}|k%$|QUn0yI6S3$MS-NjO!4hm55uyju)Q6e!} z*OVO@A#-mfC9Pha6ng((Xl^V7{d+&u+yx)_B1{~t7d5e8L^i4J>;x<7@5;+l7-Gge zf#9diXJ$&v^rbN5V(ee%q0xBMEgS6%qZm7hNUP%G;^J44I!BmI@M*+FWz0!+s;+iQ zU4CuI+27bvNK8v>?7PZnVxB=heJ&_ymE0nN^W#-rqB%+JXkYGDuRw>JM_LdtLkiq* z6%%3&^BX$jnM@2bjiGc-DymKly)wVkA-pq;jSWL#7_*moZZ4I|-N}o8SK?sIv)p|c zu~9-B%tMc=!)YMFp*SiC0>kfnH8+X5>;+FFVN{~a9YVdIg1uGkZ~kegFy{^PU(4{( z`CbY`XmVA3esai686Yw8djCEyF7`bfB^F1)nwv+AqYLZ&Zy=eFhYT2uMd@{sP_qS4 zbJ&>PxajjZt?&c<1^!T|pLHfX=E^FJ>-l_XCZzvRV%x}@u(FtF(mS+Umw$e+IA74e>gCdTqi;6&=euAIpxd=Y3I5xWR zBhGoT+T`V1@91OlQ}2YO*~P4ukd*TBBdt?Plt)_ou6Y@Db`ss+Q~A-48s>?eaJYA2 zRGOa8^~Em}EFTmKIVVbMb|ob)hJJ7ITg>yHAn2i|{2ZJU!cwt9YNDT0=*WO7Bq#Xj zg@FjEaKoolrF8%c;49|`IT&25?O$dq8kp3#la9&6aH z6G|{>^C(>yP7#Dr$aeFyS0Ai_$ILhL43#*mgEl(c*4?Ae;tRL&S7Vc}Szl>B`mBuI zB9Y%xp%CZwlH!3V(`6W4-ZuETssvI&B~_O;CbULfl)X1V%(H7VSPf`_Ka9ak@8A=z z1l|B1QKT}NLI`WVTRd;2En5u{0CRqy9PTi$ja^inu){LJ&E&6W%JJPw#&PaTxpt?k zpC~gjN*22Q8tpGHR|tg~ye#9a8N<%odhZJnk7Oh=(PKfhYfzLAxdE36r<6a?A;rO&ELp_Y?8Pdw(PT^Fxn!eG_|LEbSYoBrsBA|6Fgr zt5LntyusI{Q2fdy=>ditS;}^B;I2MD4=(>7fWt0Jp~y=?VvfvzHvQhj6dyIef46J$ zl4Xu7U9v_NJV?uBBC0!kcTS0UcrV7+@~is?Fi+jrr@l3XwD|uG zr26jUWiv>Ju48Y^#qn7r9mwIH-Pv6Y|V|V-GZ&+&gQ?S?-`&ts{@5GXPqbmyZjUACC&oVXfNwUX0}ba(v978 zp8z!v9~8Zx8qB@7>oFPDm^iR@+yw`79YF)w^OHB_N;&&x7c3l^3!)IY#)}x)@D(iNaOm9 zC=^*!{`7={3*S=%iU=KsPXh=DDZcc``Ss>057i{pdW8M@4q+Ba@Tt%OytH!4>rbIbQw^-pR zGGYNPzw@n=PV@)b7yVbFr;glF*Qq3>F9oBN5PUXt!?2mdGcpv^o1?Thp`jP10G2Yi z(c93td3F3SW!Le5DUwdub!aDKoVLU6g!O?Ret21l$qOC;kdd@L#M&baVu&JZGt&<6 z!VCkvgRaav6QDW2x}tUy4~Y5(B+#Ej-8vM?DM-1?J_*&PntI3E96M!`WL#<&Z5n2u zo`P!~vBT$YOT~gU9#PB)%JZ zcd_u=m^LYzC!pH#W`yA1!(fA;D~b zG#73@l)NNd;n#XrKXZEfab;@kQRnOFU2Th-1m<4mJzlj9b3pv-GF$elX7ib9!uILM_$ke zHIGB*&=5=;ynQA{y7H93%i^d)T}y@(p>8vVhJ4L)M{0Q*@D^+SPp`EW+G6E%+`Z;u zS3goV@Dic7vc5`?!pCN44Ts@*{)zwy)9?B||AM{zKlN4T}qQRL2 zgv+{K8bv7w)#xge16;kI1fU87!W4pX)N&|cq8&i^1r`W|Hg4366r(?-ecEJ9u&Eaw zrhyikXQB>C9d>cpPGiu=VU3Z-u4|0V_iap!_J3o+K_R5EXk@sfu~zHwwYkpncVh!R zqNe7Cmf_|Wmeq4#(mIO&(wCK@b4(x0?W1Qtk(`$?+$uCJCGZm_%k?l32vuShgDFMa ztc`{$8DhB9)&?~(m&EUc=LzI1=qo#zjy#2{hLT_*aj<618qQ7mD#k2ZFGou&69;=2 z1j7=Su8k}{L*h&mfs7jg^PN&9C1Z@U!p6gXk&-7xM~{X`nqH#aGO`;Xy_zbz^rYacIq0AH%4!Oh93TzJ820%ur)8OyeS@K?sF1V(iFO z37Nnqj1z#1{|v7=_CX`lQA|$<1gtuNMHGNJYp1D_k;WQk-b+T6VmUK(x=bWviOZ~T z|4e%SpuaWLWD?qN2%`S*`P;BQBw(B__wTD6epvGdJ+>DBq2oVlf&F*lz+#avb4)3P1c^Mf#olQheVvZ|Z5 z>xXfgmv!5Z^SYn+_x}K5B%G^sRwiez&z9|f!E!#oJlT2kCOV0000$L_|bHBqAarB4TD{W@grX1CUr72@caw0faEd7-K|4L_|cawbojjHdpd6 zI6~Iv5J?-Q4*&oF000000FV;^004t70Z6Qk1Xl{X9oJ{sRC2(cs?- diff --git a/docs/input/assets/css/override.less b/docs/input/assets/css/override.less deleted file mode 100644 index 52e639459..000000000 --- a/docs/input/assets/css/override.less +++ /dev/null @@ -1,174 +0,0 @@ - -/* Front page */ -.logo-small { - color: #4EABDD; - font-size: 50px; -} - -/* Control the margin for bootstrap alert boxes */ -.alert > p { - margin-top: 0px; -} - -/* Search box */ -#navbar-collapse, #navbar-collapse nav { - width: 100%; -} - -.navbar-nav { - float: none; -} - -.navbar-right { - margin-right: 15px; -} - -@media (max-width: 767px) { - .navbar-right { - margin-left: 0px; - } -} - -/* News share icons */ - -ul.share-buttons { - list-style: none; - padding: 0; -} - -ul.share-buttons li { - display: inline; -} - -ul.share-buttons .sr-only { - position: absolute; - clip: rect(1px 1px 1px 1px); - clip: rect(1px, 1px, 1px, 1px); - padding: 0; - border: 0; - height: 1px; - width: 1px; - overflow: hidden; -} - -ul.share-buttons img { - width: 32px; -} - -/* Control the look and feel of the copy box applied to code sections */ -.btn-copy[disabled] .clippy { - opacity: .3; -} -pre .btn-copy { - -webkit-transition: opacity 0.3s ease-in-out; - -o-transition: opacity 0.3s ease-in-out; - transition: opacity 0.3s ease-in-out; - opacity: 0; - padding: 2px 6px; - float: right; -} -pre:hover .btn-copy { - opacity: 1; -} -.tooltipped { - position: relative -} -.tooltipped:after { - position: absolute; - z-index: 1000000; - display: none; - padding: 5px 8px; - font: normal normal 11px/1.5 Helvetica, arial, nimbussansl, liberationsans, freesans, clean, sans-serif, "Segoe UI Emoji", "Segoe UI Symbol"; - color: #fff; - text-align: center; - text-decoration: none; - text-shadow: none; - text-transform: none; - letter-spacing: normal; - word-wrap: break-word; - white-space: pre; - pointer-events: none; - content: attr(aria-label); - background: rgba(0, 0, 0, 0.8); - border-radius: 3px; - -webkit-font-smoothing: subpixel-antialiased -} -.tooltipped:before { - position: absolute; - z-index: 1000001; - display: none; - width: 0; - height: 0; - color: rgba(0, 0, 0, 0.8); - pointer-events: none; - content: ""; - border: 5px solid transparent -} -.tooltipped:hover:before, .tooltipped:hover:after, .tooltipped:active:before, .tooltipped:active:after, .tooltipped:focus:before, .tooltipped:focus:after { - display: inline-block; - text-decoration: none -} -.tooltipped-s:after, .tooltipped-se:after, .tooltipped-sw:after { - top: 100%; - right: 50%; - margin-top: 5px -} -.tooltipped-s:before, .tooltipped-se:before, .tooltipped-sw:before { - top: auto; - right: 50%; - bottom: -5px; - margin-right: -5px; - border-bottom-color: rgba(0, 0, 0, 0.8) -} - -@font-family-sans-serif: "Roboto", Helvetica, Arial, sans-serif; - -/* For Gitter and GitHub */ -.bottom-footer { - margin-bottom: 40px !important; // Make room for Gitter and GitHub buttons -} - -.gitter-open-chat-button { - background-color: #3c8dbc; - font-family: @font-family-sans-serif; - letter-spacing: normal; - right: 90px; -} - -.gitter-open-chat-button:focus, .gitter-open-chat-button:hover, -.github-button:focus, .github-button:hover, -{ - background-color: #4EABDD; - color: #fff; -} - -.gitter-chat-embed { - top: 49px; - border-top: 1px solid #000; - z-index: 10000; -} - -.github-button { - z-index: 100; - position: fixed; - bottom: 0px; - right: 240px; - padding: 1em 3em; - background-color: #367fa9; - border: 0; - border-top-left-radius: 0.5em; - border-top-right-radius: 0.5em; - font-family: sans-serif; - font-size: 9pt; - text-transform: uppercase; - text-align: center; - text-decoration: none; - cursor: pointer; - cursor: hand; - -webkit-transition: all .3s ease; - transition: all .3s ease; - color: #fff; - a, a:active, a:hover, a:focus { - color: #fff; - } -} \ No newline at end of file diff --git a/docs/input/assets/images/clippy.svg b/docs/input/assets/images/clippy.svg deleted file mode 100644 index a06cc7ab3..000000000 --- a/docs/input/assets/images/clippy.svg +++ /dev/null @@ -1,3 +0,0 @@ - - - \ No newline at end of file diff --git a/docs/input/assets/images/envelope.svg b/docs/input/assets/images/envelope.svg deleted file mode 100644 index a2557ef20..000000000 --- a/docs/input/assets/images/envelope.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/input/assets/images/facebook.svg b/docs/input/assets/images/facebook.svg deleted file mode 100644 index 6e23a941a..000000000 --- a/docs/input/assets/images/facebook.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/input/assets/images/linkedin.svg b/docs/input/assets/images/linkedin.svg deleted file mode 100644 index 69d8e9731..000000000 --- a/docs/input/assets/images/linkedin.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/input/assets/images/reddit.svg b/docs/input/assets/images/reddit.svg deleted file mode 100644 index 262d0a7f8..000000000 --- a/docs/input/assets/images/reddit.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/input/assets/images/twitter.svg b/docs/input/assets/images/twitter.svg deleted file mode 100644 index f0ed9c5fc..000000000 --- a/docs/input/assets/images/twitter.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/input/assets/js/anchor.min.js b/docs/input/assets/js/anchor.min.js deleted file mode 100644 index 44431c2ca..000000000 --- a/docs/input/assets/js/anchor.min.js +++ /dev/null @@ -1,6 +0,0 @@ -/** - * AnchorJS - v3.2.2 - 2016-10-05 - * https://github.com/bryanbraun/anchorjs - * Copyright (c) 2016 Bryan Braun; Licensed MIT - */ -!function(A,e){"use strict";"function"==typeof define&&define.amd?define([],e):"object"==typeof module&&module.exports?module.exports=e():(A.AnchorJS=e(),A.anchors=new A.AnchorJS)}(this,function(){"use strict";function A(A){function e(A){A.icon=A.hasOwnProperty("icon")?A.icon:"",A.visible=A.hasOwnProperty("visible")?A.visible:"hover",A.placement=A.hasOwnProperty("placement")?A.placement:"right",A.class=A.hasOwnProperty("class")?A.class:"",A.truncate=A.hasOwnProperty("truncate")?Math.floor(A.truncate):64}function t(A){var e;if("string"==typeof A||A instanceof String)e=[].slice.call(document.querySelectorAll(A));else{if(!(Array.isArray(A)||A instanceof NodeList))throw new Error("The selector provided to AnchorJS was invalid.");e=[].slice.call(A)}return e}function n(){if(null===document.head.querySelector("style.anchorjs")){var A,e=document.createElement("style"),t=" .anchorjs-link { opacity: 0; text-decoration: none; -webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; }",n=" *:hover > .anchorjs-link, .anchorjs-link:focus { opacity: 1; }",i=' @font-face { font-family: "anchorjs-icons"; src: url(data:n/a;base64,AAEAAAALAIAAAwAwT1MvMg8yG2cAAAE4AAAAYGNtYXDp3gC3AAABpAAAAExnYXNwAAAAEAAAA9wAAAAIZ2x5ZlQCcfwAAAH4AAABCGhlYWQHFvHyAAAAvAAAADZoaGVhBnACFwAAAPQAAAAkaG10eASAADEAAAGYAAAADGxvY2EACACEAAAB8AAAAAhtYXhwAAYAVwAAARgAAAAgbmFtZQGOH9cAAAMAAAAAunBvc3QAAwAAAAADvAAAACAAAQAAAAEAAHzE2p9fDzz1AAkEAAAAAADRecUWAAAAANQA6R8AAAAAAoACwAAAAAgAAgAAAAAAAAABAAADwP/AAAACgAAA/9MCrQABAAAAAAAAAAAAAAAAAAAAAwABAAAAAwBVAAIAAAAAAAIAAAAAAAAAAAAAAAAAAAAAAAMCQAGQAAUAAAKZAswAAACPApkCzAAAAesAMwEJAAAAAAAAAAAAAAAAAAAAARAAAAAAAAAAAAAAAAAAAAAAQAAg//0DwP/AAEADwABAAAAAAQAAAAAAAAAAAAAAIAAAAAAAAAIAAAACgAAxAAAAAwAAAAMAAAAcAAEAAwAAABwAAwABAAAAHAAEADAAAAAIAAgAAgAAACDpy//9//8AAAAg6cv//f///+EWNwADAAEAAAAAAAAAAAAAAAAACACEAAEAAAAAAAAAAAAAAAAxAAACAAQARAKAAsAAKwBUAAABIiYnJjQ3NzY2MzIWFxYUBwcGIicmNDc3NjQnJiYjIgYHBwYUFxYUBwYGIwciJicmNDc3NjIXFhQHBwYUFxYWMzI2Nzc2NCcmNDc2MhcWFAcHBgYjARQGDAUtLXoWOR8fORYtLTgKGwoKCjgaGg0gEhIgDXoaGgkJBQwHdR85Fi0tOAobCgoKOBoaDSASEiANehoaCQkKGwotLXoWOR8BMwUFLYEuehYXFxYugC44CQkKGwo4GkoaDQ0NDXoaShoKGwoFBe8XFi6ALjgJCQobCjgaShoNDQ0NehpKGgobCgoKLYEuehYXAAAADACWAAEAAAAAAAEACAAAAAEAAAAAAAIAAwAIAAEAAAAAAAMACAAAAAEAAAAAAAQACAAAAAEAAAAAAAUAAQALAAEAAAAAAAYACAAAAAMAAQQJAAEAEAAMAAMAAQQJAAIABgAcAAMAAQQJAAMAEAAMAAMAAQQJAAQAEAAMAAMAAQQJAAUAAgAiAAMAAQQJAAYAEAAMYW5jaG9yanM0MDBAAGEAbgBjAGgAbwByAGoAcwA0ADAAMABAAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAH//wAP) format("truetype"); }',o=" [data-anchorjs-icon]::after { content: attr(data-anchorjs-icon); }";e.className="anchorjs",e.appendChild(document.createTextNode("")),A=document.head.querySelector('[rel="stylesheet"], style'),void 0===A?document.head.appendChild(e):document.head.insertBefore(e,A),e.sheet.insertRule(t,e.sheet.cssRules.length),e.sheet.insertRule(n,e.sheet.cssRules.length),e.sheet.insertRule(o,e.sheet.cssRules.length),e.sheet.insertRule(i,e.sheet.cssRules.length)}}this.options=A||{},this.elements=[],e(this.options),this.isTouchDevice=function(){return!!("ontouchstart"in window||window.DocumentTouch&&document instanceof DocumentTouch)},this.add=function(A){var i,o,s,c,r,a,h,l,u,d,f,p,w=[];if(e(this.options),p=this.options.visible,"touch"===p&&(p=this.isTouchDevice()?"always":"hover"),A||(A="h1, h2, h3, h4, h5, h6"),i=t(A),0===i.length)return!1;for(n(),o=document.querySelectorAll("[id]"),s=[].map.call(o,function(A){return A.id}),r=0;r-1,t=A.lastChild&&(" "+A.lastChild.className+" ").indexOf(" anchorjs-link ")>-1;return e||t||!1}}return A}); \ No newline at end of file diff --git a/docs/input/assets/js/clipboard.min.js b/docs/input/assets/js/clipboard.min.js deleted file mode 100644 index 1d7c5d5d7..000000000 --- a/docs/input/assets/js/clipboard.min.js +++ /dev/null @@ -1,7 +0,0 @@ -/*! - * clipboard.js v1.5.16 - * https://zenorocha.github.io/clipboard.js - * - * Licensed MIT © Zeno Rocha - */ -!function(e){if("object"==typeof exports&&"undefined"!=typeof module)module.exports=e();else if("function"==typeof define&&define.amd)define([],e);else{var t;t="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:this,t.Clipboard=e()}}(function(){var e,t,n;return function e(t,n,i){function o(a,c){if(!n[a]){if(!t[a]){var l="function"==typeof require&&require;if(!c&&l)return l(a,!0);if(r)return r(a,!0);var s=new Error("Cannot find module '"+a+"'");throw s.code="MODULE_NOT_FOUND",s}var u=n[a]={exports:{}};t[a][0].call(u.exports,function(e){var n=t[a][1][e];return o(n?n:e)},u,u.exports,e,t,n,i)}return n[a].exports}for(var r="function"==typeof require&&require,a=0;a0&&void 0!==arguments[0]?arguments[0]:{};this.action=t.action,this.emitter=t.emitter,this.target=t.target,this.text=t.text,this.trigger=t.trigger,this.selectedText=""}},{key:"initSelection",value:function e(){this.text?this.selectFake():this.target&&this.selectTarget()}},{key:"selectFake",value:function e(){var t=this,n="rtl"==document.documentElement.getAttribute("dir");this.removeFake(),this.fakeHandlerCallback=function(){return t.removeFake()},this.fakeHandler=document.body.addEventListener("click",this.fakeHandlerCallback)||!0,this.fakeElem=document.createElement("textarea"),this.fakeElem.style.fontSize="12pt",this.fakeElem.style.border="0",this.fakeElem.style.padding="0",this.fakeElem.style.margin="0",this.fakeElem.style.position="absolute",this.fakeElem.style[n?"right":"left"]="-9999px";var i=window.pageYOffset||document.documentElement.scrollTop;this.fakeElem.addEventListener("focus",window.scrollTo(0,i)),this.fakeElem.style.top=i+"px",this.fakeElem.setAttribute("readonly",""),this.fakeElem.value=this.text,document.body.appendChild(this.fakeElem),this.selectedText=(0,o.default)(this.fakeElem),this.copyText()}},{key:"removeFake",value:function e(){this.fakeHandler&&(document.body.removeEventListener("click",this.fakeHandlerCallback),this.fakeHandler=null,this.fakeHandlerCallback=null),this.fakeElem&&(document.body.removeChild(this.fakeElem),this.fakeElem=null)}},{key:"selectTarget",value:function e(){this.selectedText=(0,o.default)(this.target),this.copyText()}},{key:"copyText",value:function e(){var t=void 0;try{t=document.execCommand(this.action)}catch(e){t=!1}this.handleResult(t)}},{key:"handleResult",value:function e(t){this.emitter.emit(t?"success":"error",{action:this.action,text:this.selectedText,trigger:this.trigger,clearSelection:this.clearSelection.bind(this)})}},{key:"clearSelection",value:function e(){this.target&&this.target.blur(),window.getSelection().removeAllRanges()}},{key:"destroy",value:function e(){this.removeFake()}},{key:"action",set:function e(){var t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:"copy";if(this._action=t,"copy"!==this._action&&"cut"!==this._action)throw new Error('Invalid "action" value, use either "copy" or "cut"')},get:function e(){return this._action}},{key:"target",set:function e(t){if(void 0!==t){if(!t||"object"!==("undefined"==typeof t?"undefined":r(t))||1!==t.nodeType)throw new Error('Invalid "target" value, use a valid Element');if("copy"===this.action&&t.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if("cut"===this.action&&(t.hasAttribute("readonly")||t.hasAttribute("disabled")))throw new Error('Invalid "target" attribute. You can\'t cut text from elements with "readonly" or "disabled" attributes');this._target=t}},get:function e(){return this._target}}]),e}();e.exports=c})},{select:5}],8:[function(t,n,i){!function(o,r){if("function"==typeof e&&e.amd)e(["module","./clipboard-action","tiny-emitter","good-listener"],r);else if("undefined"!=typeof i)r(n,t("./clipboard-action"),t("tiny-emitter"),t("good-listener"));else{var a={exports:{}};r(a,o.clipboardAction,o.tinyEmitter,o.goodListener),o.clipboard=a.exports}}(this,function(e,t,n,i){"use strict";function o(e){return e&&e.__esModule?e:{default:e}}function r(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")}function a(e,t){if(!e)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return!t||"object"!=typeof t&&"function"!=typeof t?e:t}function c(e,t){if("function"!=typeof t&&null!==t)throw new TypeError("Super expression must either be null or a function, not "+typeof t);e.prototype=Object.create(t&&t.prototype,{constructor:{value:e,enumerable:!1,writable:!0,configurable:!0}}),t&&(Object.setPrototypeOf?Object.setPrototypeOf(e,t):e.__proto__=t)}function l(e,t){var n="data-clipboard-"+e;if(t.hasAttribute(n))return t.getAttribute(n)}var s=o(t),u=o(n),f=o(i),d=function(){function e(e,t){for(var n=0;n0&&void 0!==arguments[0]?arguments[0]:{};this.action="function"==typeof t.action?t.action:this.defaultAction,this.target="function"==typeof t.target?t.target:this.defaultTarget,this.text="function"==typeof t.text?t.text:this.defaultText}},{key:"listenClick",value:function e(t){var n=this;this.listener=(0,f.default)(t,"click",function(e){return n.onClick(e)})}},{key:"onClick",value:function e(t){var n=t.delegateTarget||t.currentTarget;this.clipboardAction&&(this.clipboardAction=null),this.clipboardAction=new s.default({action:this.action(n),target:this.target(n),text:this.text(n),trigger:n,emitter:this})}},{key:"defaultAction",value:function e(t){return l("action",t)}},{key:"defaultTarget",value:function e(t){var n=l("target",t);if(n)return document.querySelector(n)}},{key:"defaultText",value:function e(t){return l("text",t)}},{key:"destroy",value:function e(){this.listener.destroy(),this.clipboardAction&&(this.clipboardAction.destroy(),this.clipboardAction=null)}}]),t}(u.default);e.exports=h})},{"./clipboard-action":7,"good-listener":4,"tiny-emitter":6}]},{},[8])(8)}); \ No newline at end of file diff --git a/docs/input/docs/contributing/index.cshtml b/docs/input/docs/contributing/index.cshtml deleted file mode 100644 index 813f06d0d..000000000 --- a/docs/input/docs/contributing/index.cshtml +++ /dev/null @@ -1,6 +0,0 @@ ---- -Order: 100 -Description: Instructions how to contribute to the Cake Issues Addin. ---- - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/contributing/issues.cshtml b/docs/input/docs/contributing/issues.cshtml deleted file mode 100644 index 49870f8ed..000000000 --- a/docs/input/docs/contributing/issues.cshtml +++ /dev/null @@ -1,19 +0,0 @@ ---- -Order: 20 -Title: Open issues -Description: Open issues where we are looking for help ---- -@foreach(var group in Documents["Issues"].GroupBy(d => d.String("Repository")).OrderBy(g => g.Key)){ -

    @Html.Raw(group.Key)

    - @foreach (var issuesEntry in group.OrderBy(x => x.Get("Number"))){ -
    - - - #@Html.Raw(issuesEntry.String("Number")) - - - @Html.Raw(issuesEntry.String("Title")) - -
    - } -} \ No newline at end of file diff --git a/docs/input/docs/extending/fundamentals.md b/docs/input/docs/extending/fundamentals.md deleted file mode 100644 index d5eb30a0b..000000000 --- a/docs/input/docs/extending/fundamentals.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -Order: 10 -Title: Fundamentals -Description: Fundamentals to extend Cake Issues ecosystem. ---- - -You can easily extend Cake Issues with additional [Issue Provider], [Report Formats] and [Pull Request System integrations]. - -[Issue Provider]: issue-provider -[Report Formats]: report-format -[Pull Request System integrations]: pull-request-system \ No newline at end of file diff --git a/docs/input/docs/extending/index.cshtml b/docs/input/docs/extending/index.cshtml deleted file mode 100644 index a5469c139..000000000 --- a/docs/input/docs/extending/index.cshtml +++ /dev/null @@ -1,6 +0,0 @@ ---- -Order: 80 -Description: Instructions how to add support for additional analyzers, report formats and pull request system to the Cake Issues Addin. ---- - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/extending/issue-provider/categories.md b/docs/input/docs/extending/issue-provider/categories.md deleted file mode 100644 index f6d781972..000000000 --- a/docs/input/docs/extending/issue-provider/categories.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -Order: 30 -Title: Alias categories -Description: Instructions how to set the alias category. ---- -Issue provider aliases should use the [IssuesAliasConstants.MainCakeAliasCategory] and -[IssuesAliasConstants.IssueProviderCakeAliasCategory] constants for defining their category: - -```csharp -[CakeAliasCategory(IssuesAliasConstants.MainCakeAliasCategory)] -public static class MyIssueProviderAliases -{ - [CakeMethodAlias] - [CakeAliasCategory(IssuesAliasConstants.IssueProviderCakeAliasCategory)] - public static IIssueProvider MyIssueProvider( - this ICakeContext context) - { - } -} -``` - -[IssuesAliasConstants.MainCakeAliasCategory]: ../../../api/Cake.Issues/IssuesAliasConstants/41CCADF8 -[IssuesAliasConstants.IssueProviderCakeAliasCategory]: ../../../api/Cake.Issues/IssuesAliasConstants/D265B28D \ No newline at end of file diff --git a/docs/input/docs/extending/issue-provider/index.cshtml b/docs/input/docs/extending/issue-provider/index.cshtml deleted file mode 100644 index 3ed5de7aa..000000000 --- a/docs/input/docs/extending/issue-provider/index.cshtml +++ /dev/null @@ -1,6 +0,0 @@ ---- -Order: 10 -Description: Instructions how to add support for additional analyzers to the Cake Issues addin. ---- - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/extending/issue-provider/overview.md b/docs/input/docs/extending/issue-provider/overview.md deleted file mode 100644 index 44066737b..000000000 --- a/docs/input/docs/extending/issue-provider/overview.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -Order: 20 -Title: Overview -Description: Overview how to implement support for an analyzer or linter. ---- -Issue providers need to implement the [IIssueProvider] interface. - -# Base classes - -For simplifying implementation there exists base classes from which concrete implementation can be inherited. - -| Base Class | Use case | Tutorial | -|---------------------------------|------------------------------------------------------------------------|-------------------------------------| -| [BaseIssueProvider] | Base class for a simple issue provider implementation. | [Simple provider] | -| [BaseConfigurableIssueProvider] | Base class for a issue provider with issue provider specific settings. | [Provider settings] | -| [BaseMultiFormatIssueProvider] | Base class for issue providers supporting multiple log formats. | [Multiple log file formats support] | - -[IIssueProvider]: ../../../api/Cake.Issues/IIssueProvider/ -[BaseIssueProvider]: ../../../api/Cake.Issues/BaseIssueProvider -[BaseConfigurableIssueProvider]: ../../../api/Cake.Issues/BaseConfigurableIssueProvider_1 -[BaseMultiFormatIssueProvider]: ../../../api/Cake.Issues/BaseMultiFormatIssueProvider_2 -[Simple provider]: tutorials/simple -[Provider settings]: tutorials/settings -[Multiple log file formats support]: tutorials/logfile-format \ No newline at end of file diff --git a/docs/input/docs/extending/issue-provider/tutorials/index.cshtml b/docs/input/docs/extending/issue-provider/tutorials/index.cshtml deleted file mode 100644 index 4dd2b0f56..000000000 --- a/docs/input/docs/extending/issue-provider/tutorials/index.cshtml +++ /dev/null @@ -1,6 +0,0 @@ ---- -Order: 40 -Description: Tutorials how to implement issue providers. ---- - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/extending/pull-request-system/index.cshtml b/docs/input/docs/extending/pull-request-system/index.cshtml deleted file mode 100644 index e05db6073..000000000 --- a/docs/input/docs/extending/pull-request-system/index.cshtml +++ /dev/null @@ -1,6 +0,0 @@ ---- -Order: 30 -Description: Instructions how to add support for additional pull request system to the Cake Issues addin. ---- - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/extending/pull-request-system/overview.md b/docs/input/docs/extending/pull-request-system/overview.md deleted file mode 100644 index 3fbf0a88e..000000000 --- a/docs/input/docs/extending/pull-request-system/overview.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -Order: 20 -Title: Overview -Description: Overview how to implement support for a pull request system. ---- -Pull Request Systems need to implement the [IPullRequestSystem] interface. - -# BaseClasses - -For simplifying implementation there exists base classes from which concrete implementation can be inherited. -[BasePullRequestSystem] is the main base class with the required functionality for a pull request system implementation. -Additionally there exists several classes which can be implemented to support additional optional capabilities -in a pull request system implementation. - -| Base Class | Use case | Tutorial | -|------------------------------------------|--------------------------------------------------------------------------------------------------------|-------------------------------------| -| [BasePullRequestSystem] | Base class for all pull request system implementations. | | -| [BaseCheckingCommitIdCapability] | Base class for capability to post issues only if pull request is for a specific commit. | | -| [BaseDiscussionThreadsCapability] | Base class for capability to read, resolve and reopen discussion threads. | | -| [BaseFilteringByModifiedFilesCapability] | Base class for capability to filter issues to only those affecting files modified in the pull request. | | - -[IPullRequestSystem]: ../../../api/Cake.Issues.PullRequests/IPullRequestSystem -[BasePullRequestSystem]: ../../../api/Cake.Issues.PullRequests/BasePullRequestSystem -[BaseCheckingCommitIdCapability]: ../../../api/Cake.Issues.PullRequests/BaseCheckingCommitIdCapability_1 -[BaseDiscussionThreadsCapability]: ../../../api/Cake.Issues.PullRequests/BaseDiscussionThreadsCapability_1 -[BaseFilteringByModifiedFilesCapability]: ../../../api/Cake.Issues.PullRequests/BaseFilteringByModifiedFilesCapability_1 \ No newline at end of file diff --git a/docs/input/docs/extending/report-format/categories.md b/docs/input/docs/extending/report-format/categories.md deleted file mode 100644 index fd9b0a477..000000000 --- a/docs/input/docs/extending/report-format/categories.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -Order: 30 -Title: Alias categories -Description: Instructions how to set the alias category. ---- -Report format aliases should use the [IssuesAliasConstants.MainCakeAliasCategory] and -[ReportingAliasConstants.ReportingFormatCakeAliasCategory] constants for defining their category: - -```csharp -[CakeAliasCategory(IssuesAliasConstants.MainCakeAliasCategory)] -public static class MyReportFormatAliases -{ - [CakeMethodAlias] - [CakeAliasCategory(ReportingAliasConstants.ReportingFormatCakeAliasCategory)] - public static IIssueReportFormat MyReportFormat( - this ICakeContext context) - { - } -} -``` - -[IssuesAliasConstants.MainCakeAliasCategory]: ../../../api/Cake.Issues/IssuesAliasConstants/41CCADF8 -[ReportingAliasConstants.ReportingFormatCakeAliasCategory]: ../../../api/Cake.Issues.Reporting/ReportingAliasConstants/979CDCAF \ No newline at end of file diff --git a/docs/input/docs/extending/report-format/index.cshtml b/docs/input/docs/extending/report-format/index.cshtml deleted file mode 100644 index 06f0e9dda..000000000 --- a/docs/input/docs/extending/report-format/index.cshtml +++ /dev/null @@ -1,6 +0,0 @@ ---- -Order: 20 -Description: Instructions how to additional report formats to the Cake Issues addin. ---- - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/extending/report-format/overview.md b/docs/input/docs/extending/report-format/overview.md deleted file mode 100644 index 179d63030..000000000 --- a/docs/input/docs/extending/report-format/overview.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -Order: 20 -Title: Overview -Description: Overview how to implement support for a report output format. ---- -Report formats need to implement the [IIssueReportFormat] interface. -For simplifying implementation there exists an abstract [IssueReportFormat] base class from which concrete implementation can be inherited. - -[IIssueReportFormat]: ../../../api/Cake.Issues.Reporting/IIssueReportFormat/ -[IssueReportFormat]: ../../../api/Cake.Issues.Reporting/IssueReportFormat/ \ No newline at end of file diff --git a/docs/input/docs/extending/testing.md b/docs/input/docs/extending/testing.md deleted file mode 100644 index 9d96b697f..000000000 --- a/docs/input/docs/extending/testing.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -Order: 40 -Title: Testing -Description: Instructions how to write test cases for Cake Issues addins. ---- -The `Cake.Issues.Testing` provides different helper classes for writing test cases -for issue provider, report format or pull request system addins. - -See [API] for a list of available classes. - -[API]: ../../api/Cake.Issues.Testing/ \ No newline at end of file diff --git a/docs/input/docs/fundamentals/index.cshtml b/docs/input/docs/fundamentals/index.cshtml deleted file mode 100644 index 2d505966a..000000000 --- a/docs/input/docs/fundamentals/index.cshtml +++ /dev/null @@ -1,6 +0,0 @@ ---- -Order: 20 -Description: Basic concepts of the Cake Issues Addin. ---- - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/index.cshtml b/docs/input/docs/index.cshtml deleted file mode 100644 index a76a27890..000000000 --- a/docs/input/docs/index.cshtml +++ /dev/null @@ -1,20 +0,0 @@ ---- -Title: 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. -

    -
    - -@foreach(IDocument child in Model.DocumentList(Keys.Children).OrderBy(x => x.Get(DocsKeys.Order, 1000))) -{ -

    @(child.String(Keys.Title))

    - if(child.ContainsKey(DocsKeys.Description)) - { -

    @Html.Raw(child.String(DocsKeys.Description))

    - } - - @Html.Partial("_ChildPages", child) -} diff --git a/docs/input/docs/issue-providers/docfx/features.md b/docs/input/docs/issue-providers/docfx/features.md deleted file mode 100644 index 64cd24977..000000000 --- a/docs/input/docs/issue-providers/docfx/features.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -Order: 20 -Title: Features -Description: Features of the Cake.Issues.DocFx addin. ---- -The [Cake.Issues.DocFx addin] provides the following features. - -# Basic features - -* Reads warnings from [DocFx] log files. - - :::{.alert .alert-info} - [DocFx] can be run with [Cake.DocFx] addin. - ::: - -# 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` | | - -[Cake.Issues.DocFx addin]: https://www.nuget.org/packages/Cake.Issues.DocFx -[DocFx]: https://dotnet.github.io/docfx/ -[Cake.DocFx]: https://www.nuget.org/packages/Cake.DocFx -[IssuePriority.Warning]: ../../../api/Cake.Issues/IssuePriority/7A0CE07F diff --git a/docs/input/docs/issue-providers/docfx/index.cshtml b/docs/input/docs/issue-providers/docfx/index.cshtml deleted file mode 100644 index 4ac9d00d7..000000000 --- a/docs/input/docs/issue-providers/docfx/index.cshtml +++ /dev/null @@ -1,12 +0,0 @@ ---- -Title: DocFx -Description: Issue provider which allows you to read warnings logged by DocFx. ---- -

    @Html.Raw(Model.String(DocsKeys.Description))

    - -

    - Support for reading warnings reported by DocFx - is implemented in the Cake.Issues.DocFx addin. -

    - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/issue-providers/docfx/requirements.md b/docs/input/docs/issue-providers/docfx/requirements.md deleted file mode 100644 index 576c77bd7..000000000 --- a/docs/input/docs/issue-providers/docfx/requirements.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -Order: 10 -Title: Requirements -Description: Requirements for the Cake.Issues.DocFx addin. ---- -The requirements for using the [Cake.Issues.DocFx addin] are listed in the [release notes] for any specific version. - -[Cake.Issues.DocFx addin]: https://www.nuget.org/packages/Cake.Issues.DocFx -[release notes]: release-notes diff --git a/docs/input/docs/issue-providers/eslint/features.md b/docs/input/docs/issue-providers/eslint/features.md deleted file mode 100644 index bef51cbc9..000000000 --- a/docs/input/docs/issue-providers/eslint/features.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -Order: 20 -Title: Features -Description: Features of the Cake.Issues.EsLint addin. ---- -The [Cake.Issues.EsLint addin] provides the following features. - -# Basic features - -* Reads issues reported by ESLint. -* Provides URLs for all issues. -* Support for custom URL resolving using the [EsLintAddRuleUrlResolver] alias. - -# Supported log file formats - -* [EsLintJsonFormat] alias for reading issues from log files created by [ESLint json formatter]. - -# 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.MessageText` | | -| | `IIssue.MessageHtml` | | -| | `IIssue.MessageMarkdown` | | -| | `IIssue.Priority` | | -| | `IIssue.PriorityName` | | -| | `IIssue.Rule` | | -| | `IIssue.RuleUrl` | Support for custom rules can be added through a custom [EsLintAddRuleUrlResolver] | - -[Cake.Issues.EsLint addin]: https://www.nuget.org/packages/Cake.Issues.EsLint -[ESLint json formatter]: https://eslint.org/docs/user-guide/formatters/#json -[EsLintAddRuleUrlResolver]: ../../../api/Cake.Issues.EsLint/EsLintIssuesAliases/D64301E6 -[EsLintJsonFormat]: ../../../api/Cake.Issues.EsLint/EsLintIssuesAliases/230C6E27 diff --git a/docs/input/docs/issue-providers/eslint/index.cshtml b/docs/input/docs/issue-providers/eslint/index.cshtml deleted file mode 100644 index 67d797242..000000000 --- a/docs/input/docs/issue-providers/eslint/index.cshtml +++ /dev/null @@ -1,12 +0,0 @@ ---- -Title: ESLint -Description: Issue provider which allows you to read issues logged by ESLint. ---- -

    @Html.Raw(Model.String(DocsKeys.Description))

    - -

    - Support for reading issues reported by ESLint - is implemented in the Cake.Issues.EsLint addin. -

    - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/issue-providers/eslint/requirements.md b/docs/input/docs/issue-providers/eslint/requirements.md deleted file mode 100644 index dbca0cec9..000000000 --- a/docs/input/docs/issue-providers/eslint/requirements.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -Order: 10 -Title: Requirements -Description: Requirements for the Cake.Issues.EsLint addin. ---- -The requirements for using the [Cake.Issues.EsLint addin] are listed in the [release notes] for any specific version. - -[Cake.Issues.EsLint addin]: https://www.nuget.org/packages/Cake.Issues.EsLint -[release notes]: release-notes diff --git a/docs/input/docs/issue-providers/gitrepository/features.md b/docs/input/docs/issue-providers/gitrepository/features.md deleted file mode 100644 index 55dbdfcc4..000000000 --- a/docs/input/docs/issue-providers/gitrepository/features.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -Order: 20 -Title: Features -Description: Features of the Cake.Issues.GitRepository addin. ---- -The [Cake.Issues.GitRepository addin] provides the following features. - -# Basic features - -* Checks path length of files. See [FilePathTooLong] for details. -* Checks if binary files are tracked by Git LFS. See [BinaryFileNotTrackedByLfs] for details. - -# 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` | | - -[Cake.Issues.GitRepository addin]: https://www.nuget.org/packages/Cake.Issues.GitRepository -[FilePathTooLong]: rules/FilePathTooLong -[BinaryFileNotTrackedByLfs]: rules/BinaryFileNotTrackedByLfs diff --git a/docs/input/docs/issue-providers/gitrepository/index.cshtml b/docs/input/docs/issue-providers/gitrepository/index.cshtml deleted file mode 100644 index 35d944fbd..000000000 --- a/docs/input/docs/issue-providers/gitrepository/index.cshtml +++ /dev/null @@ -1,11 +0,0 @@ ---- -Title: Git Repository -Description: Issue provider which allows you to analyzing Git repositories and create issues resulting from it. ---- -

    @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 deleted file mode 100644 index e491db400..000000000 --- a/docs/input/docs/issue-providers/gitrepository/requirements.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -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 deleted file mode 100644 index ccf4197bb..000000000 --- a/docs/input/docs/issue-providers/gitrepository/rules/BinaryFileNotTrackedByLfs.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -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/index.cshtml b/docs/input/docs/issue-providers/gitrepository/rules/index.cshtml deleted file mode 100644 index 31e0d52d1..000000000 --- a/docs/input/docs/issue-providers/gitrepository/rules/index.cshtml +++ /dev/null @@ -1,7 +0,0 @@ ---- -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/index.cshtml b/docs/input/docs/issue-providers/index.cshtml deleted file mode 100644 index f1b8a0c4c..000000000 --- a/docs/input/docs/issue-providers/index.cshtml +++ /dev/null @@ -1,7 +0,0 @@ ---- -Order: 50 -Description: Documentation of the different issue provider addins. ---- -

    @Html.Raw(Model.String(DocsKeys.Description))

    - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/issue-providers/inspectcode/features.md b/docs/input/docs/issue-providers/inspectcode/features.md deleted file mode 100644 index 93462f82d..000000000 --- a/docs/input/docs/issue-providers/inspectcode/features.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -Order: 20 -Title: Features -Description: Features of the Cake.Issues.InspectCode addin. ---- -The [Cake.Issues.InspectCode addin] provides the following features: - -# Basic features - -* Reads warnings from [JetBrains InsepectCode] log files. -* Provides URLs for issues containing a Wiki URL. - -# 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` | For issues containing a Wiki Url | - -[JetBrains InsepectCode]: https://www.jetbrains.com/help/resharper/2017.1/InspectCode.html -[Cake.Issues.InspectCode addin]: https://www.nuget.org/packages/Cake.Issues.InspectCode diff --git a/docs/input/docs/issue-providers/inspectcode/index.cshtml b/docs/input/docs/issue-providers/inspectcode/index.cshtml deleted file mode 100644 index 4f18b059f..000000000 --- a/docs/input/docs/issue-providers/inspectcode/index.cshtml +++ /dev/null @@ -1,12 +0,0 @@ ---- -Title: InspectCode -Description: Issue provider which allows you to read issues logged by JetBrains Inspect Code. ---- -

    @Html.Raw(Model.String(DocsKeys.Description))

    - -

    - Support for reading issues reported by JetBrains Inspect Code - is implemented in the Cake.Issues.InspectCode addin. -

    - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/issue-providers/inspectcode/requirements.md b/docs/input/docs/issue-providers/inspectcode/requirements.md deleted file mode 100644 index 097fe05e6..000000000 --- a/docs/input/docs/issue-providers/inspectcode/requirements.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -Order: 10 -Title: Requirements -Description: Requirements for the Cake.Issues.Inspectcode addin. ---- -The requirements for using the [Cake.Issues.InspectCode addin] are listed in the [release notes] for any specific version. - -[Cake.Issues.InspectCode addin]: https://www.nuget.org/packages/Cake.Issues.InspectCode -[release notes]: release-notes diff --git a/docs/input/docs/issue-providers/markdownlint/features.md b/docs/input/docs/issue-providers/markdownlint/features.md deleted file mode 100644 index 9b6d2d63b..000000000 --- a/docs/input/docs/issue-providers/markdownlint/features.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -Order: 20 -Title: Features -Description: Features of the Cake.Issues.Markdownlint addin. ---- -The [Cake.Issues.Markdownlint addin] provides the following features. - -# Basic features - -* Reads warnings from [Markdownlint] logfiles. -* Provides URLs for all issues. -* Support for custom URL resolving using the [MarkdownlintAddRuleUrlResolver] alias (except for [MarkdownlintCliJsonLogFileFormat]). - -# Supported log file formats - -* [MarkdownlintLogFileFormat] alias for reading issues from [Markdownlint] output generated with `options.resultVersion` set to 1. -* [MarkdownlintCliLogFileFormat] alias for reading issues from [markdownlint-cli] log files. -* [MarkdownlintCliJsonLogFileFormat] alias for reading issues from [markdownlint-cli] log files created with the `--json` parameter. - - :::{.alert .alert-info} - [markdownlint-cli] can be run with the [Cake.Markdownlint] addin. - ::: - -# 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` | Only for [MarkdownlintCliLogFileFormat] | -| | `IIssue.EndColumn` | | -| | `IIssue.FileLink` | Can be set while reading issues | -| | `IIssue.MessageText` | | -| | `IIssue.MessageHtml` | | -| | `IIssue.MessageMarkdown` | | -| | `IIssue.Priority` | Always [IssuePriority.Warning] | -| | `IIssue.PriorityName` | Always `Warning` | -| | `IIssue.Rule` | | -| | `IIssue.RuleUrl` | Support for custom rules can be added through a custom [MarkdownlintAddRuleUrlResolver] except for [MarkdownlintCliJsonLogFileFormat] | - -[Cake.Issues.Markdownlint addin]: https://www.nuget.org/packages/Cake.Issues.Markdownlint -[Markdownlint]: https://github.com/DavidAnson/markdownlint -[markdownlint-cli]: https://github.com/igorshubovych/markdownlint-cli -[Cake.Markdownlint]: https://www.nuget.org/packages/Cake.Markdownlint/ -[MarkdownlintAddRuleUrlResolver]: ../../../api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/2EE35F55 -[MarkdownlintLogFileFormat]: ../../../api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/EBFF674A -[MarkdownlintCliLogFileFormat]: ../../../api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/B518F49E -[MarkdownlintCliJsonLogFileFormat]: ../../../api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/36DE6F5F -[IssuePriority.Warning]: ../../../api/Cake.Issues/IssuePriority/7A0CE07F diff --git a/docs/input/docs/issue-providers/markdownlint/index.cshtml b/docs/input/docs/issue-providers/markdownlint/index.cshtml deleted file mode 100644 index ab68430a4..000000000 --- a/docs/input/docs/issue-providers/markdownlint/index.cshtml +++ /dev/null @@ -1,12 +0,0 @@ ---- -Title: markdownlint -Description: Issue provider which allows you to read issues logged by markdownlint. ---- -

    @Html.Raw(Model.String(DocsKeys.Description))

    - -

    - Support for reading issues reported by markdownlint - is implemented in the Cake.Issues.Markdownlint addin. -

    - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/issue-providers/markdownlint/requirements.md b/docs/input/docs/issue-providers/markdownlint/requirements.md deleted file mode 100644 index e7d7f9a35..000000000 --- a/docs/input/docs/issue-providers/markdownlint/requirements.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -Order: 10 -Title: Requirements -Description: Requirements for the Cake.Issues.Markdownlint addin. ---- -The requirements for using the [Cake.Issues.Markdownlint addin] are listed in the [release notes] for any specific version. - -[Cake.Issues.Markdownlint addin]: https://www.nuget.org/packages/Cake.Issues.Markdownlint -[release notes]: release-notes diff --git a/docs/input/docs/issue-providers/msbuild/features.md b/docs/input/docs/issue-providers/msbuild/features.md deleted file mode 100644 index 8f92f5fbc..000000000 --- a/docs/input/docs/issue-providers/msbuild/features.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -Order: 20 -Title: Features -Description: Features of the Cake.Issues.MsBuild addin. ---- -The [Cake.Issues.MsBuild addin] provides the following features. - -# Basic features - -* Reads errors and warnings from MSBuild log files. -* Provides URLs for all code analysis (`CA*`) and StyleCop (`SA*`) warnings. -* Support for custom URL resolving using the [MsBuildAddRuleUrlResolver] alias. - -# Supported log file formats - -* [MsBuildBinaryLogFileFormat] alias for reading issues from binary log files. -* [MsBuildXmlFileLoggerFormat] alias for reading issues from log files created by [MSBuild Extension Pack XmlFileLogger]. - -# 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` | Only for [MsBuildXmlFileLoggerFormat] | -| | `IIssue.EndColumn` | | -| | `IIssue.FileLink` | Can be set while reading issues | -| | `IIssue.MessageText` | | -| | `IIssue.MessageHtml` | | -| | `IIssue.MessageMarkdown` | | -| | `IIssue.Priority` | | -| | `IIssue.PriorityName` | | -| | `IIssue.Rule` | | -| | `IIssue.RuleUrl` | For code analysis (`CA*`) and StyleCop (`SA*`) warnings. Support for additional rules can be added through a custom [MsBuildAddRuleUrlResolver] | - -[Cake.Issues.MsBuild addin]: https://www.nuget.org/packages/Cake.Issues.MsBuild -[MSBuild Extension Pack XmlFileLogger]: https://github.com/mikefourie-zz/MSBuildExtensionPack/blob/master/Solutions/Main/Loggers/Framework/XmlFileLogger.cs -[MsBuildAddRuleUrlResolver]: ../../../api/Cake.Issues.MsBuild/MsBuildIssuesAliases/93C21487 -[MsBuildBinaryLogFileFormat]: ../../../api/Cake.Issues.MsBuild/MsBuildIssuesAliases/AD50C7E1 -[MsBuildXmlFileLoggerFormat]: ../../../api/Cake.Issues.MsBuild/MsBuildIssuesAliases/051D7B6E -[IssuePriority.Warning]: ../../../api/Cake.Issues/IssuePriority/7A0CE07F diff --git a/docs/input/docs/issue-providers/msbuild/index.cshtml b/docs/input/docs/issue-providers/msbuild/index.cshtml deleted file mode 100644 index 394da8734..000000000 --- a/docs/input/docs/issue-providers/msbuild/index.cshtml +++ /dev/null @@ -1,12 +0,0 @@ ---- -Title: MsBuild -Description: Issue provider which allows you to read warnings logged by MsBuild. ---- -

    @Html.Raw(Model.String(DocsKeys.Description))

    - -

    - Support for reading warnings reported by MsBuild is implemented in the - Cake.Issues.MsBuild addin. -

    - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/issue-providers/msbuild/requirements.md b/docs/input/docs/issue-providers/msbuild/requirements.md deleted file mode 100644 index bc25ea62c..000000000 --- a/docs/input/docs/issue-providers/msbuild/requirements.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -Order: 10 -Title: Requirements -Description: Requirements for the Cake.Issues.MsBuild addin. ---- -The requirements for using the [Cake.Issues.MsBuild addin] are listed in the [release notes] for any specific version. - -[Cake.Issues.MsBuild addin]: https://www.nuget.org/packages/Cake.Issues.MsBuild -[release notes]: release-notes diff --git a/docs/input/docs/issue-providers/terraform/features.md b/docs/input/docs/issue-providers/terraform/features.md deleted file mode 100644 index dbb414f25..000000000 --- a/docs/input/docs/issue-providers/terraform/features.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -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 deleted file mode 100644 index 184598ebb..000000000 --- a/docs/input/docs/issue-providers/terraform/index.cshtml +++ /dev/null @@ -1,12 +0,0 @@ ---- -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 deleted file mode 100644 index 4b7a408f3..000000000 --- a/docs/input/docs/issue-providers/terraform/requirements.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -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/overview/index.cshtml b/docs/input/docs/overview/index.cshtml deleted file mode 100644 index 67ee8bb24..000000000 --- a/docs/input/docs/overview/index.cshtml +++ /dev/null @@ -1,6 +0,0 @@ ---- -Order: 10 -Description: Overview about features and requirements of the Cake Issues Addin. ---- - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/overview/release-notes/Cake.Issues.PullRequests.md b/docs/input/docs/overview/release-notes/Cake.Issues.PullRequests.md deleted file mode 100644 index 0fe9da522..000000000 --- a/docs/input/docs/overview/release-notes/Cake.Issues.PullRequests.md +++ /dev/null @@ -1,930 +0,0 @@ ---- -Title: Cake.Issues.PullRequests Release Notes -Description: Release notes for Cake.Issues.PullRequests ---- -

    -

    -

    -Starting with Cake.Issues 1.0, release notes for Cake.Issues.PullRequests will be listed with Cake.Issues Release Notes. -The release notes on this page are only for versions of Cake.Issues.PullRequests prior to 1.0. -

    -
    -

    - -## 0.9.1 (October 08, 2020) - - -As part of this release we had [1 issue](https://github.com/cake-contrib/Cake.Issues.PullRequests/milestone/15?closed=1) closed. - -__Requirements__ - -- Cake 0.33.0 or higher -- Cake.Issues 0.9.x -- Targeting .NET Standard 2.0 - -__Bug__ - -- [__#173__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/173) Setting a ProviderLimit to zero will ignore the limit instead of posting 0 items - - -## 0.9.0 (August 22, 2020) - - -As part of this release we had [4 issues](https://github.com/cake-contrib/Cake.Issues.PullRequests/milestone/13?closed=1) closed. - -__Requirements__ - -- Cake 0.33.0 or higher -- Cake.Issues 0.9.x -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- [__#154__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/154) Update to Cake.Issues 0.9.0 - -__Features__ - -- [__#143__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/143) Use identifier different from displayed message to compare existing issues -- [__#142__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/142) Add setting to limit number of issues posted to a pull request across multiple runs for issue providers -- [__#141__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/141) Add possibility to limit posted issues for a specific provider - - -## 0.9.0-beta.3 (August 01, 2020) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.33.0 or higher -- Cake.Issues 0.9.0-beta0004 -- Targeting .NET Standard 2.0 - -__Breaking Changes__ - -- Update to Cake.Issues 0.9.0-beta0004 -## 0.9.0-beta.2 (July 18, 2020) - - -As part of this release we had 3 issues closed. - -__Requirements__ - -- Cake 0.33.0 or higher -- Cake.Issues 0.9.0-beta0002 -- Targeting .NET Standard 2.0 - -__Features__ - -- [__#143__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/143) Use identifier different from displayed message to compare existing issues -- [__#142__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/142) Add setting to limit number of issues posted to a pull request across multiple runs for issue providers -- [__#141__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/141) Add possibility to limit posted issues for a specific provider - - -## 0.9.0-beta.1 (July 14, 2020) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.33.0 or higher -- Cake.Issues 0.9.0-beta0002 -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- [__#154__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/154) Update to Cake.Issues 0.9.0 - - -## 0.8.1 (May 03, 2020) - - -As part of this release we had [2 issues](https://github.com/cake-contrib/Cake.Issues.PullRequests/milestone/12?closed=1) closed. - -__Requirements__ - -- Cake 0.33.0 or higher -- Cake.Issues 0.8.x -- Targeting .NET Standard 2.0 - -__Bug__ - -- [__#136__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/136) Don't log issues if they are not posted due to outdated commit - -__Improvement__ - -- [__#134__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/134) Add setting to limit number of issues posted to a pull request across multiple runs - - -## 0.8.1-beta.2 (April 29, 2020) - - -As part of this release we had 1 issue closed compared to 0.8.1-beta.1. - -__Requirements__ - -- Cake 0.33.0 or higher -- Cake.Issues 0.8.x -- Targeting .NET Standard 2.0 - -__Bug__ - -- [__#145__](https://github.com/cake-contrib/Cake.Issues.PullRequests/pull/145) Consider unresolved issues for MaxIssuesToPostAcrossRuns (Thanks @janniksam) -## 0.8.1-beta.1 (April 27, 2020) - - -As part of this release we had [2 issues](https://github.com/cake-contrib/Cake.Issues.PullRequests/milestone/12?closed=1) closed. - -__Requirements__ - -- Cake 0.33.0 or higher -- Cake.Issues 0.8.x -- Targeting .NET Standard 2.0 - -__Improvement__ - -- [__#134__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/134) Add setting to limit number of issues posted to a pull request across multiple runs - -__Bug__ - -- [__#136__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/136) Don't log issues if they are not posted due to outdated commit -## 0.8.0 (October 17, 2019) - - -As part of this release we had [3 issues](https://github.com/cake-contrib/Cake.Issues.PullRequests/milestone/11?closed=1) closed. - -__Requirements__ - -- Cake 0.33.0 or higher -- Cake.Issues 0.8.x -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- [__#113__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/113) Update to Cake.Issues 0.8.0 - -__Improvements__ - -- [__#118__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/118) Embed NuGet package icon -- [__#116__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/116) Improve performance logging for issue filtering - - -## 0.8.0-beta.1 (October 11, 2019) - - -As part of this release we had [1 issue](https://github.com/cake-contrib/Cake.Issues.PullRequests/milestone/11?closed=1) closed. - -__Requirements__ - -- Cake 0.33.0 or higher -- Cake.Issues 0.8.0-beta.1 -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- [__#113__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/113) Update to Cake.Issues 0.8.0 - - -## 0.7.0 (May 30, 2019) - - -As part of this release we had [32 commits](https://github.com/cake-contrib/Cake.Issues.PullRequests/compare/0.6.2...0.7.0) which resulted in [2 issues](https://github.com/cake-contrib/Cake.Issues.PullRequests/milestone/10?closed=1) being closed. - -__Requirements__ - -- Cake 0.33.0 or higher -- Cake.Issues 0.7.x -- Targeting .NET Standard 2.0 - -__Breaking changes__ - -- [__#78__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/78) Update to Cake.Issues 0.7.0 -- [__#77__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/77) Build against Cake 0.33.0 - - -## 0.7.0-beta.1 (April 19, 2019) - - -As part of this release we had 2 issues closed. - -__Requirements__ - -- Cake 0.33.0 or higher -- Cake.Issues 0.7.x -- Targeting .NET Standard 2.0 - -__Breaking changes__ - -- [__#78__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/78) Update to Cake.Issues 0.7.0 -- [__#77__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/77) Build against Cake 0.33.0 - - -## 0.6.2 (December 15, 2018) - - -As part of this release we had [1 issue](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues?milestone=9&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.6.x - -__Bug__ - -- [__#50__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/50) No exception should be thrown if an empty list of issues is passed - - -## 0.6.1 (September 04, 2018) - - -As part of this release we had [1 issue](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues?milestone=8&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.6.x - -__Improvement__ - -- [__#28__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/28) Provide alias which a list of issues can be passed - - -## 0.6.1-beta.1 (September 04, 2018) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.6.x - -__Improvement__ - -- [__#28__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/28) Provide alias which a list of issues can be passed - - -## 0.6.0 (August 24, 2018) - - -As part of this release we had [2 issues](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues?milestone=7&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.6.x - -__Breaking changes__ - -- [__#45__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/45) Update to Cake.Issues 0.6.0 -- [__#43__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/43) Split pull request interface into different capabilities - - -## 0.6.0-beta.2 (August 20, 2018) - - -As part of this release we had 2 issues closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.6.0-beta.2 - -__Breaking changes__ - -- Update to Cake.Issues 0.6.0 Beta 2 -- Fix error with namespace import - - -## 0.6.0-beta.1 (August 18, 2018) - - -As part of this release we had [2 issues](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues?milestone=7&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.6.0-beta.1 - -__Breaking changes__ - -- [__#45__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/45) Update to Cake.Issues 0.6.0 -- [__#43__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/43) Split pull request interface into different capabilities - - -## 0.5.0 (August 17, 2018) - - -As part of this release we had [2 issues](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues?milestone=6&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.5.x - -__Breaking change__ - -- [__#41__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/41) Update to Cake.Issues 0.5.0 - -__Improvement__ - -- [__#44__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/44) Add repository metadata to nuspec - - -## 0.5.0-beta.1 (August 07, 2018) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.5.0-beta.2 - -__Breaking change__ - -- [__#41__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/41) Update to Cake.Issues 0.5.0 - - -## 0.4.0 (July 28, 2018) - - -As part of this release we had [5 issues](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues?milestone=5&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.4.x - -__Breaking changes__ - -- [__#39__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/39) Update to Cake.Issues 0.4.0 -- [__#30__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/30) Support different resolutions for comment thread resolving - -__Bugs__ - -- [__#36__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/36) Only resolve comments with the same comment source -- [__#29__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/29) Filtering on existing comments sometimes fails - - -## 0.4.0-beta.2 (July 25, 2018) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.4.0-beta.2 - -__Breaking changes__ - -- Update Cake.Issues to 0.4.0-beta.2 -## 0.4.0-beta.1 (July 24, 2018) - - -As part of this release we had 5 issues closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.4.0-beta.1 - -__Breaking changes__ - -- [__#39__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/39) Update to Cake.Issues 0.4.0 -- [__#30__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/30) Support different resolutions for comment thread resolving - -__Bugs__ - -- [__#36__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/36) Only resolve comments with the same comment source -- [__#29__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/29) Filtering on existing comments sometimes fails - - -## 0.3.1 (June 21, 2018) - - -As part of this release we had [1 issue](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues?milestone=4&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.3.x - -__Feature__ - -- [__#25__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/25) Add support to pass additional filter criterias - - -## 0.3.0 (June 04, 2018) - - -As part of this release we had [2 issues](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues?milestone=3&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.3.x - -__Breaking changes__ - -- [__#22__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/22) Build against Cake 0.28.0 -- [__#20__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/20) Update to Cake.Issues 0.3.0 - - -## 0.3.0-beta.2 (June 02, 2018) - - -As part of this release we had [2 issues](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues?milestone=3&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.3.0-beta.2 - -__Breaking changes__ - -- [__#22__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/22) Build against Cake 0.28.0 -- Update to Cake.Issues 0.3.0-beta.2 -## 0.3.0-beta.1 (May 31, 2018) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.26.0 or higher -- Cake.Issues 0.3.0-beta.1 - -__Breaking change__ - -- [__#20__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/20) Update to Cake.Issues 0.3.0 - - -## 0.2.0 (May 22, 2018) - - -As part of this release we had [26 commits](https://github.com/cake-contrib/Cake.Issues.PullRequests/compare/0.1.0...0.2.0) which resulted in [6 issues](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues?milestone=2&state=closed) being closed. - -__Requirements__ - -- Cake 0.26.0 or higher -- Cake.Issues 0.2.x - -__Breaking changes__ - -- [__#18__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/18) Build against Cake 0.26.0 -- [__#16__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/16) Allow to limit maximum issues per issue provider -- [__#14__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/14) Update to Cake.Issues 0.2.0 - -__Improvements__ - -- [__#9__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/9) Migrate to .NET Core -- [__#2__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/2) Check if pull request is still on the same commit before posting issues - - -## 0.2.0-beta.2 (March 10, 2018) - - -As part of this release we had the following issues closed. - -__Requirements__ - -- Cake 0.26.0 or higher -- Cake.Issues 0.2.0-beta.4 - -__Bug__ - -- Mark as CLS compliant - -## 0.2.0-beta.1 (March 08, 2018) - - -As part of this release we had 6 issues closed. - -__Requirements__ - -- Cake 0.26.0 or higher -- Cake.Issues 0.2.0-beta.3 - -__Breaking changes__ - -- [__#18__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/18) Build against Cake 0.26.0 -- [__#16__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/16) Allow to limit maximum issues per issue provider -- [__#14__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/14) Update to Cake.Issues 0.2.0 - -__Improvements__ - -- [__#9__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/9) Migrate to .NET Core -- [__#2__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/2) Check if pull request is still on the same commit before posting issues - - -## 0.1.0 (September 16, 2017) - - -As part of this release we had [2 issues](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues?milestone=1&state=closed) closed. - -__Requirements__ - -- Cake 0.22.0 - Cake 0.25.0 -- Cake.Issues 0.1.x - -__Breaking change__ - -- [__#8__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/8) Update to Cake 0.22 - -__Feature__ - -- [__#1__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/1) First version based on Cake.Prca - - -## 0.1.0-beta.3 (September 13, 2017) - - -As part of this release we had 2 issue closed. - -__Requirements__ - -- Cake 0.22.0 - Cake 0.25.0 -- Cake.Issues 0.1.0-beta.4 - -__Breaking Changes__ - -- Target .NET Framework 4.6 -- Build against Cake 0.22.0 -- Build against Cake.Issues 0.1.0-beta0004 -## 0.1.0-beta.2 (September 03, 2017) - - -As part of this release we had 2 issue closed. - -__Requirements__ - -- Cake 0.16.2 - Cake 0.21.1 -- Cake.Issues 0.1.0-beta.3 - -__Breaking Changes__ - -- Update Cake.Issues to 0.1.0-beta0003 -- Move everything into single namespace -## 0.1.0-beta.1 (September 02, 2017) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.16.2 - Cake 0.21.1 -- Cake.Issues 0.1.0-beta.2 - -__Feature__ - -- [__#1__](https://github.com/cake-contrib/Cake.Issues.PullRequests/issues/1) First version based on Cake.Prca -e provider infrastructure - - -## 0.4.1 (August 03, 2018) - - -As part of this release we had [1 issue](https://github.com/cake-contrib/Cake.Issues/issues?milestone=6&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Feature__ - -- [__#39__](https://github.com/cake-contrib/Cake.Issues/issues/39) Provide infrastructure for issue provider with different formats - - -## 0.4.0 (July 28, 2018) - - -As part of this release we had [3 issues](https://github.com/cake-contrib/Cake.Issues/issues?milestone=5&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- [__#35__](https://github.com/cake-contrib/Cake.Issues/issues/35) Replace `IIssue.Project` with `IIssue.ProjectFileRelativePath` and `IIssue.ProjectName` - -__Improvement__ - -- [__#38__](https://github.com/cake-contrib/Cake.Issues/issues/38) Update XUnit to 2.4.0 - - -## 0.4.0-beta.2 (July 24, 2018) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Improvement__ - -- [__#38__](https://github.com/cake-contrib/Cake.Issues/issues/38) Update XUnit to 2.4.0 - - -## 0.4.0-beta.1 (July 24, 2018) - - -As part of this release we had 2 issues closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- [__#35__](https://github.com/cake-contrib/Cake.Issues/issues/35) Replace `IIssue.Project` with `IIssue.ProjectFileRelativePath` and `IIssue.ProjectName`. -## 0.3.1 (June 20, 2018) - - -As part of this release we had [1 issue](https://github.com/cake-contrib/Cake.Issues/issues?milestone=4&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Feature__ - -- [__#27__](https://github.com/cake-contrib/Cake.Issues/issues/27) Add alias for creating issues from Cake scripts - - -## 0.3.0 (June 03, 2018) - - -As part of this release we had [14 commits](https://github.com/cake-contrib/Cake.Issues/compare/0.2.0...0.3.0) which resulted in [6 issues](https://github.com/cake-contrib/Cake.Issues/issues?milestone=3&state=closed) being closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Breaking changes__ - -- [__#29__](https://github.com/cake-contrib/Cake.Issues/issues/29) Make priority optional -- [__#28__](https://github.com/cake-contrib/Cake.Issues/issues/28) Build against Cake 0.28.0 -- [__#26__](https://github.com/cake-contrib/Cake.Issues/issues/26) Add fluent API for Issue creation -- [__#22__](https://github.com/cake-contrib/Cake.Issues/issues/22) Add PriorityName to IIssue -- [__#21__](https://github.com/cake-contrib/Cake.Issues/issues/21) Add ProviderName to IIssue - -__Feature__ - -- [__#25__](https://github.com/cake-contrib/Cake.Issues/issues/25) Add constants for priority values and names - - -## 0.3.0-beta.4 (June 03, 2018) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Bug Fix__ - -- Fix argument checking in fluent API - -## 0.3.0-beta.3 (June 03, 2018) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Improvement__ - -- Allow default values in fluent API -## 0.3.0-beta.2 (June 01, 2018) - - -As part of this release we had 4 issues closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Breaking changes__ - -- [__#29__](https://github.com/cake-contrib/Cake.Issues/issues/29) Make `IIssue.Priority` optional -- [__#28__](https://github.com/cake-contrib/Cake.Issues/issues/28) Build against Cake 0.28.0 -- [__#26__](https://github.com/cake-contrib/Cake.Issues/issues/26) Add fluent API for Issue creation - -__Feature__ - -- [__#25__](https://github.com/cake-contrib/Cake.Issues/issues/25) Add constants for priority values and names - - -## 0.3.0-beta.1 (May 31, 2018) - - -As part of this release we had 2 issues closed. - -__Requirements__ - -- Cake 0.26.0 or higher -- Targeting .NET Standard 2.0 - -__Breaking changes__ - -- [__#22__](https://github.com/cake-contrib/Cake.Issues/issues/22) Add `PriorityName` to `IIssue` -- [__#21__](https://github.com/cake-contrib/Cake.Issues/issues/21) Add `ProviderName` to `IIssue` - - -## 0.2.0 (May 21, 2018) - - -As part of this release we had [6 issues](https://github.com/cake-contrib/Cake.Issues/issues?milestone=2&state=closed) closed. - -__Requirements__ - -- Cake 0.26.0 or higher -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- [__#13__](https://github.com/cake-contrib/Cake.Issues/issues/13) Build against Cake 0.26.0 - -__Features__ - -- [__#5__](https://github.com/cake-contrib/Cake.Issues/issues/5) Add project to `IIssue` -- [__#4__](https://github.com/cake-contrib/Cake.Issues/issues/4) Migrate to .NET Standard (Thanks [Tim Johnson](https://github.com/t-johnson)!) - -__Improvements__ - -- [__#20__](https://github.com/cake-contrib/Cake.Issues/issues/20) Make `IIssue.Rule` an optional parameter -- [__#8__](https://github.com/cake-contrib/Cake.Issues/issues/8) Upgrade XUnit to 2.3.0 - - -## 0.2.0-beta.4 (March 07, 2018) - - -As part of this release we had the following issues closed. - -__Requirements__ - -- Cake 0.26.0 or higher -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- Only target .NET Standard 2.0 -## 0.2.0-beta.3 (March 07, 2018) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.26.0 or higher -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- [__#13__](https://github.com/cake-contrib/Cake.Issues/issues/13) Build against Cake 0.26.0 -## 0.2.0-beta.2 (December 24, 2017) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.22.0 - Cake 0.25.0 -- Targeting .NET Standard 2.0 - -__Improvements__ - -- [__#8__](https://github.com/cake-contrib/Cake.Issues/issues/8) Upgrade XUnit to 2.3.0 -## 0.2.0-beta.1 (October 15, 2017) - - -As part of this release we had 2 issues closed. - -__Requirements__ - -- Cake 0.22.0 - Cake 0.25.0 -- Targeting .NET Standard 2.0 - -__Features__ - -- [__#5__](https://github.com/cake-contrib/Cake.Issues/issues/5) Add project to `IIssue` -- [__#4__](https://github.com/cake-contrib/Cake.Issues/issues/4) Migrate to .NET Standard (Thanks [Tim Johnson](https://github.com/t-johnson)!) - - -## 0.1.0 (September 16, 2017) - - -As part of this release we had [2 issues](https://github.com/cake-contrib/Cake.Issues/issues?milestone=1&state=closed) closed. - -__Requirements__ - -- Cake 0.22.0 - Cake 0.25.0 -- Targeting .NET Framework 4.6 - -__Breaking change__ - -- [__#3__](https://github.com/cake-contrib/Cake.Issues/issues/3) Update to Cake 0.22 - -__Feature__ - -- [__#2__](https://github.com/cake-contrib/Cake.Issues/issues/2) First version based on Cake.Prca - - -## 0.1.0-beta.4 (September 13, 2017) - - -As part of this release we had 2 issues closed. - -__Requirements__ - -- Cake 0.22.0 - Cake 0.25.0 -- Targeting .NET Framework 4.6 - -__Breaking Changes__ - -- Target .NET Framework 4.6 -- Build against Cake 0.22.0 -## 0.1.0-beta.3 (September 03, 2017) - - -As part of this release we had 2 issues closed. - -__Requirements__ - -- Cake 0.16.2 - Cake 0.21.1 -- Targeting .NET Framework 4.5.2 - -__Breaking Changes__ - -- Move everything into single namespace. -## 0.1.0-beta.2 (September 02, 2017) - - -As part of this release we had 2 issues closed. - -__Requirements__ - -- Cake 0.16.2 - Cake 0.21.1 -- Targeting .NET Framework 4.5.2 - -__Enhancements__ - -- Add method `Issue.GetProviderTypeName()` for returning provider type name -- Put aliases for reading issues in own category -## 0.1.0-beta.1 (September 01, 2017) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.16.2 - Cake 0.21.1 -- Targeting .NET Framework 4.5.2 - -__Feature__ - -- [__#2__](https://github.com/cake-contrib/Cake.Issues/issues/2) First version based on Cake.Prca - - - -- Add method `Issue.GetProviderTypeName()` for returning provider type name -- Put aliases for reading issues in own category -## 0.1.0-beta.1 (September 01, 2017) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.16.2 - Cake 0.21.1 -- Targeting .NET Framework 4.5.2 - -__Feature__ - -- [__#2__](https://github.com/cake-contrib/Cake.Issues/issues/2) First version based on Cake.Prca - - -.2 - -__Feature__ - -- [__#2__](https://github.com/cake-contrib/Cake.Issues/issues/2) First version based on Cake.Prca - - diff --git a/docs/input/docs/overview/release-notes/Cake.Issues.Reporting.md b/docs/input/docs/overview/release-notes/Cake.Issues.Reporting.md deleted file mode 100644 index 43a06ec24..000000000 --- a/docs/input/docs/overview/release-notes/Cake.Issues.Reporting.md +++ /dev/null @@ -1,1036 +0,0 @@ ---- -Title: Cake.Issues.Reporting Release Notes -Description: Release notes for Cake.Issues.Reporting ---- -

    -

    -

    -Starting with Cake.Issues 1.0, release notes for Cake.Issues.Reporting will be listed with Cake.Issues Release Notes. -The release notes on this page are only for versions of Cake.Issues.Reporting prior to 1.0. -

    -
    -

    - -## 0.9.0 (August 22, 2020) - - -As part of this release we had [1 issue](https://github.com/cake-contrib/Cake.Issues.Reporting/milestone/11?closed=1) closed. - -__Requirements__ - -- Cake 0.33.0 or higher -- Cake.Issues 0.9.x -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- [__#115__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/115) Update to Cake.Issues 0.9.0 - - -## 0.9.0-beta.2 (August 01, 2020) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.33.0 or higher -- Cake.Issues 0.9.0-beta0004 -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- Update to Cake.Issues 0.9.0-beta0004 - - -## 0.9.0-beta.1 (July 12, 2020) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.33.0 or higher -- Cake.Issues 0.9.0-beta0002 -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- [__#115__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/115) Update to Cake.Issues 0.9.0 - - -## 0.8.0 (October 17, 2019) - - -As part of this release we had [2 issues](https://github.com/cake-contrib/Cake.Issues.Reporting/milestone/10?closed=1) closed. - -__Requirements__ - -- Cake 0.33.0 or higher -- Cake.Issues 0.8.0 -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- [__#85__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/85) Update to Cake.Issues 0.8.0 - -__Improvement__ - -- [__#89__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/89) Embed NuGet package icon - - -## 0.8.0-beta.1 (October 11, 2019) - - -As part of this release we had [1 issue](https://github.com/cake-contrib/Cake.Issues.Reporting/milestone/10?closed=1) closed. - -__Requirements__ - -- Cake 0.33.0 or higher -- Cake.Issues 0.8.0-beta.1 -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- [__#85__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/85) Update to Cake.Issues 0.8.0 - - -## 0.7.0 (May 30, 2019) - - -As part of this release we had [2 issues](https://github.com/cake-contrib/Cake.Issues.Reporting/milestone/9?closed=1) closed. - -__Requirements__ - -- Cake 0.33.0 or higher -- Cake.Issues 0.7.x -- Targeting .NET Standard 2.0 - -__Breaking changes__ - -- [__#53__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/53) Update to Cake.Issues 0.7.0 -- [__#52__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/52) Build against Cake 0.33.0 - - -## 0.7.0-beta.1 (April 19, 2019) - - -As part of this release we had 2 issues closed. - -__Requirements__ - -- Cake 0.33.0 or higher -- Cake.Issues 0.7.x -- Targeting .NET Standard 2.0 - -__Breaking changes__ - -- [__#53__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/53) Update to Cake.Issues 0.7.0 -- [__#52__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/52) Build against Cake 0.33.0 - - -## 0.6.1 (December 01, 2018) - - -As part of this release we had [1 issue](https://github.com/cake-contrib/Cake.Issues.Reporting/issues?milestone=8&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.6.x -- Targeting .NET Standard 2.0 - -__Feature__ - -- [__#5__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/5) Migrate to .NET Standard (Thanks [Vadim Hatsura](https://github.com/vhatsura)) - - -## 0.6.0 (August 24, 2018) - - -As part of this release we had [1 issue](https://github.com/cake-contrib/Cake.Issues.Reporting/issues?milestone=7&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.6.x - -__Breaking change__ - -- [__#26__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/26) Update to Cake.Issues 0.6.0 - - -## 0.6.0-beta.2 (August 20, 2018) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.6.0-beta.2 - -__Breaking change__ - -- Update to Cake.Issues 0.6.0 Beta 2 - - -## 0.6.0-beta.1 (August 19, 2018) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.6.0-beta.1 - -__Breaking change__ - -- [__#26__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/26) Update to Cake.Issues 0.6.0 - - -## 0.5.0 (August 17, 2018) - - -As part of this release we had [2 issues](https://github.com/cake-contrib/Cake.Issues.Reporting/issues?milestone=6&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.5.x - -__Breaking change__ - -- [__#23__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/23) Update to Cake.Issues 0.5.0 - -__Improvement__ - -- [__#25__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/25) Add repository metadata to nuspec - - -## 0.5.0-beta.1 (August 07, 2018) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.5.0-beta.2 - -__Breaking change__ - -- [__#23__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/23) Update to Cake.Issues 0.5.0 - - -## 0.4.0 (July 28, 2018) - - -As part of this release we had [2 issues](https://github.com/cake-contrib/Cake.Issues.Reporting/issues?milestone=5&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.4.x - -__Breaking change__ - -- [__#21__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/21) Update to Cake.Issues 0.4.0 - - -## 0.4.0-beta.2 (July 25, 2018) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.4.0-beta.2 - -__Breaking change__ - -- Update Cake.Issues to 0.4.0-beta.2 - - -## 0.4.0-beta.1 (July 24, 2018) - - -As part of this release we had 2 issues closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.4.0-beta.1 - -__Breaking change__ - -- [__#21__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/21) Update to Cake.Issues 0.4.0 - - -## 0.3.0 (June 04, 2018) - - -As part of this release we had [2 issues](https://github.com/cake-contrib/Cake.Issues.Reporting/issues?milestone=4&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.3.x - -__Breaking changes__ - -- [__#17__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/17) Build against Cake 0.28.0 -- [__#15__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/15) Update to Cake.Issues 0.3.0 - - -## 0.3.0-beta.2 (June 01, 2018) - - -As part of this release we had 2 issues closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Cake.Issues 0.3.0-beta.2 - -__Breaking changes__ - -- [__#17__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/17) Build against Cake 0.28.0 -- Update to Cake.Issues 0.3.0-beta.2 - -## 0.3.0-beta.1 (May 31, 2018) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.26.0 or higher -- Cake.Issues 0.3.0-beta.1 - -__Breaking change__ - -- [__#15__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/15) Update to Cake.Issues 0.3.0 - - -## 0.2.1 (May 25, 2018) - - -As part of this release we had [1 issue](https://github.com/cake-contrib/Cake.Issues.Reporting/issues?milestone=3&state=closed) closed. - -__Requirements__ - -- Cake 0.26.0 or higher -- Cake.Issues 0.2.x - -__Documentation__ - -- [__#13__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/13) Update examples to current version of Cake.Issues.Reporting.Generic - - -## 0.2.0 (May 23, 2018) - - -As part of this release we had [3 issues](https://github.com/cake-contrib/Cake.Issues.Reporting/issues?milestone=2&state=closed) closed. - -__Requirements__ - -- Cake 0.26.0 or higher -- Cake.Issues 0.2.x - -__Breaking changes__ - -- [__#10__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/10) Build against Cake 0.26.0 -- [__#9__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/9) Update to Cake.Issues 0.2.0 - - -## 0.2.0-beta.2 (May 23, 2018) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.26.0 or higher -- Cake.Issues 0.2.x - -__Breaking changes__ - -- Target .NET Framework 4.6.1 instead of 4.62 - - -## 0.2.0-beta.1 (May 23, 2018) - - -As part of this release we had 3 issues closed. - -__Requirements__ - -- Cake 0.26.0 or higher -- Cake.Issues 0.2.x - -__Breaking changes__ - -- [__#10__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/10) Build against Cake 0.26.0 -- [__#9__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/9) Update to Cake.Issues 0.2.0 - - -## 0.1.0 (October 16, 2017) - - -As part of this release we had [2 issues](https://github.com/cake-contrib/Cake.Issues.Reporting/issues?milestone=1&state=closed) closed. - -__Requirements__ - -- Cake 0.22.0 - Cake 0.25.0 -- Cake.Issues 0.1.0 - -__Breaking change__ - -- [__#3__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/3) Update to Cake 0.22 - -__Feature__ - -- [__#1__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/1) Basic implementation - - -## 0.1.0-beta.6 (September 16, 2017) - - -As part of this release we had 2 issue closed. - -__Requirements__ - -- Cake 0.22.0 - Cake 0.25.0 -- Cake.Issues 0.1.0 - -__Breaking Changes__ - -- Build against Cake.Issues 0.1.0 - -__Features__ - -- Add alias for single issue provider -## 0.1.0-beta.5 (September 13, 2017) - - -As part of this release we had 3 issue closed. - -__Requirements__ - -- Cake 0.22.0 - Cake 0.25.0 -- Cake.Issues 0.1.0-beta.4 - -__Breaking Changes__ - -- Target .NET Framework 4.6 -- Build against Cake 0.22.0 -- Build against Cake.Issues 0.1.0-beta0004 -## 0.1.0-beta.4 (September 10, 2017) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.16.2 - Cake 0.21.1 -- Cake.Issues 0.1.0-beta.3 - -__Breaking Changes__ - -- Add `CreateIssueReportSettings` and requirement to pass in output file path -## 0.1.0-beta.3 (September 10, 2017) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.16.2 - Cake 0.21.1 -- Cake.Issues 0.1.0-beta.3 - -__Breaking Changes__ - -- Update Cake.Issues to 0.1.0-beta0003 -## 0.1.0-beta.2 (September 09, 2017) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.16.2 - Cake 0.21.1 -- Cake.Issues 0.1.0-beta.1 - -__Feature__ - -- Move everything into single namespace -## 0.1.0-beta.1 (September 09, 2017) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.16.2 - Cake 0.21.1 -- Cake.Issues 0.1.0-beta.1 - -__Feature__ - -- [__#1__](https://github.com/cake-contrib/Cake.Issues.Reporting/issues/1) Basic implementation - - -https://github.com/cake-contrib/Cake.Issues/issues/97) XML comment for `IIssue.ProjectFileRelativePath` mentions `string.Empty` as valid value - - -## 0.6.2 (September 05, 2018) - - -As part of this release we had [3 issues](https://github.com/cake-contrib/Cake.Issues/issues?milestone=10&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Bug__ - -- [__#60__](https://github.com/cake-contrib/Cake.Issues/issues/60) `ByteArrayExtensions.ToStringUsingEncoding` throws an exception if empty byte array is passed - -__Improvements__ - -- [__#62__](https://github.com/cake-contrib/Cake.Issues/issues/62) `ToStringUsingEncoding` should not throw if no preamble exists -- [__#46__](https://github.com/cake-contrib/Cake.Issues/issues/46) Add test cases for `Cake.Issues.Testing` - - -## 0.6.2-beta.2 (September 05, 2018) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Improvement__ - -- [__#46__](https://github.com/cake-contrib/Cake.Issues/issues/46) Add test cases for Cake.Issues.Testing - - -## 0.6.2-beta.1 (September 04, 2018) - - -As part of this release we had 2 issues closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Bug__ - -- [__#60__](https://github.com/cake-contrib/Cake.Issues/issues/60) ByteArrayExtensions.ToStringUsingEncoding throws an exception if empty byte array is passed - -__Improvement__ - -- [__#62__](https://github.com/cake-contrib/Cake.Issues/issues/62) ToStringUsingEncoding should not throw if no preamble exists - - -## 0.6.1 (September 02, 2018) - - -As part of this release we had [2 issues](https://github.com/cake-contrib/Cake.Issues/issues?milestone=9&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Features__ - -- [__#57__](https://github.com/cake-contrib/Cake.Issues/issues/57) Add method for replacing issues tokens in string -- [__#56__](https://github.com/cake-contrib/Cake.Issues/issues/56) Add extensions for `IIssue` project and file - - -## 0.6.1-beta.1 (August 26, 2018) - - -As part of this release we had 2 issues closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Features__ - -- [__#57__](https://github.com/cake-contrib/Cake.Issues/issues/57) Add method for replacing issues tokens in string -- [__#56__](https://github.com/cake-contrib/Cake.Issues/issues/56) Add extensions for `IIssue` project and file - - -## 0.6.0 (August 24, 2018) - - -As part of this release we had [3 issues](https://github.com/cake-contrib/Cake.Issues/issues?milestone=8&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Breaking changes__ - -- [__#54__](https://github.com/cake-contrib/Cake.Issues/issues/54) `BaseMultiFormatIssueProvider.ReadIssues` ignores format -- [__#50__](https://github.com/cake-contrib/Cake.Issues/issues/50) Add method to check if initialized was called on `BaseIssueComponent` - -__Bug__ - -- [__#53__](https://github.com/cake-contrib/Cake.Issues/issues/53) Typo in comment for `BaseMultiFormatIssueProvider` - - -## 0.6.0-beta.2 (August 19, 2018) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- [__#54__](https://github.com/cake-contrib/Cake.Issues/issues/54) BaseMultiFormatIssueProvider.ReadIssues ignores format -## 0.6.0-beta.1 (August 18, 2018) - - -As part of this release we had 2 issues closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- [__#50__](https://github.com/cake-contrib/Cake.Issues/issues/50) Add method to check if initialized was called on BaseIssueComponent - -__Bug__ - -- [__#53__](https://github.com/cake-contrib/Cake.Issues/issues/53) Typo in comment for BaseMultiFormatIssueProvider - - -## 0.5.0 (August 17, 2018) - - -As part of this release we had [4 issues](https://github.com/cake-contrib/Cake.Issues/issues?milestone=7&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- [__#44__](https://github.com/cake-contrib/Cake.Issues/issues/44) Improve issue provider infrastructure - -__Features__ - -- [__#48__](https://github.com/cake-contrib/Cake.Issues/issues/48) Add helper for string / byte array conversion -- [__#47__](https://github.com/cake-contrib/Cake.Issues/issues/47) Add helper for working with embedded resources on file system - -__Improvement__ - -- [__#49__](https://github.com/cake-contrib/Cake.Issues/issues/49) Add repository metadata to nuspec - - -## 0.5.0-beta.3 (August 17, 2018) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Improvement__ - -- [__#49__](https://github.com/cake-contrib/Cake.Issues/issues/49) Add repository metadata to nuspec - - -## 0.5.0-beta.2 (August 06, 2018) - - -As part of this release we had 2 issues closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Features__ - -- [__#48__](https://github.com/cake-contrib/Cake.Issues/issues/48) Add helper for string / byte array conversion -- [__#47__](https://github.com/cake-contrib/Cake.Issues/issues/47) Add helper for working with embedded resources on file system - - -## 0.5.0-beta.1 (August 05, 2018) - - -As part of this release we had [1 issue](https://github.com/cake-contrib/Cake.Issues/issues?milestone=7&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- [__#44__](https://github.com/cake-contrib/Cake.Issues/issues/44) Improve issue provider infrastructure - - -## 0.4.1 (August 03, 2018) - - -As part of this release we had [1 issue](https://github.com/cake-contrib/Cake.Issues/issues?milestone=6&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Feature__ - -- [__#39__](https://github.com/cake-contrib/Cake.Issues/issues/39) Provide infrastructure for issue provider with different formats - - -## 0.4.0 (July 28, 2018) - - -As part of this release we had [3 issues](https://github.com/cake-contrib/Cake.Issues/issues?milestone=5&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- [__#35__](https://github.com/cake-contrib/Cake.Issues/issues/35) Replace `IIssue.Project` with `IIssue.ProjectFileRelativePath` and `IIssue.ProjectName` - -__Improvement__ - -- [__#38__](https://github.com/cake-contrib/Cake.Issues/issues/38) Update XUnit to 2.4.0 - - -## 0.4.0-beta.2 (July 24, 2018) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Improvement__ - -- [__#38__](https://github.com/cake-contrib/Cake.Issues/issues/38) Update XUnit to 2.4.0 - - -## 0.4.0-beta.1 (July 24, 2018) - - -As part of this release we had 2 issues closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- [__#35__](https://github.com/cake-contrib/Cake.Issues/issues/35) Replace `IIssue.Project` with `IIssue.ProjectFileRelativePath` and `IIssue.ProjectName`. -## 0.3.1 (June 20, 2018) - - -As part of this release we had [1 issue](https://github.com/cake-contrib/Cake.Issues/issues?milestone=4&state=closed) closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Feature__ - -- [__#27__](https://github.com/cake-contrib/Cake.Issues/issues/27) Add alias for creating issues from Cake scripts - - -## 0.3.0 (June 03, 2018) - - -As part of this release we had [14 commits](https://github.com/cake-contrib/Cake.Issues/compare/0.2.0...0.3.0) which resulted in [6 issues](https://github.com/cake-contrib/Cake.Issues/issues?milestone=3&state=closed) being closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Breaking changes__ - -- [__#29__](https://github.com/cake-contrib/Cake.Issues/issues/29) Make priority optional -- [__#28__](https://github.com/cake-contrib/Cake.Issues/issues/28) Build against Cake 0.28.0 -- [__#26__](https://github.com/cake-contrib/Cake.Issues/issues/26) Add fluent API for Issue creation -- [__#22__](https://github.com/cake-contrib/Cake.Issues/issues/22) Add PriorityName to IIssue -- [__#21__](https://github.com/cake-contrib/Cake.Issues/issues/21) Add ProviderName to IIssue - -__Feature__ - -- [__#25__](https://github.com/cake-contrib/Cake.Issues/issues/25) Add constants for priority values and names - - -## 0.3.0-beta.4 (June 03, 2018) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Bug Fix__ - -- Fix argument checking in fluent API - -## 0.3.0-beta.3 (June 03, 2018) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Improvement__ - -- Allow default values in fluent API -## 0.3.0-beta.2 (June 01, 2018) - - -As part of this release we had 4 issues closed. - -__Requirements__ - -- Cake 0.28.0 or higher -- Targeting .NET Standard 2.0 - -__Breaking changes__ - -- [__#29__](https://github.com/cake-contrib/Cake.Issues/issues/29) Make `IIssue.Priority` optional -- [__#28__](https://github.com/cake-contrib/Cake.Issues/issues/28) Build against Cake 0.28.0 -- [__#26__](https://github.com/cake-contrib/Cake.Issues/issues/26) Add fluent API for Issue creation - -__Feature__ - -- [__#25__](https://github.com/cake-contrib/Cake.Issues/issues/25) Add constants for priority values and names - - -## 0.3.0-beta.1 (May 31, 2018) - - -As part of this release we had 2 issues closed. - -__Requirements__ - -- Cake 0.26.0 or higher -- Targeting .NET Standard 2.0 - -__Breaking changes__ - -- [__#22__](https://github.com/cake-contrib/Cake.Issues/issues/22) Add `PriorityName` to `IIssue` -- [__#21__](https://github.com/cake-contrib/Cake.Issues/issues/21) Add `ProviderName` to `IIssue` - - -## 0.2.0 (May 21, 2018) - - -As part of this release we had [6 issues](https://github.com/cake-contrib/Cake.Issues/issues?milestone=2&state=closed) closed. - -__Requirements__ - -- Cake 0.26.0 or higher -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- [__#13__](https://github.com/cake-contrib/Cake.Issues/issues/13) Build against Cake 0.26.0 - -__Features__ - -- [__#5__](https://github.com/cake-contrib/Cake.Issues/issues/5) Add project to `IIssue` -- [__#4__](https://github.com/cake-contrib/Cake.Issues/issues/4) Migrate to .NET Standard (Thanks [Tim Johnson](https://github.com/t-johnson)!) - -__Improvements__ - -- [__#20__](https://github.com/cake-contrib/Cake.Issues/issues/20) Make `IIssue.Rule` an optional parameter -- [__#8__](https://github.com/cake-contrib/Cake.Issues/issues/8) Upgrade XUnit to 2.3.0 - - -## 0.2.0-beta.4 (March 07, 2018) - - -As part of this release we had the following issues closed. - -__Requirements__ - -- Cake 0.26.0 or higher -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- Only target .NET Standard 2.0 -## 0.2.0-beta.3 (March 07, 2018) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.26.0 or higher -- Targeting .NET Standard 2.0 - -__Breaking change__ - -- [__#13__](https://github.com/cake-contrib/Cake.Issues/issues/13) Build against Cake 0.26.0 -## 0.2.0-beta.2 (December 24, 2017) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.22.0 - Cake 0.25.0 -- Targeting .NET Standard 2.0 - -__Improvements__ - -- [__#8__](https://github.com/cake-contrib/Cake.Issues/issues/8) Upgrade XUnit to 2.3.0 -## 0.2.0-beta.1 (October 15, 2017) - - -As part of this release we had 2 issues closed. - -__Requirements__ - -- Cake 0.22.0 - Cake 0.25.0 -- Targeting .NET Standard 2.0 - -__Features__ - -- [__#5__](https://github.com/cake-contrib/Cake.Issues/issues/5) Add project to `IIssue` -- [__#4__](https://github.com/cake-contrib/Cake.Issues/issues/4) Migrate to .NET Standard (Thanks [Tim Johnson](https://github.com/t-johnson)!) - - -## 0.1.0 (September 16, 2017) - - -As part of this release we had [2 issues](https://github.com/cake-contrib/Cake.Issues/issues?milestone=1&state=closed) closed. - -__Requirements__ - -- Cake 0.22.0 - Cake 0.25.0 -- Targeting .NET Framework 4.6 - -__Breaking change__ - -- [__#3__](https://github.com/cake-contrib/Cake.Issues/issues/3) Update to Cake 0.22 - -__Feature__ - -- [__#2__](https://github.com/cake-contrib/Cake.Issues/issues/2) First version based on Cake.Prca - - -## 0.1.0-beta.4 (September 13, 2017) - - -As part of this release we had 2 issues closed. - -__Requirements__ - -- Cake 0.22.0 - Cake 0.25.0 -- Targeting .NET Framework 4.6 - -__Breaking Changes__ - -- Target .NET Framework 4.6 -- Build against Cake 0.22.0 -## 0.1.0-beta.3 (September 03, 2017) - - -As part of this release we had 2 issues closed. - -__Requirements__ - -- Cake 0.16.2 - Cake 0.21.1 -- Targeting .NET Framework 4.5.2 - -__Breaking Changes__ - -- Move everything into single namespace. -## 0.1.0-beta.2 (September 02, 2017) - - -As part of this release we had 2 issues closed. - -__Requirements__ - -- Cake 0.16.2 - Cake 0.21.1 -- Targeting .NET Framework 4.5.2 - -__Enhancements__ - -- Add method `Issue.GetProviderTypeName()` for returning provider type name -- Put aliases for reading issues in own category -## 0.1.0-beta.1 (September 01, 2017) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.16.2 - Cake 0.21.1 -- Targeting .NET Framework 4.5.2 - -__Feature__ - -- [__#2__](https://github.com/cake-contrib/Cake.Issues/issues/2) First version based on Cake.Prca - - -d `Issue.GetProviderTypeName()` for returning provider type name -- Put aliases for reading issues in own category -## 0.1.0-beta.1 (September 01, 2017) - - -As part of this release we had 1 issue closed. - -__Requirements__ - -- Cake 0.16.2 - Cake 0.21.1 -- Targeting .NET Framework 4.5.2 - -__Feature__ - -- [__#2__](https://github.com/cake-contrib/Cake.Issues/issues/2) First version based on Cake.Prca - - -_ - -- [__#2__](https://github.com/cake-contrib/Cake.Issues/issues/2) First version based on Cake.Prca - - diff --git a/docs/input/docs/overview/release-notes/index.cshtml b/docs/input/docs/overview/release-notes/index.cshtml deleted file mode 100644 index cbb6d5a8f..000000000 --- a/docs/input/docs/overview/release-notes/index.cshtml +++ /dev/null @@ -1,11 +0,0 @@ ---- -Order: 30 -Description: Release notes for the Cake Issues core addins. ---- - -

    - For addin release notes see Issue Providers, - Report Formats and Pull Request Systems. -

    - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/overview/requirements.md b/docs/input/docs/overview/requirements.md deleted file mode 100644 index 901eb33c4..000000000 --- a/docs/input/docs/overview/requirements.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -Order: 30 -Description: Requirements for using Cake.Issues. ---- -The requirements for core addins are listed in the release notes for any specific version: - -* [Release notes Cake.Issues] -* [Release notes Cake.Issues.PullRequests] -* [Release notes Cake.Issues.Reporting] - -:::{.alert .alert-info} -Note that individual addins might require a newer version of Cake. -Please see in the documentation of the specific addin for additional requirements for individual addins. -::: - -[Release notes Cake.Issues]: release-notes/Cake.Issues -[Release notes Cake.Issues.PullRequests]: release-notes/Cake.Issues.PullRequests -[Release notes Cake.Issues.Reporting]: release-notes/Cake.Issues.Reporting \ No newline at end of file diff --git a/docs/input/docs/pull-request-systems/appveyor/examples/index.cshtml b/docs/input/docs/pull-request-systems/appveyor/examples/index.cshtml deleted file mode 100644 index f0d5372ef..000000000 --- a/docs/input/docs/pull-request-systems/appveyor/examples/index.cshtml +++ /dev/null @@ -1,12 +0,0 @@ ---- -Title: Examples -Description: Examples for using the Cake.Issues.PullRequests.AppVeyor addin. ---- -

    @Html.Raw(Model.String(DocsKeys.Description))

    - -
    -There's a demo repository -available which you can fork and to which you can create pull requests to test the integration functionality. -
    - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/pull-request-systems/appveyor/features.md b/docs/input/docs/pull-request-systems/appveyor/features.md deleted file mode 100644 index 68211906f..000000000 --- a/docs/input/docs/pull-request-systems/appveyor/features.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -Order: 20 -Title: Features -Description: Features of the Cake.Issues.PullRequests.AppVeyor addin. ---- -The [Cake.Issues.PullRequests.AppVeyor addin] reports issues as messages to AppVeyor builds. - -![AppVeyor messages](appveyor-messages.png "AppVeyor messages") - -:::{.alert .alert-info} -There's a [demo repository] available which you can fork and to which you can create pull requests to test the integration functionality. -::: - -# Basic features - -* Reports issues as messages to AppVeyor builds. -* Messages can be written as comment to GitHub pull requests. - See [GitHub pull request integration] for an example. - -# Supported capabilities - -The [Cake.Issues.PullRequests.AppVeyor addin] doesn't support any additional capabilities. - -| | Capability | Remarks | -|--------------------------------------------------------------------|--------------------------------|--------------------------------| -| | Checking commit ID | | -| | Discussion threads | | -| | Filtering by modified files | | - -[demo repository]: https://github.com/pascalberger/Cake.Issues-Demo -[Cake.Issues.PullRequests.AppVeyor addin]: https://www.nuget.org/packages/Cake.Issues.PullRequests.AppVeyor -[GitHub pull request integration]: ./examples/github-pullrequest-integration diff --git a/docs/input/docs/pull-request-systems/appveyor/index.cshtml b/docs/input/docs/pull-request-systems/appveyor/index.cshtml deleted file mode 100644 index f704df063..000000000 --- a/docs/input/docs/pull-request-systems/appveyor/index.cshtml +++ /dev/null @@ -1,10 +0,0 @@ ---- -Title: AppVeyor -Description: Support for AppVeyor. ---- -

    - 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 deleted file mode 100644 index 446b03b69..000000000 --- a/docs/input/docs/pull-request-systems/appveyor/requirements.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -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/examples/index.cshtml b/docs/input/docs/pull-request-systems/azure-devops/examples/index.cshtml deleted file mode 100644 index 17e2702db..000000000 --- a/docs/input/docs/pull-request-systems/azure-devops/examples/index.cshtml +++ /dev/null @@ -1,12 +0,0 @@ ---- -Title: Examples -Description: Examples for using the Cake.Issues.PullRequests.AzureDevOps addin. ---- -

    @Html.Raw(Model.String(DocsKeys.Description))

    - -
    -There's a demo repository -available which you can fork and to which you can create pull requests to test the integration functionality. -
    - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/pull-request-systems/azure-devops/features.md b/docs/input/docs/pull-request-systems/azure-devops/features.md deleted file mode 100644 index b3b4bc228..000000000 --- a/docs/input/docs/pull-request-systems/azure-devops/features.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -Order: 20 -Title: Features -Description: Features of the Cake.Issues.PullRequests.AzureDevOps addin. ---- -The [Cake.Issues.PullRequests.AzureDevOps addin] provides the following features. - -:::{.alert .alert-info} -There's a [demo repository] available which you can fork and to which you can create pull requests to test the integration functionality. -::: - -# Basic features - -* Writes issues as comments to [Azure DevOps] pull requests. -* Identification of pull requests through source branch or pull request ID. -* Comments written by the addin will be rendered with a specific icon corresponding to the state of the issue. -* Adds rule number and, if provided by the issue provider, link to the rule description to the comment. -* Support for issues messages formatted in Markdown format. - -# Supported capabilities - -The [Cake.Issues.PullRequests.AzureDevOps addin] supports all [Core features]. - -| | Capability | Remarks | -|--------------------------------------------------------------------|--------------------------------|--------------------------------| -| | Checking commit ID | | -| | Discussion threads | | -| | Filtering by modified files | | - -# Supported authentication methods - -| Azure DevOps Server | Azure DevOps Service | Authentication method | -|--------------------------------------------------------------------|--------------------------------------------------------------------|--------------------------------| -| | | NTLM | -| | | Basic authentication | -| | | Personal access token | -| | | OAuth | -| | | Azure Active Directory | - -For detailed instructions how to connect using the different methods see [Setup instructions]. - -![Cake.Issues.PullRequests.AzureDevOps](cake.issues.pullrequests.azuredevops.png "Cake.Issues.PullRequests.AzureDevOps") - -[demo repository]: https://dev.azure.com/pberger/Cake.Issues-Demo -[Cake.Issues.PullRequests.AzureDevOps addin]: https://www.nuget.org/packages/Cake.Issues.PullRequests.AzureDevOps -[Azure DevOps]: https://azure.microsoft.com/en-us/services/devops/ -[Core features]: ../../overview/features#supported-core-functionality -[Setup instructions]: setup diff --git a/docs/input/docs/pull-request-systems/azure-devops/index.cshtml b/docs/input/docs/pull-request-systems/azure-devops/index.cshtml deleted file mode 100644 index fbf68afda..000000000 --- a/docs/input/docs/pull-request-systems/azure-devops/index.cshtml +++ /dev/null @@ -1,10 +0,0 @@ ---- -Title: Azure DevOps -Description: Support for Azure DevOps. ---- -

    - 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 deleted file mode 100644 index 9c245110d..000000000 --- a/docs/input/docs/pull-request-systems/azure-devops/requirements.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -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/github-actions/examples/index.cshtml b/docs/input/docs/pull-request-systems/github-actions/examples/index.cshtml deleted file mode 100644 index f6edfee20..000000000 --- a/docs/input/docs/pull-request-systems/github-actions/examples/index.cshtml +++ /dev/null @@ -1,7 +0,0 @@ ---- -Title: Examples -Description: Examples for using the Cake.Issues.PullRequests.GitHubActions addin. ---- -

    @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/features.md b/docs/input/docs/pull-request-systems/github-actions/features.md deleted file mode 100644 index 91dea5e3c..000000000 --- a/docs/input/docs/pull-request-systems/github-actions/features.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -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. - -![Pull request integration](githubactions-pullrequest-integration.png "Pull request integration") - -# 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/index.cshtml b/docs/input/docs/pull-request-systems/github-actions/index.cshtml deleted file mode 100644 index aba361913..000000000 --- a/docs/input/docs/pull-request-systems/github-actions/index.cshtml +++ /dev/null @@ -1,10 +0,0 @@ ---- -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 deleted file mode 100644 index e1e66947a..000000000 --- a/docs/input/docs/pull-request-systems/github-actions/requirements.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -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/pull-request-systems/index.cshtml b/docs/input/docs/pull-request-systems/index.cshtml deleted file mode 100644 index d97667a6c..000000000 --- a/docs/input/docs/pull-request-systems/index.cshtml +++ /dev/null @@ -1,7 +0,0 @@ ---- -Order: 70 -Description: Documentation of the different pull request system implementations. ---- -

    @Html.Raw(Model.String(DocsKeys.Description))

    - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/recipe/index.cshtml b/docs/input/docs/recipe/index.cshtml deleted file mode 100644 index 79cf416ec..000000000 --- a/docs/input/docs/recipe/index.cshtml +++ /dev/null @@ -1,7 +0,0 @@ ---- -Order: 40 -Description: Using Cake.Issues addins with a pre-made recipe script. ---- -

    @Html.Raw(Model.String(DocsKeys.Description))

    - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/recipe/usage/index.cshtml b/docs/input/docs/recipe/usage/index.cshtml deleted file mode 100644 index 190abe4f7..000000000 --- a/docs/input/docs/recipe/usage/index.cshtml +++ /dev/null @@ -1,7 +0,0 @@ ---- -Order: 20 -Description: How to use Cake.Issues recipes in your build script. ---- -

    @Html.Raw(Model.String(DocsKeys.Description))

    - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/report-formats/console/index.cshtml b/docs/input/docs/report-formats/console/index.cshtml deleted file mode 100644 index 5003c9001..000000000 --- a/docs/input/docs/report-formats/console/index.cshtml +++ /dev/null @@ -1,12 +0,0 @@ ---- -Title: Console -Description: Report format to print issues to the console. ---- -

    @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 deleted file mode 100644 index 469d4c60c..000000000 --- a/docs/input/docs/report-formats/console/requirements.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -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/features.md b/docs/input/docs/report-formats/generic/features.md deleted file mode 100644 index 247752c6e..000000000 --- a/docs/input/docs/report-formats/generic/features.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -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 deleted file mode 100644 index 801250351..000000000 --- a/docs/input/docs/report-formats/generic/index.cshtml +++ /dev/null @@ -1,12 +0,0 @@ ---- -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 deleted file mode 100644 index e5c917073..000000000 --- a/docs/input/docs/report-formats/generic/requirements.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -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 deleted file mode 100644 index 3c8fd7f2d..000000000 --- a/docs/input/docs/report-formats/generic/templates/.artifactignore +++ /dev/null @@ -1,2 +0,0 @@ -**/* -!*.html \ No newline at end of file diff --git a/docs/input/docs/report-formats/generic/templates/htmldatatable.md b/docs/input/docs/report-formats/generic/templates/htmldatatable.md deleted file mode 100644 index 68653531b..000000000 --- a/docs/input/docs/report-formats/generic/templates/htmldatatable.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -Order: 20 -Title: HTML Data Table -Description: Template for a HTML report containing a rich data table view with sorting and search functionality. ---- -Template for a HTML report containing a rich data table view with sorting and search functionality powered by [Simple-DataTables]. - -![HTML Data Table](htmldatatable01.png "HTML Data Table") - -# Features - -* Separate table for issues of each issue provider. -* Table with `Severity`, `Project`, `Path`, `File`, `Location`, `Rule`, `Message`. -* Each column sortable by user. -* Paged table with possibility for user to change number of entries per page. -* Client-side full text search. -* No internet access required for displaying. - -# Requirements - -* Cake.Issues.Reporting.Generic 0.2.1 or higher - -# Usage - -To create a report using the HTML Data Table template you can use the [GenericIssueReportTemplate.HtmlDataTable] enum value: - -```csharp -CreateIssueReport( - issues, - GenericIssueReportFormatFromEmbeddedTemplate(GenericIssueReportTemplate.HtmlDataTable), - @"c:\repo", - @"c:\report.html"); -``` - -# Options - -This template doesn't support any options. - -# Demos - -* Default - -# Source Code - -:::{.alert .alert-info} -You can use the source code as a template for your [custom template]. -::: - -Source code is available on [GitHub]. - -[Simple-DataTables]: https://github.com/fiduswriter/Simple-DataTables -[GenericIssueReportTemplate.HtmlDataTable]: ../../../../../Cake.Issues.Website/api/Cake.Issues.Reporting.Generic/GenericIssueReportTemplate/62ADE81F -[custom template]: ../examples/custom-template -[GitHub]: https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/src/Cake.Issues.Reporting.Generic/Templates/DataTable.cshtml diff --git a/docs/input/docs/report-formats/generic/templates/htmldiagnostic.md b/docs/input/docs/report-formats/generic/templates/htmldiagnostic.md deleted file mode 100644 index 8e3b8f023..000000000 --- a/docs/input/docs/report-formats/generic/templates/htmldiagnostic.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -Order: 30 -Title: HTML Diagnostic -Description: Template for a HTML report containing a list of all issues with all properties. ---- -Template for a HTML report containing a list of all issues with all properties. - -![HTML Diagnostic](htmldiagnostic01.png "HTML Diagnostic") - -# Features - -* Unstyled table listing all properties of [IIssue] -* No internet access required for displaying. - -# Requirements - -* No additional requirements. - -# Usage - -To create a report using the HTML diagnostic template you can use the [GenericIssueReportTemplate.HtmlDiagnostic] enum value: - -```csharp -CreateIssueReport( - issues, - GenericIssueReportFormatFromEmbeddedTemplate(GenericIssueReportTemplate.HtmlDiagnostic), - @"c:\repo", - @"c:\report.html"); -``` - -# Options - -This template doesn't support any options. - -# Demos - -* Default - -# Source Code - -:::{.alert .alert-info} -You can use the source code as a template for your [custom template]. -::: - -Source code is available on [GitHub]. - -[IIssue]: ../../../../../Cake.Issues.Website/api/Cake.Issues/IIssue/ -[GenericIssueReportTemplate.HtmlDiagnostic]: ../../../../../Cake.Issues.Website/api/Cake.Issues.Reporting.Generic/GenericIssueReportTemplate/4F88BD05 -[custom template]: ../examples/custom-template -[GitHub]: https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/src/Cake.Issues.Reporting.Generic/Templates/Diagnostic.cshtml \ No newline at end of file diff --git a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid.md b/docs/input/docs/report-formats/generic/templates/htmldxdatagrid.md deleted file mode 100644 index d0745306a..000000000 --- a/docs/input/docs/report-formats/generic/templates/htmldxdatagrid.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -Order: 10 -Title: HTML DevExtreme Data Grid -Description: Template for a HTML report containing a rich data grid with sorting, filtering, grouping and search capabilities. ---- -Template for a HTML report containing a rich data grid with sorting, filtering, grouping and search capabilities powered by [DevExtreme]. - -![HTML DevExtreme Data Grid](htmldxdatagrid01.png "HTML DevExtreme Data Grid") - -# Features - -* Table with `Provider`, `Severity`, `Project`, `Path`, `File`, `Location`, `Rule`, `Message` by default. -* Support for grouping by multiple columns by user. -* Total number of issues by each group level. -* Each column sortable by user. -* Data can be filtered by any column by user. -* Paged view. -* Client-side full text search. -* Client-side export to Microsoft Excel or PDF. -* Fully customizable through [options](#options). - -# Requirements - -* Cake.Issues.Reporting.Generic 0.3.1 or higher - -# Usage - -To create a report using the HTML DevExtreme Data Grid template you can use the [GenericIssueReportTemplate.HtmlDxDataGrid] enum value: - -```csharp -CreateIssueReport( - issues, - GenericIssueReportFormatFromEmbeddedTemplate(GenericIssueReportTemplate.HtmlDxDataGrid), - @"c:\repo", - @"c:\report.html"); -``` - -# Options - -See [HtmlDxDataGridOption] for a list of possible options. - -# Demos - -The following demo shows the template with its default options: - -* Default - (Source Code) - -## Themes - -The template supports the teams defined in the [DevExtremeTheme] enumeration which can be set using the [HtmlDxDataGridOption.Theme]: - -```csharp -CreateIssueReport( - issues, - GenericIssueReportFormatFromEmbeddedTemplate( - GenericIssueReportTemplate.HtmlDxDataGrid, - settings => settings.WithOption(HtmlDxDataGridOption.Theme, DevExtremeTheme.MaterialBlueLight)), - @"c:\repo", - @"c:\report.html"); -``` - -* Light Theme - (Source Code) -* Dark Theme - (Source Code) -* Contrast Theme - (Source Code) -* Carmine Theme - (Source Code) -* Dark Moon Theme - (Source Code) -* Soft Blue Theme - (Source Code) -* Dark Violet Theme - (Source Code) -* Green Mist Theme - (Source Code) -* Light Compact Theme - (Source Code) -* Dark Compact Theme - (Source Code) -* Contrast Compact Theme - (Source Code) -* Material Blue Light Theme - (Source Code) -* Material Lime Light Theme - (Source Code) -* Material Orange Light Theme - (Source Code) -* Material Purple Light Theme - (Source Code) -* Material Teal Light Theme - (Source Code) -* Material Blue Dark Theme - (Source Code) -* Material Lime Dark Theme - (Source Code) -* Material Orange Dark Theme - (Source Code) -* Material Purple Dark Theme - (Source Code) -* Material Teal Dark Theme - (Source Code) -* Material Blue Light Compact Theme - (Source Code) -* Material Lime Light Compact Theme - (Source Code) -* Material Orange Light Compact Theme - (Source Code) -* Material Purple Light Compact Theme - (Source Code) -* Material Teal Light Compact Theme - (Source Code) -* Material Blue Dark Compact Theme - (Source Code) -* Material Lime Dark Compact Theme - (Source Code) -* Material Orange Dark Compact Theme - (Source Code) -* Material Purple Dark Compact Theme - (Source Code) -* Material Teal Dark Compact Theme - (Source Code) - -## Column visibility - -Visible columns can be defined using the `ColumnNameVisible` option: - -```csharp -CreateIssueReport( - issues, - GenericIssueReportFormatFromEmbeddedTemplate( - GenericIssueReportTemplate.HtmlDxDataGrid, - settings => settings.WithOption(HtmlDxDataGridOption.LineVisible, false)), - @"c:\repo", - @"c:\report.html"); -``` - -Additional columns can be added using the [HtmlDxDataGridOption.AdditionalColumns] option. - -* Show and hide columns - (Source Code) -* Add additional columns - (Source Code) - -## Sorting - -Sorted columns can be defined using the [HtmlDxDataGridOption.SortedColumns] and the -`ColumnNameSortOder` options: - -```csharp -CreateIssueReport( - issues, - GenericIssueReportFormatFromEmbeddedTemplate( - GenericIssueReportTemplate.HtmlDxDataGrid, - settings => settings - .WithOption(HtmlDxDataGridOption.SortedColumns, new List { ReportColumn.RuleId }) - .WithOption(HtmlDxDataGridOption.RuleIdSortOder, ColumnSortOderDescending )), - @"c:\repo", - @"c:\report.html"); -``` - -* Change sorting - (Source Code) - -## Grouping - -Grouping can be defined using the [HtmlDxDataGridOption.GroupedColumns] option: - -```csharp -CreateIssueReport( - issues, - GenericIssueReportFormatFromEmbeddedTemplate( - GenericIssueReportTemplate.HtmlDxDataGrid, - settings => settings.WithOption(HtmlDxDataGridOption.GroupedColumns, new List { ReportColumn.RuleId })), - @"c:\repo", - @"c:\report.html"); -``` - -* Change grouping - (Source Code) -* Disable grouping - (Source Code) - -## Exporting - -Exporting can be enabled using the [HtmlDxDataGridOption.EnableExporting] option: - -```csharp -CreateIssueReport( - issues, - GenericIssueReportFormatFromEmbeddedTemplate( - GenericIssueReportTemplate.HtmlDxDataGrid, - settings => settings.WithOption(HtmlDxDataGridOption.EnableExporting, true)), - @"c:\repo", - @"c:\report.html"); -``` - -* Enable exporting - (Source Code) -* Microsoft Excel export (*.xlsx) - (Source Code) -* PDF export (*.pdf) - (Source Code) -* Custom export file name - (Source Code) - -## Other features - -* Change title - (Source Code) -* Disable header - (Source Code) -* Disable filtering - (Source Code) -* Disable searching - (Source Code) -* Custom script location and version - (Source Code) - -# Source Code - -:::{.alert .alert-info} -You can use the source code as a template for your [custom template]. -::: - -Source code is available on [GitHub]. - -[DevExtreme]: https://js.devexpress.com -[GenericIssueReportTemplate.HtmlDxDataGrid]: ../../../../../api/Cake.Issues.Reporting.Generic/GenericIssueReportTemplate/0E9E9D94 -[HtmlDxDataGridOption]: ../../../../../api/Cake.Issues.Reporting.Generic/HtmlDxDataGridOption/ -[DevExtremeTheme]: ../../../../../api/Cake.Issues.Reporting.Generic/DevExtremeTheme/ -[HtmlDxDataGridOption.Theme]: ../../../../../api/Cake.Issues.Reporting.Generic/HtmlDxDataGridOption/EA83DCAB -[HtmlDxDataGridOption.AdditionalColumns]: ../../../../../api/Cake.Issues.Reporting.Generic/HtmlDxDataGridOption/F9860912 -[HtmlDxDataGridOption.SortedColumns]: ../../../../../api/Cake.Issues.Reporting.Generic/HtmlDxDataGridOption/D578E453 -[HtmlDxDataGridOption.GroupedColumns]: ../../../../../api/Cake.Issues.Reporting.Generic/HtmlDxDataGridOption/0907599C -[HtmlDxDataGridOption.EnableExporting]: ../../../../../api/Cake.Issues.Reporting.Generic/HtmlDxDataGridOption/1441E285 -[custom template]: ../examples/custom-template -[GitHub]: https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/blob/develop/src/Cake.Issues.Reporting.Generic/Templates/DxDataGrid.cshtml diff --git a/docs/input/docs/report-formats/generic/templates/index.cshtml b/docs/input/docs/report-formats/generic/templates/index.cshtml deleted file mode 100644 index b7e0cc3c3..000000000 --- a/docs/input/docs/report-formats/generic/templates/index.cshtml +++ /dev/null @@ -1,7 +0,0 @@ ---- -Title: Template Gallery -Description: Gallery of available out of the box and 3rd party templates. ---- -

    @Html.Raw(Model.String(DocsKeys.Description))

    - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/report-formats/index.cshtml b/docs/input/docs/report-formats/index.cshtml deleted file mode 100644 index b7df95e01..000000000 --- a/docs/input/docs/report-formats/index.cshtml +++ /dev/null @@ -1,7 +0,0 @@ ---- -Order: 60 -Description: Documentation of the different report format addins. ---- -

    @Html.Raw(Model.String(DocsKeys.Description))

    - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/report-formats/sarif/features.md b/docs/input/docs/report-formats/sarif/features.md deleted file mode 100644 index b2ab2de32..000000000 --- a/docs/input/docs/report-formats/sarif/features.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -Order: 20 -Title: Features -Description: Features of the Cake.Issues.Reporting.Sarif addin. ---- -The [Cake.Issues.Reporting.Sarif addin] provides the following features: - -* Creates SARIF compatible files. -* Supports the following properties in the SARIF report: - * RuleId - * Message - * Kind - * Level - * Location - * RuleUrl - -[Cake.Issues.Reporting.Sarif addin]: https://www.nuget.org/packages/Cake.Issues.Reporting.Sarif diff --git a/docs/input/docs/report-formats/sarif/index.cshtml b/docs/input/docs/report-formats/sarif/index.cshtml deleted file mode 100644 index 55d163ac7..000000000 --- a/docs/input/docs/report-formats/sarif/index.cshtml +++ /dev/null @@ -1,12 +0,0 @@ ---- -Title: Sarif -Description: Report format to create SARIF compatible reports. ---- -

    @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 deleted file mode 100644 index ab7342854..000000000 --- a/docs/input/docs/report-formats/sarif/requirements.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -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/docs/input/docs/resources/index.cshtml b/docs/input/docs/resources/index.cshtml deleted file mode 100644 index 030806012..000000000 --- a/docs/input/docs/resources/index.cshtml +++ /dev/null @@ -1,7 +0,0 @@ ---- -Order: 90 -Description: Resources about Cake.Issues. ---- -

    @Html.Raw(Model.String(DocsKeys.Description))

    - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/thanks.cshtml b/docs/input/docs/thanks.cshtml deleted file mode 100644 index 366ed21e1..000000000 --- a/docs/input/docs/thanks.cshtml +++ /dev/null @@ -1,127 +0,0 @@ ---- -Order: 110 -Title: Thanks -Description: People who brought you Cake Issues ---- - -@* -Based on Code from https://github.com/reactiveui/website - -The MIT License (MIT) - -Copyright (c) 2017 Geoffrey Huntley - -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software is furnished to do so, -subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*@ - -

    Contributors

    - -
    - Listed are GitHub users that have contributed to the following repositories: - Cake.Issues, - Cake.Issues.DocFx, - Cake.Issues.DupFinder, - Cake.Issues.EsLint, - Cake.Issues.GitRepository, - Cake.Issues.InspectCode, - Cake.Issues.Markdownlint, - Cake.Issues.MsBuild, - Cake.Issues.Sarif, - Cake.Issues.PullRequests, - Cake.Issues.PullRequests.AzureDevOps, - Cake.Issues.Reporting, - Cake.Issues.Reporting.Generic and - Cake.Issues.Reporting.Sarif and - Cake.Issues.Reporting.SonarQube and - Cake.Issues.Recipe, - Cake.Issues.Website -
    - -
    - - - - diff --git a/docs/input/docs/usage/creating-issues/index.cshtml b/docs/input/docs/usage/creating-issues/index.cshtml deleted file mode 100644 index 901fac32f..000000000 --- a/docs/input/docs/usage/creating-issues/index.cshtml +++ /dev/null @@ -1,7 +0,0 @@ ---- -Order: 20 -Description: How to create issues using Cake.Issues. ---- -

    @Html.Raw(Model.String(DocsKeys.Description))

    - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/usage/creating-reports/index.cshtml b/docs/input/docs/usage/creating-reports/index.cshtml deleted file mode 100644 index 7fae8a618..000000000 --- a/docs/input/docs/usage/creating-reports/index.cshtml +++ /dev/null @@ -1,11 +0,0 @@ ---- -Order: 40 -Description: How to create reports using Cake.Issues.Reporting. ---- -

    @Html.Raw(Model.String(DocsKeys.Description))

    - -

    - For report format specific examples see Report Format Examples. -

    - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/usage/index.cshtml b/docs/input/docs/usage/index.cshtml deleted file mode 100644 index ecdcaa164..000000000 --- a/docs/input/docs/usage/index.cshtml +++ /dev/null @@ -1,7 +0,0 @@ ---- -Order: 30 -Description: How to obtain, configure, and use Cake.Issues. ---- -

    @Html.Raw(Model.String(DocsKeys.Description))

    - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/usage/reading-issues/index.cshtml b/docs/input/docs/usage/reading-issues/index.cshtml deleted file mode 100644 index 39c8dc63a..000000000 --- a/docs/input/docs/usage/reading-issues/index.cshtml +++ /dev/null @@ -1,11 +0,0 @@ ---- -Order: 30 -Description: How to read issues using Cake.Issues. ---- -

    @Html.Raw(Model.String(DocsKeys.Description))

    - -

    - For issue provider specific examples see Issue Provider Examples. -

    - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/docs/usage/recipe/index.md b/docs/input/docs/usage/recipe/index.md deleted file mode 100644 index db51cae81..000000000 --- a/docs/input/docs/usage/recipe/index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -Order: 10 -Description: How to use the pre-made recipe script. ---- - -Examples how to use Cake.Issues recipes can be found under [Recipe Usage]. - -[Recipe Usage]: /docs/recipe/usage \ No newline at end of file diff --git a/docs/input/docs/usage/reporting-issues-to-pull-requests/index.cshtml b/docs/input/docs/usage/reporting-issues-to-pull-requests/index.cshtml deleted file mode 100644 index 5e39a0942..000000000 --- a/docs/input/docs/usage/reporting-issues-to-pull-requests/index.cshtml +++ /dev/null @@ -1,11 +0,0 @@ ---- -Order: 50 -Description: How to report issues to pull requests using Cake.Issues.PullRequests. ---- -

    @Html.Raw(Model.String(DocsKeys.Description))

    - -

    - For pull request system specific examples see Pull Request System Examples. -

    - -@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/dsl/index.cshtml b/docs/input/dsl/index.cshtml deleted file mode 100644 index 484704f4a..000000000 --- a/docs/input/dsl/index.cshtml +++ /dev/null @@ -1,74 +0,0 @@ ---- -Title: Reference -NoSidebar: true ---- -

    - This reference guide describes the various methods and properties which you can use directly from inside a Cake build script. - These are implemented as script aliases. -

    - -

    - Click on any alias to get detailed information about parameters and examples how to use the alias. -

    - -@{ - // We should only have one alias here - var aliasGroups = - Documents["DslAliases"] - .Single() - .DocumentList(Keys.GroupDocuments) - .SelectMany(x => x.DocumentList(CodeAnalysisKeys.Members)) - .Where(x => x.String("Kind") == "Method") - .Select(x => new - { - Doc = x, - MethodAlias = x.DocumentList(CodeAnalysisKeys.Attributes).Any(attr => attr.String(CodeAnalysisKeys.Name) == "CakeMethodAliasAttribute"), - PropertyAlias = x.DocumentList(CodeAnalysisKeys.Attributes).Any(attr => attr.String(CodeAnalysisKeys.Name) == "CakePropertyAliasAttribute") - }) - .Where(x => x.MethodAlias || x.PropertyAlias) - .GroupBy(x => x.Doc.DocumentList(CodeAnalysisKeys.Attributes) - .Where(attr => attr.String(CodeAnalysisKeys.Name) == "CakeAliasCategoryAttribute") - .Select(attr => attr.Get(CodeAnalysisKeys.AttributeData).ConstructorArguments.FirstOrDefault().Value) - .FirstOrDefault() as string ?? string.Empty) - .OrderBy(x => x.Key); -} - -@foreach(var aliasGroup in aliasGroups) -{ - string groupName = string.IsNullOrEmpty(aliasGroup.Key) ? "General" : aliasGroup.Key; -

    @groupName

    -
    -
    - - @foreach(var alias in aliasGroup.OrderBy(x => x.Doc.String(CodeAnalysisKeys.DisplayName))) - { - - - - - } -
    - @if(alias.MethodAlias) - { - @Context.GetTypeLink(alias.Doc) - } - else - { - @Context.GetTypeLink(alias.Doc, alias.Doc.String("Name")) - } - - @Html.Raw(alias.Doc.String(CodeAnalysisKeys.Summary)) - @{ - IDocument assemblyDoc = alias.Doc.Document(CodeAnalysisKeys.ContainingAssembly); - if(assemblyDoc != null) - { - -
    - Addin from @Context.GetTypeLink(assemblyDoc) -     - } - } -
    -
    -
    -} \ No newline at end of file diff --git a/docs/input/index.cshtml b/docs/input/index.cshtml deleted file mode 100644 index d7995c017..000000000 --- a/docs/input/index.cshtml +++ /dev/null @@ -1,82 +0,0 @@ ---- -Title: Cake Issues -NoSidebar: true -NoContainer: true -NoGutter: true ---- - -
    -
    -

    Cake Issues

    -

    - Issue Management for the Cake Build System
    -

    - Learn more - Addins - Aliases -
    -
    - -
    -
    -
    - -

    Open-Source

    -

    - Cake Issues is free to use, improve, contribute and distribute. - Source code is available on GitHub under MIT license. -

    -
    -
    - -

    Rich ecosystem

    -

    - Unlike other Cake addins, Cake Issues consists of over 15 different addins, - working together and providing you with over 75 aliases which you can use in your Cake - build scripts to work with issues. -

    -
    -
    - -

    Supports your tooling

    -

    - Read issues from different analyzers, linters or tools. - The growing range of out-of-the-box supported tools include - MSBuild, - JetBrains InspectCode (ReSharper), - ESLint, - Markdownlint, - DocFX. -

    -
    -
    -
    -
    - -

    Reporting

    -

    - Cake Issues provides aliases to create reports from the parsed issues. - There's a generic reporting addin which allows to create reports using out-of-the-box or custom Razor templates - and an addin for creating SARIF compatible files. -

    -
    -
    - -

    Pull request and build workflow integration

    -

    - Issues found on a feature branch can be reported to pull requests or build runs giving developers instant and direct feedback. - There's out of the box support for Azure DevOps, - GitHub Actions and - AppVeyor. -

    -
    -
    - -

    Extensible

    -

    - The addins are built in a modular architecture and are providing different extension points - which allow you to easily enhance it for supporting additional analyzers, linters, report formats and pull request systems. -

    -
    -
    -
    \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml new file mode 100644 index 000000000..210da549b --- /dev/null +++ b/docs/mkdocs.yml @@ -0,0 +1,231 @@ +# Project information +site_name: Cake Issues +site_url: https://cakeissues.net +site_author: Cake Issues Contributors +site_description: Issue Management for the Cake Build System + +# Repository +repo_name: cake-contrib/Cake.Issues +repo_url: https://github.com/cake-contrib/Cake.Issues + +# Copyright +copyright: Copyright © Cake Issues Contributors + +# Build configuration +strict: true +validation: + omitted_files: warn + absolute_links: warn + unrecognized_links: warn + anchors: warn + +# Theme configuration +theme: + name: material + language: en + palette: + # Palette toggle for automatic mode + - media: "(prefers-color-scheme)" + toggle: + icon: material/brightness-auto + name: Switch to light mode + # Palette toggle for light mode + - media: "(prefers-color-scheme: light)" + scheme: default + primary: light blue + toggle: + icon: material/brightness-7 + name: Switch to dark mode + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: deep purple + toggle: + icon: material/brightness-4 + name: Switch to system preference + features: + - content.action.edit + - content.code.copy + - navigation.indexes + - navigation.instant + - navigation.instant.progress + - navigation.tabs + - navigation.tabs.sticky + - search.highlight + - search.suggest + +# Plugins +plugins: + - blog: + post_readtime: true + - search + +# Extensions +markdown_extensions: + - admonition + - attr_list + - md_in_html + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences + - toc: + permalink: true + +# Additional configuration +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/cake-contrib/Cake.Issues + +# Page tree +nav: + - Home: index.md + - News: + - blog/index.md + - Documentation: + - Overview: + - Introduction: documentation/overview/introduction.md + - Features: documentation/overview/features.md + - Requirements: documentation/overview/requirements.md + - Fundamentals: + - Architecture: documentation/fundamentals/architecture.md + - Versioning: documentation/fundamentals/versioning.md + - Recipe: documentation/fundamentals/recipe.md + - Issue Provider: documentation/fundamentals/issue-provider.md + - Report Format: documentation/fundamentals/report-format.md + - Pull Request System: documentation/fundamentals/pull-request-system.md + - Usage: + - documentation/usage/index.md + - Recipe: documentation/usage/recipe/index.md + - Creating Issues: documentation/usage/creating-issues/creating-issues.md + - Reading Issues: + - documentation/usage/reading-issues/index.md + - Reading Issues: documentation/usage/reading-issues/reading-issues.md + - Additional Run Information: documentation/usage/reading-issues/run-information.md + - File Linking: documentation/usage/reading-issues/file-linking.md + - Creating Reports: + - documentation/usage/creating-reports/index.md + - Creating Reports: documentation/usage/creating-reports/creating-reports.md + - Reporting Issues To Pull Requests: + - documentation/usage/reporting-issues-to-pull-requests/index.md + - Report Issues To Pull Requests: documentation/usage/reporting-issues-to-pull-requests/report-issues-to-pull-requests.md + - Custom Issue Filter: documentation/usage/reporting-issues-to-pull-requests/custom-issue-filter.md + - Recipe: + - Overview: documentation/recipe/overview.md + - Usage: + - documentation/recipe/usage/index.md + - Cake.Issues.Recipe: documentation/recipe/usage/using-cake-issues-recipe.md + - Cake.Frosting.Issues.Recipe: documentation/recipe/usage/using-cake-frosting-issues-recipe.md + - Supported Tools: documentation/recipe/supported-tools.md + - Demos: documentation/recipe/demos.md + - Configuration: documentation/recipe/configuration.md + - Tasks: documentation/recipe/tasks.md + - Issue Providers: + - documentation/issue-providers/index.md + - DocFx: + - documentation/issue-providers/docfx/index.md + - Features: documentation/issue-providers/docfx/features.md + - Examples: documentation/issue-providers/docfx/examples.md + - ESLint: + - documentation/issue-providers/eslint/index.md + - Features: documentation/issue-providers/eslint/features.md + - Git Repository: + - documentation/issue-providers/gitrepository/index.md + - Features: documentation/issue-providers/gitrepository/features.md + - Examples: documentation/issue-providers/gitrepository/examples.md + - Rules: + - BinaryFileNotTrackedByLfs: documentation/issue-providers/gitrepository/rules/BinaryFileNotTrackedByLfs.md + - FilePathTooLong: documentation/issue-providers/gitrepository/rules/FilePathTooLong.md + - InspectCode: + - documentation/issue-providers/inspectcode/index.md + - Features: documentation/issue-providers/inspectcode/features.md + - Examples: documentation/issue-providers/inspectcode/examples.md + - markdownlint: + - documentation/issue-providers/markdownlint/index.md + - Features: documentation/issue-providers/markdownlint/features.md + - Examples: documentation/issue-providers/markdownlint/examples.md + - MsBuild: + - documentation/issue-providers/msbuild/index.md + - Features: documentation/issue-providers/msbuild/features.md + - Examples: documentation/issue-providers/msbuild/examples.md + - Terraform: + - documentation/issue-providers/terraform/index.md + - Features: documentation/issue-providers/terraform/features.md + - Report Formats: + - documentation/report-formats/index.md + - Console: + - documentation/report-formats/console/index.md + - Features: documentation/report-formats/console/features.md + - Examples: documentation/report-formats/console/examples.md + - Generic: + - documentation/report-formats/generic/index.md + - Features: documentation/report-formats/generic/features.md + - Examples: + - Embedded Default Template: documentation/report-formats/generic/examples/default-template.md + - Custom Template: documentation/report-formats/generic/examples/custom-template.md + - Template Gallery: + - documentation/report-formats/generic/templates/index.md + - HTML DevExtreme Data Grid: documentation/report-formats/generic/templates/htmldxdatagrid.md + - HTML Data Table: documentation/report-formats/generic/templates/htmldatatable.md + - HTML Diagnostic: documentation/report-formats/generic/templates/htmldiagnostic.md + - Sarif: + - documentation/report-formats/sarif/index.md + - Features: documentation/report-formats/sarif/features.md + - Examples: documentation/report-formats/sarif/examples.md + - Pull Request Systems: + - documentation/pull-request-systems/index.md + - AppVeyor: + - documentation/pull-request-systems/appveyor/index.md + - Features: documentation/pull-request-systems/appveyor/features.md + - Examples: + - documentation/pull-request-systems/appveyor/examples/index.md + - Writing Messages To AppVeyor: documentation/pull-request-systems/appveyor/examples/write-messages.md + - GitHub Pull Request Integration: documentation/pull-request-systems/appveyor/examples/github-pullrequest-integration.md + - Azure DevOps: + - documentation/pull-request-systems/azure-devops/index.md + - Features: documentation/pull-request-systems/azure-devops/features.md + - Setup: documentation/pull-request-systems/azure-devops/setup.md + - Examples: + - documentation/pull-request-systems/azure-devops/examples/index.md + - Using With Pull Request ID: documentation/pull-request-systems/azure-devops/examples/pullrequest-id.md + - Using With Repository Remote URL And Source Branch Name: documentation/pull-request-systems/azure-devops/examples/repository-information.md + - Using With Azure Pipelines: documentation/pull-request-systems/azure-devops/examples/azure-pipelines.md + - GitHub Actions: + - documentation/pull-request-systems/github-actions/index.md + - Features: documentation/pull-request-systems/github-actions/features.md + - Examples: + - Create annotations in GitHub Actions: documentation/pull-request-systems/github-actions/examples/write-annotations.md + - Extending: + - documentation/extending/index.md + - Fundamentals: documentation/extending/fundamentals.md + - Issue Provider: + - Overview: documentation/extending/issue-provider/overview.md + - Alias Categories: documentation/extending/issue-provider/categories.md + - Tutorials: + - Simple Issue Provider: documentation/extending/issue-provider/tutorials/simple.md + - Provider Settings: documentation/extending/issue-provider/tutorials/settings.md + - Multiple Log File Formats: documentation/extending/issue-provider/tutorials/logfile-format.md + - Rule URL Resolving: documentation/extending/issue-provider/tutorials/rule-url-resolving.md + - Helper: documentation/extending/issue-provider/helper.md + - Report Format: + - Overview: documentation/extending/report-format/overview.md + - Alias Categories: documentation/extending/report-format/categories.md + - Pull Request System: + - Overview: documentation/extending/pull-request-system/overview.md + - Alias Categories: documentation/extending/pull-request-system/categories.md + - Testing: documentation/extending/testing.md + - Resources: + - Blog Posts: documentation/resources/blog-posts.md + - Presentations: documentation/resources/presentations.md + - Contributing: + - How To Contribute: documentation/contributing/how-to-contribute.md + - Build Instructions: documentation/contributing/how-to-build.md + - Release Instructions: documentation/contributing/how-to-release.md + - API: https://cakebuild.net/extensions/cake-issues/ \ No newline at end of file diff --git a/tests/Cake.Issues.Reporting.Generic/frosting/build/BuildContext.cs b/tests/Cake.Issues.Reporting.Generic/frosting/build/BuildContext.cs index 6547cbbaf..af71dc2fc 100644 --- a/tests/Cake.Issues.Reporting.Generic/frosting/build/BuildContext.cs +++ b/tests/Cake.Issues.Reporting.Generic/frosting/build/BuildContext.cs @@ -13,7 +13,7 @@ public BuildContext(ICakeContext context) : base(context) { this.RepoRootFolder = context.MakeAbsolute(context.Directory("./../..")); - this.TemplateGalleryFolder = this.RepoRootFolder.Combine("../../docs/input/docs/report-formats/generic/templates"); + this.TemplateGalleryFolder = this.RepoRootFolder.Combine("../../docs/docs/documentation/report-formats/generic/templates"); this.Issues = new List(); } diff --git a/tests/Cake.Issues.Reporting.Generic/script-runner/build.cake b/tests/Cake.Issues.Reporting.Generic/script-runner/build.cake index 8f0d44afc..52556e2bb 100644 --- a/tests/Cake.Issues.Reporting.Generic/script-runner/build.cake +++ b/tests/Cake.Issues.Reporting.Generic/script-runner/build.cake @@ -16,7 +16,7 @@ public class BuildData public BuildData(ICakeContext context) { this.RepoRootFolder = context.MakeAbsolute(context.Directory("./")); - this.TemplateGalleryFolder = this.RepoRootFolder.Combine("../../../docs/input/docs/report-formats/generic/templates"); + this.TemplateGalleryFolder = this.RepoRootFolder.Combine("../../../docs/docs/documentation/report-formats/generic/templates"); this.Issues = new List(); }