diff --git a/CHANGELOG.md b/CHANGELOG.md index 946450b..9652e02 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](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 diff --git a/README.md b/README.md index 47a2e59..f563487 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,15 @@ # fluentassert -> Extensible, type-safe, fluent assertion Go library. +> [!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. [![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) @@ -22,17 +31,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 diff --git a/doc.go b/doc.go index 8166953..b9e4e27 100644 --- a/doc.go +++ b/doc.go @@ -5,4 +5,10 @@ // // 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. +// Follow the official [Go Test Comments]. +// +// [Go Test Comments]: https://go.dev/wiki/TestComments package verify diff --git a/go.mod b/go.mod index 08e6e5e..a17d2b4 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. +// Follow the official Go Test Comments: https://go.dev/wiki/TestComments. module github.com/fluentassert/verify go 1.18