From ddcb96ee142ffe0acc8694380e645f70558ba9bf Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Fri, 3 Jan 2025 20:04:20 +0100 Subject: [PATCH] Add news entries --- .../2025-01-03-cake-issues-v5.1.0-released.md | 47 +++++++++++++++++++ .../posts/2025-01-03-tap-issue-provider.md | 36 ++++++++++++++ 2 files changed, 83 insertions(+) create mode 100644 docs/input/news/posts/2025-01-03-cake-issues-v5.1.0-released.md create mode 100644 docs/input/news/posts/2025-01-03-tap-issue-provider.md diff --git a/docs/input/news/posts/2025-01-03-cake-issues-v5.1.0-released.md b/docs/input/news/posts/2025-01-03-cake-issues-v5.1.0-released.md new file mode 100644 index 000000000..d5437941d --- /dev/null +++ b/docs/input/news/posts/2025-01-03-cake-issues-v5.1.0-released.md @@ -0,0 +1,47 @@ +--- +title: Cake Issues v5.1.0 Released +date: 2025-01-03 +categories: + - Release Notes +search: + boost: 0.5 +--- + +Cake Issues version 5.1.0 has been released introducing a new issue provider for Test Anything Protocol (TAP) compatible files. + + + +This post shows the highlights included in this release. +For update instructions skip to [Updating from previous versions](#updating-from-previous-versions). + +❤ 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){target="_blank"} + +## New issue provider for Test Anything Protocol (TAP) files + +A new [Cake.Issues.Tap addin] has been released which adds support for reading issues in [Test Anything Protocol (TAP)]{target="_blank"} format. + +See [New addin for reading TAP files](2025-01-03-tap-issue-provider.md) for details. + +## Improvements for Cake Frosting in Cake Issues Recipe + +[Cake Issues Recipe] for Cake Frosting has been updated to use `Cake.Frosting.AzureDevOps` instead of `Cake.AzureDevOps` allow +more control over dependencies in Cake Frosting builds. + +## Documentation improvements for Cake Frosting + +Examples for Cake Frosting have been added across whole documentation. + +## Updating from previous versions + +Cake.Issues 5.1.0 addins are compatible with any 5.x addins. +To update to the new version bump the version of the specific addins. + +For details see [release notes](https://github.com/cake-contrib/Cake.Issues/releases/tag/5.1.0){target="_blank"} + +[Cake.Issues.Tap addin]: ../../documentation/issue-providers/tap/index.md +[Test Anything Protocol (TAP)]: https://testanything.org/ +[Cake Issues Recipe]: ../../documentation/recipe/index.md diff --git a/docs/input/news/posts/2025-01-03-tap-issue-provider.md b/docs/input/news/posts/2025-01-03-tap-issue-provider.md new file mode 100644 index 000000000..cd488f89f --- /dev/null +++ b/docs/input/news/posts/2025-01-03-tap-issue-provider.md @@ -0,0 +1,36 @@ +--- +title: New addin for reading Test Anything Protocol (TAP) files +date: 2025-01-03 +categories: + - New Addin +search: + boost: 0.5 +--- + +A new [Cake.Issues.Tap addin] has been released which adds support for reading issues in [Test Anything Protocol (TAP)]{target="_blank"} format. + + + +[Test Anything Protocol (TAP)]{target="_blank"} is a protocol for communicating between test logic in a language-agnostic way. +There are several linting tools which can output their result in a TAP compatible format. + +The [Cake.Issues.Tap addin] supports multiple log file formats. +Details, like file, line / column or rule information, are not standardized in Test Anything Protocol (TAP). +The `GenericLogFileFormat` will therefore only return issues containing the description, which might be the file name for some tools. +To retrieve detailed information a tool specific log file format needs to be used which can parse the non-standardized data provided by the tool for every issue. + +There are additional log file formats for the following tools available: + +* [stylelint](https://stylelint.io/){target="_blank"} +* [Textlint](https://textlint.github.io/){target="_blank"} + +See [Supported Tools] for an updated list of supported tools. + +The addins is available in a version for Cake .NET Tool ([Cake.Issues.Tap]{target="_blank"}) +and Cake Frosting ([Cake.Frosting.Issues.Tap]{target="_blank"}). + +[Cake.Issues.Tap addin]: ../../documentation/issue-providers/tap/index.md +[Test Anything Protocol (TAP)]: https://testanything.org/ +[Supported Tools]: ../../documentation/supported-tools.md +[Cake.Issues.Tap]: https://www.nuget.org/packages/Cake.Issues.Tap +[Cake.Frosting.Issues.Tap]: https://www.nuget.org/packages/Cake.Frosting.Issues.Tap