From 2106871c7dcaa04eace78a40d5e5197359512d73 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Mon, 17 Feb 2025 20:18:26 +0100 Subject: [PATCH 01/10] Update doc.go --- doc.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc.go b/doc.go index 8166953..1216db4 100644 --- a/doc.go +++ b/doc.go @@ -5,4 +5,7 @@ // // At last, you may embed a Fluent* type // to extend it with additional assertion functions. +// +// Deprecated: avoid using assertion libraries. +// Use the standard library and [github.com/google/go-cmp/cmp] instead. package verify From 4528e843a197859af8a197dd414c1be9422c135d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Mon, 17 Feb 2025 20:20:44 +0100 Subject: [PATCH 02/10] Update doc.go --- doc.go | 1 + 1 file changed, 1 insertion(+) diff --git a/doc.go b/doc.go index 1216db4..7635651 100644 --- a/doc.go +++ b/doc.go @@ -8,4 +8,5 @@ // // Deprecated: avoid using assertion libraries. // Use the standard library and [github.com/google/go-cmp/cmp] instead. +// Reference: https://go.dev/wiki/TestComments. package verify From e09d5d2b3eec4ab6ea47f507ffb31a2308c9dfd5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Mon, 17 Feb 2025 20:21:02 +0100 Subject: [PATCH 03/10] Update go.mod --- go.mod | 3 +++ 1 file changed, 3 insertions(+) diff --git a/go.mod b/go.mod index 08e6e5e..7fd352d 100644 --- a/go.mod +++ b/go.mod @@ -1,3 +1,6 @@ +// Deprecated: avoid using assertion libraries. +// Use the standard library and github.com/google/go-cmp/cmp instead. +// Reference: https://go.dev/wiki/TestComments. module github.com/fluentassert/verify go 1.18 From c3c6fadbe3cf23e1a05cd013cffd26a15f8aa300 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Mon, 17 Feb 2025 20:24:57 +0100 Subject: [PATCH 04/10] Update CHANGELOG.md --- CHANGELOG.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 946450b..0555323 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,13 @@ All notable changes to this library are documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this library adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased](https://github.com/fluentassert/verify/compare/v1.2.0...HEAD) +## [1.3.0](https://github.com/fluentassert/verify/releases/tag/v1.2.0) - 2025-02-17 + +### Deprecated + +- Deprecate the whole library. Avoid using assertion libraries. + Use the standard library and [github.com/google/go-cmp/cmp] instead. + Follow the offical [Go Test Comments](https://go.dev/wiki/TestComments). ## [1.2.0](https://github.com/fluentassert/verify/releases/tag/v1.2.0) - 2024-09-10 From a33f3d7f475cd6c60eef0f988b73c43e4d923e4a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Mon, 17 Feb 2025 20:26:32 +0100 Subject: [PATCH 05/10] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0555323..60f82e8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,7 +11,7 @@ and this library adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Deprecate the whole library. Avoid using assertion libraries. Use the standard library and [github.com/google/go-cmp/cmp] instead. - Follow the offical [Go Test Comments](https://go.dev/wiki/TestComments). + Follow the official [Go Test Comments](https://go.dev/wiki/TestComments). ## [1.2.0](https://github.com/fluentassert/verify/releases/tag/v1.2.0) - 2024-09-10 From 49881d1cc5f8cf2eefd47733ce1af3081d7c8e18 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Mon, 17 Feb 2025 20:27:31 +0100 Subject: [PATCH 06/10] Update CHANGELOG.md --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 60f82e8..9652e02 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,8 +10,8 @@ and this library adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Deprecated - Deprecate the whole library. Avoid using assertion libraries. - Use the standard library and [github.com/google/go-cmp/cmp] instead. - Follow the official [Go Test Comments](https://go.dev/wiki/TestComments). + Use the standard library and [github.com/google/go-cmp/cmp](https://pkg.go.dev/github.com/google/go-cmp/cmp) + instead. Follow the official [Go Test Comments](https://go.dev/wiki/TestComments). ## [1.2.0](https://github.com/fluentassert/verify/releases/tag/v1.2.0) - 2024-09-10 From c71fc56617f151a382f7fe8ea53b4833e0ad53c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Mon, 17 Feb 2025 20:28:29 +0100 Subject: [PATCH 07/10] Update go.mod --- go.mod | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/go.mod b/go.mod index 7fd352d..a17d2b4 100644 --- a/go.mod +++ b/go.mod @@ -1,6 +1,6 @@ // Deprecated: avoid using assertion libraries. // Use the standard library and github.com/google/go-cmp/cmp instead. -// Reference: https://go.dev/wiki/TestComments. +// Follow the official Go Test Comments: https://go.dev/wiki/TestComments. module github.com/fluentassert/verify go 1.18 From ffe779d22dd338412a3a5696b57962a284bbaf2c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Mon, 17 Feb 2025 20:29:25 +0100 Subject: [PATCH 08/10] Update doc.go --- doc.go | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc.go b/doc.go index 7635651..b9e4e27 100644 --- a/doc.go +++ b/doc.go @@ -8,5 +8,7 @@ // // Deprecated: avoid using assertion libraries. // Use the standard library and [github.com/google/go-cmp/cmp] instead. -// Reference: https://go.dev/wiki/TestComments. +// Follow the official [Go Test Comments]. +// +// [Go Test Comments]: https://go.dev/wiki/TestComments package verify From 332f42456656a6ed7fd4eff0b518465232ec6d90 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Mon, 17 Feb 2025 20:31:55 +0100 Subject: [PATCH 09/10] Update README.md --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 47a2e59..0503c61 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,16 @@ # fluentassert +> [!CAUTION] +> [Avoid using assertion libraries](https://go.dev/wiki/TestComments#assert-libraries). +> Instead, use [`go-cmp`](https://github.com/google/go-cmp) +> and write custom test helpers. +> Using the popular [`testify`](https://github.com/stretchr/testify) +> may be also an acceptable choice, +> especially together with [`testifylint`](https://github.com/Antonboom/testifylint) +> to avoid common mistakes. +> Use this library if you still want to. +> Consider yourself warned. + > Extensible, type-safe, fluent assertion Go library. [![Go Reference](https://pkg.go.dev/badge/github.com/fluentassert/verify.svg)](https://pkg.go.dev/github.com/fluentassert/verify) @@ -22,17 +33,6 @@ The generics (type parameters) make the usage type-safe. The library is [extensible](#extensibility) by design. -> [!CAUTION] -> [Avoid using assertion libraries](https://go.dev/wiki/TestComments#assert-libraries). -> Instead, use [`go-cmp`](https://github.com/google/go-cmp) -> and write custom test helpers. -> Using the popular [`testify`](https://github.com/stretchr/testify) -> may be also an acceptable choice, -> especially together with [`testifylint`](https://github.com/Antonboom/testifylint) -> to avoid common mistakes. -> Use this library if you still want to. -> Consider yourself warned. - ### Quick start ```go From 031139a206b2575cb60de9f5aca08005cbe20b8e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Mon, 17 Feb 2025 20:35:36 +0100 Subject: [PATCH 10/10] Update README.md --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 0503c61..f563487 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,6 @@ > Use this library if you still want to. > Consider yourself warned. -> Extensible, type-safe, fluent assertion Go library. - [![Go Reference](https://pkg.go.dev/badge/github.com/fluentassert/verify.svg)](https://pkg.go.dev/github.com/fluentassert/verify) [![Keep a Changelog](https://img.shields.io/badge/changelog-Keep%20a%20Changelog-%23E05735)](CHANGELOG.md) [![GitHub Release](https://img.shields.io/github/v/release/fluentassert/verify)](https://github.com/fluentassert/verify/releases)