Cake.Issues Release Notes

3.0.0 (July 13, 2023)

As part of this release we had 6 issues closed.

Requirements

  • Cake 3.x
  • Targeting .NET 6 and .NET 7

Breaking changes

  • #304 Update to Cake 3.0 by @pascalberger
  • #303 Multi-Target .NET 6 & 7 instead of .NET Core 3.1, 5 & 6 by @pascalberger
  • #324 Rename IsValideRepositoryFilePath to IsValidRepositoryFilePath by @pascalberger
  • #322 Make BaseRuleDescription.Rule init-only by @pascalberger

Improvement

  • #323 Support contravariance for ILogFileFormat type parameters by @pascalberger
  • #316 Update to LitJson 0.18 by @pascalberger

Chores

  • #275 Update Depandabot configuration to ignore Cake updates < 3.0 by @pascalberger
  • #280 Build using Cake .NET Tool by @pascalberger
  • #282 Update to Cake Recipe 3.0 by @pascalberger
  • #286 Disable coveralls by @pascalberger
  • #285 Update solution file to Visual Studio 2022 by @pascalberger
  • #290 Use specific assertions for testing for true / false by @pascalberger
  • #292 Update to final version of Cake.Recipe 3.0 by @pascalberger
  • #307 Make constructors of abstract classes protected by @pascalberger
  • #308 Fix formatting by @pascalberger
  • #310 Remove not required variable assignments by @pascalberger
  • #311 Remove not required continue by @pascalberger
  • #313 Simplify new statements by @pascalberger
  • #309 Use range operator instead of substring by @pascalberger
  • #312 Check that no exception is thrown by @pascalberger
  • #314 Remove dupFinder exclusions by @pascalberger
  • #317 Add editorconfig file by @pascalberger
  • #318 Fix ordering of methods by @pascalberger
  • #319 Improve null check by @pascalberger
  • #320 Simplify new statement by @pascalberger
  • #321 Mark assertion methods by @pascalberger
  • #325 Fix linting issues and typos by @pascalberger
  • #332 Ensure required .NET SDK are available on build images by @pascalberger

Full Changelog: https://github.com/cake-contrib/Cake.Issues/compare/2.0.0...3.0.0

3.0.0-beta.2 (June 14, 2023)

As part of this release we had 6 issues closed.

Requirements

  • Cake 3.x
  • Targeting .NET 6 and .NET 7

Breaking changes

  • Revert #329 by @pascalberger

Chores

  • #332 Ensure required .NET SDK are available on build images by @pascalberger

Full Changelog: https://github.com/cake-contrib/Cake.Issues/compare/3.0.0-beta.1...3.0.0-beta.2

3.0.0-beta.1 (January 07, 2023)

As part of this release we had 6 issues closed.

Requirements

  • Cake 3.x
  • Targeting .NET 6 and .NET 7

Breaking changes

  • #304 Update to Cake 3.0 by @pascalberger
  • #303 Multi-Target .NET 6 & 7 instead of .NET Core 3.1, 5 & 6 by @pascalberger
  • #329 Make BaseRuleDescription abstract by @pascalberger
  • #324 Rename IsValideRepositoryFilePath to IsValidRepositoryFilePath by @pascalberger
  • #322 Make BaseRuleDescription.Rule init-only by @pascalberger

Improvement

  • #323 Support contravariance for ILogFileFormat type parameters by @pascalberger
  • #316 Update to LitJson 0.18 by @pascalberger

Chores

  • #275 Update Depandabot configuration to ignore Cake updates < 3.0 by @pascalberger
  • #280 Build using Cake .NET Tool by @pascalberger
  • #282 Update to Cake Recipe 3.0 by @pascalberger
  • #286 Disable coveralls by @pascalberger
  • #285 Update solution file to Visual Studio 2022 by @pascalberger
  • #290 Use specific assertions for testing for true / false by @pascalberger
  • #292 Update to final version of Cake.Recipe 3.0 by @pascalberger
  • #307 Make constructors of abstract classes protected by @pascalberger
  • #308 Fix formatting by @pascalberger
  • #310 Remove not required variable assignments by @pascalberger
  • #311 Remove not required continue by @pascalberger
  • #313 Simplify new statements by @pascalberger
  • #309 Use range operator instead of substring by @pascalberger
  • #312 Check that no exception is thrown by @pascalberger
  • #314 Remove dupFinder exclusions by @pascalberger
  • #317 Add editorconfig file by @pascalberger
  • #318 Fix ordering of methods by @pascalberger
  • #319 Improve null check by @pascalberger
  • #320 Simplify new statement by @pascalberger
  • #321 Mark assertion methods by @pascalberger
  • #325 Fix linting issues and typos by @pascalberger

Full Changelog: https://github.com/cake-contrib/Cake.Issues/compare/2.0.0...3.0.0-beta.1

2.0.0 (November 30, 2022)

As part of this release we had 9 issues closed.

Requirements

  • Cake 2.x
  • Targeting .NET Core 3.1, .NET 5 and .NET 6

Breaking changes

  • #263 Update to Cake 2.0 by @pascalberger
  • #264 Multi-Target .NET Core 3.1, 5 & 6 instead of .NET Standard 2.0 by @pascalberger
  • #255 ProviderIssueIssueLimits should be called ProviderIssueLimits by @pascalberger
  • #258 Support for rule name by @pascalberger
  • #273 Rename IIssue.Rule to IIssue.RuleId by @pascalberger

Documentation

  • #235 Replace Gitter with GitHub Discussions by @pascalberger

Improvements

  • #240 Add helper to filter files outside of the repository by @pascalberger
  • #284 Add helper to return rule name or ID by @pascalberger
  • #298 Improve diagnostic logging for filter logic by @pascalberger

Chores

  • #260 Cleanup Dependabot configuration by @pascalberger
  • #270 Fix code analysis warnings by @pascalberger

Full Changelog: https://github.com/cake-contrib/Cake.Issues/compare/1.0.0...2.0.0

2.0.0-beta.3 (September 29, 2022)

As part of this release we had 1 issue closed.

Requirements

  • Cake 2.x
  • Targeting .NET Core 3.1, .NET 5 and .NET 6

Improvement

  • #297 Improve diagnostic logging for filter logic

2.0.0-beta.2 (July 28, 2022)

As part of this release we had 1 issue closed.

Requirements

  • Cake 2.x
  • Targeting .NET Core 3.1, .NET 5 and .NET 6

Improvement

  • #240 Add helper to filter files outside of the repository
  • #284 Add helper to return rule name or ID

2.0.0-beta.1 (December 08, 2021)

As part of this release we had 6 issues closed.

Requirements

  • Cake 2.x
  • Targeting .NET Core 3.1, .NET 5 and .NET 6

Breaking changes

Documentation

  • #235 Replace Gitter with GitHub Discussions

1.0.0 (July 26, 2021)

As part of this release we had 5 issues closed.

Requirements

  • Cake 1.x
  • Targeting .NET Standard 2.0

Breaking changes

Build

  • #204 Merge Cake.Issues.Reporting and Cake.Issues.PullRequests into Cake.Issues

Documentation

  • #249 Add cake-addin tag to Cake.Issues NuGet package

1.0.0-beta.1 (February 16, 2021)

As part of this release we had 4 issues closed.

Requirements

  • Cake 1.x
  • Targeting .NET Standard 2.0

Breaking changes

0.9.1 (September 19, 2020)

As part of this release we had 1 issue closed.

Requirements

  • Cake 0.33.0 or higher
  • Targeting .NET Standard 2.0

Improvement

0.9.0 (August 20, 2020)

As part of this release we had 6 issues closed.

Requirements

  • Cake 0.33.0 or higher
  • Targeting .NET Standard 2.0

Breaking changes

Feature

  • #169 Provide infrastructure for file linking

0.9.0-beta.5 (August 10, 2020)

As part of this release we had 6 issues closed.

Requirements

  • Cake 0.33.0 or higher
  • Targeting .NET Standard 2.0

Improvements

  • Support line ranges and columns in file link settings (#198)
  • Support for CommitId in FileLinkSettings (#196)
  • Refactor file link settings to allow dynamic created file links (#199)
  • Add alias for custom file link settings (#200)
  • Make WithEnding public since it might be useful in other addins (#203)
  • Add LineRange extensions (#202)

0.9.0-beta.4 (August 01, 2020)

As part of this release we had 3 issues closed.

Requirements

  • Cake 0.33.0 or higher
  • Targeting .NET Standard 2.0

Breaking changes

0.9.0-beta.3 (July 31, 2020)

As part of this release we had 3 issues closed.

Requirements

  • Cake 0.33.0 or higher
  • Targeting .NET Standard 2.0

Breaking changes

  • #188 Provide file link for issue
  • Make FileLinkSettings.FileLinkPattern readonly
  • Add GetFileLink extension to resolve file link URL

0.9.0-beta.2 (July 11, 2020)

As part of this release we had 2 issues closed.

Requirements

  • Cake 0.33.0 or higher
  • Targeting .NET Standard 2.0

Improvements

  • Add interfaces for settings

Documentation

  • Fix examples for ReadIssues alias

0.9.0-beta.1 (July 06, 2020)

As part of this release we had 5 issues closed.

Requirements

  • Cake 0.33.0 or higher
  • Targeting .NET Standard 2.0

Breaking changes

Feature

  • #169 Provide infrastructure for file linking

0.8.1 (January 20, 2020)

As part of this release we had 1 issue closed.

Requirements

  • Cake 0.33.0 or higher
  • Targeting .NET Standard 2.0

Feature

0.8.0 (October 17, 2019)

As part of this release we had 5 issues closed.

Requirements

  • Cake 0.33.0 or higher
  • Targeting .NET Standard 2.0

Breaking change

  • #121 Support reading messages in different formats

Features

  • #133 Add versioning to serialization format of issues
  • #128 Add IEqualityComparer for IIssue

Improvement

  • #148 Embed NuGet package icon

Documentation

  • #119 Change website to cakeissues.net

0.8.0-beta.1 (October 10, 2019)

As part of this release we had 4 issues closed.

Requirements

  • Cake 0.33.0 or higher
  • Targeting .NET Standard 2.0

Breaking change

  • #121 Support reading messages in different formats

Features

  • #133 Add versioning to serialization format of issues
  • #128 Add IEqualityComparer for IIssue

Documentation

0.7.1 (August 16, 2019)

As part of this release we had 1 issue closed.

Requirements

  • Cake 0.33.0 or higher
  • Targeting .NET Standard 2.0

Improvement

  • #124 Improve exception message for invalid paths

0.7.0 (May 30, 2019)

As part of this release we had 61 commits which resulted in 7 issues being closed.

Requirements

  • Cake 0.33.0 or higher
  • Targeting .NET Standard 2.0

Breaking change

  • #92 Build against Cake 0.33.0

Features

  • #106 Add alias for serializing/deserializing issues to/from a string and file
  • #41 Add helper for checking issues

Improvements

  • #99 Remove dependency on XUnit.Assert
  • #84 IssueBuilder.WithPriority should allow null value
  • #65 Add extension to skip BOM in byte array stream

Documentation

0.7.0-beta.3 (May 27, 2019)

As part of this release we had 1 issue closed.

Requirements

  • Cake 0.33.0 or higher
  • Targeting .NET Standard 2.0

Features

  • #106 Add alias for serializing/deserializing issues to/from a string and file

0.7.0-beta.2 (April 19, 2019)

As part of this release we had 4 issues closed.

Requirements

  • Cake 0.33.0 or higher
  • Targeting .NET Standard 2.0

Improvements

Bug fixes

0.7.0-beta.1 (April 19, 2019)

As part of this release we had 6 issues closed.

Requirements

  • Cake 0.33.0 or higher
  • Targeting .NET Standard 2.0

Breaking change

  • #92 Build against Cake 0.33.0

Feature

  • #41 Add helper for checking issues

Improvements

  • #99 Remove dependency on XUnit.Assert
  • #84 IssueBuilder.WithPriority should allow null value
  • #65 Add extension to skip BOM in byte array stream

Documentation

0.6.2 (September 05, 2018)

As part of this release we had 3 issues closed.

Requirements

  • Cake 0.28.0 or higher
  • Targeting .NET Standard 2.0

Bug

  • #60 ByteArrayExtensions.ToStringUsingEncoding throws an exception if empty byte array is passed

Improvements

  • #62 ToStringUsingEncoding should not throw if no preamble exists
  • #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 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 ByteArrayExtensions.ToStringUsingEncoding throws an exception if empty byte array is passed

Improvement

  • #62 ToStringUsingEncoding should not throw if no preamble exists

0.6.1 (September 02, 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 Add method for replacing issues tokens in string
  • #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 Add method for replacing issues tokens in string
  • #56 Add extensions for IIssue project and file

0.6.0 (August 24, 2018)

As part of this release we had 3 issues closed.

Requirements

  • Cake 0.28.0 or higher
  • Targeting .NET Standard 2.0

Breaking changes

  • #54 BaseMultiFormatIssueProvider.ReadIssues ignores format
  • #50 Add method to check if initialized was called on BaseIssueComponent

Bug

  • #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 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 Add method to check if initialized was called on BaseIssueComponent

Bug

  • #53 Typo in comment for BaseMultiFormatIssueProvider

0.5.0 (August 17, 2018)

As part of this release we had 4 issues closed.

Requirements

  • Cake 0.28.0 or higher
  • Targeting .NET Standard 2.0

Breaking change

  • #44 Improve issue provider infrastructure

Features

  • #48 Add helper for string / byte array conversion
  • #47 Add helper for working with embedded resources on file system

Improvement

  • #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 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 Add helper for string / byte array conversion
  • #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 closed.

Requirements

  • Cake 0.28.0 or higher
  • Targeting .NET Standard 2.0

Breaking change

  • #44 Improve issue provider infrastructure

0.4.1 (August 03, 2018)

As part of this release we had 1 issue closed.

Requirements

  • Cake 0.28.0 or higher
  • Targeting .NET Standard 2.0

Feature

  • #39 Provide infrastructure for issue provider with different formats

0.4.0 (July 28, 2018)

As part of this release we had 3 issues closed.

Requirements

  • Cake 0.28.0 or higher
  • Targeting .NET Standard 2.0

Breaking change

Improvement

  • #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 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

0.3.1 (June 20, 2018)

As part of this release we had 1 issue closed.

Requirements

  • Cake 0.28.0 or higher
  • Targeting .NET Standard 2.0

Feature

  • #27 Add alias for creating issues from Cake scripts

0.3.0 (June 03, 2018)

As part of this release we had 14 commits which resulted in 6 issues being closed.

Requirements

  • Cake 0.28.0 or higher
  • Targeting .NET Standard 2.0

Breaking changes

  • #29 Make priority optional
  • #28 Build against Cake 0.28.0
  • #26 Add fluent API for Issue creation
  • #22 Add PriorityName to IIssue
  • #21 Add ProviderName to IIssue

Feature

  • #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

Feature

  • #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

0.2.0 (May 21, 2018)

As part of this release we had 6 issues closed.

Requirements

  • Cake 0.26.0 or higher
  • Targeting .NET Standard 2.0

Breaking change

  • #13 Build against Cake 0.26.0

Features

  • #5 Add project to IIssue
  • #4 Migrate to .NET Standard (Thanks @t-johnson)!)

Improvements

  • #20 Make IIssue.Rule an optional parameter
  • #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 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 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 Add project to IIssue
  • #4 Migrate to .NET Standard (Thanks @t-johnson)!)

0.1.0 (September 16, 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 change

  • #3 Update to Cake 0.22

Feature

  • #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<T>.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 First version based on Cake.Prca
GitHub