From 7cb2a29c1cab464e99ae63c880db1af417af6c80 Mon Sep 17 00:00:00 2001 From: Clare Macrae Date: Wed, 8 Sep 2021 20:16:27 +0100 Subject: [PATCH] v.0.0.3 release --- ApprovalTestsQt/ApprovalTestsQt.hpp | 3 ++- ApprovalTestsQt/ApprovalTestsQtVersion.h | 4 ++-- README.md | 3 ++- build/release_notes/relnotes_0.0.3.md | 11 +++++++++++ build/relnotes_x.y.z.md | 3 +-- build/version.ini | 2 +- mdsource/README.source.md | 2 +- 7 files changed, 20 insertions(+), 8 deletions(-) create mode 100644 build/release_notes/relnotes_0.0.3.md diff --git a/ApprovalTestsQt/ApprovalTestsQt.hpp b/ApprovalTestsQt/ApprovalTestsQt.hpp index 0077ee2..be1f030 100644 --- a/ApprovalTestsQt/ApprovalTestsQt.hpp +++ b/ApprovalTestsQt/ApprovalTestsQt.hpp @@ -6,9 +6,10 @@ #include "ApprovalTestsQt/integrations/LoadApprovals.h" #include "ApprovalTestsQt/writers/QTableViewWriter.h" #include "ApprovalTestsQt/writers/QImageApprovalWriter.h" +#include "ApprovalTestsQt/comparators/QImageApprovalComparator.h" #include "ApprovalTestsQt/ApprovalTestsQtVersion.h" #include "ApprovalTestsQt/ApprovalsQt.h" -#include "ApprovalTestsQt/comparators/QImageApprovalComparator.h" +#include "ApprovalTestsQt/SafeQTestMacros.h" #include "ApprovalTestsQt/integrations/catch/Catch2QtApprovals.h" #include "ApprovalTestsQt/integrations/catch/Catch2QtStringMaker.h" diff --git a/ApprovalTestsQt/ApprovalTestsQtVersion.h b/ApprovalTestsQt/ApprovalTestsQtVersion.h index a4c2e74..f327650 100644 --- a/ApprovalTestsQt/ApprovalTestsQtVersion.h +++ b/ApprovalTestsQt/ApprovalTestsQtVersion.h @@ -2,8 +2,8 @@ #define APPROVAL_TESTS_QT_VERSION_MAJOR 0 #define APPROVAL_TESTS_QT_VERSION_MINOR 0 -#define APPROVAL_TESTS_QT_VERSION_PATCH 2 -#define APPROVAL_TESTS_QT_VERSION_STR "0.0.2" +#define APPROVAL_TESTS_QT_VERSION_PATCH 3 +#define APPROVAL_TESTS_QT_VERSION_STR "0.0.3" #define APPROVAL_TESTS_QT_VERSION \ (APPROVAL_TESTS_QT_VERSION_MAJOR * 10000 + APPROVAL_TESTS_QT_VERSION_MINOR * 100 + \ diff --git a/README.md b/README.md index 169833f..32ebe61 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ To change this file edit the source file and then execute ./run_markdown_templat [![Actions Status](https://github.com/approvals/ApprovalTests.cpp.Qt/workflows/build/badge.svg)](https://github.com/approvals/ApprovalTests.cpp.Qt/actions) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -Download the latest version (v.0.0.2) of the **single header file** here. +Download the latest version (v.0.0.3) of the **single header file** here. ## Contents @@ -55,6 +55,7 @@ You can download the [Starter Project](https://github.com/approvals/ApprovalTest ## Limitations * **IMPORTANT:** Do not use the [Qt Test macros](https://doc.qt.io/qt-5/qtest.html#macros), such as `QCOMPARE`, `QVERIFY`, `QTRY_COMPARE` and so on. **Currently, any test failures of all any of the Qt Test macros will be silently swallowed, and tests will spuriously pass.** +* Currently, there are compile-time checks to prevent incorrect use of `QCOMPARE`, but not the others. * Please note that this is a very early implementation, and there is not yet any promise of a stable interface. ## Reference diff --git a/build/release_notes/relnotes_0.0.3.md b/build/release_notes/relnotes_0.0.3.md new file mode 100644 index 0000000..a386982 --- /dev/null +++ b/build/release_notes/relnotes_0.0.3.md @@ -0,0 +1,11 @@ + + +* **Breaking changes** + * None +* **New features** + * None +* **Bug fixes** + * Add compile-time checks to prevent incorrect use of `QCOMPARE` from the Catch2 framework (#6 - thanks to Fabial Kosmale of Qt) + * Now creates valid image files for new image-based approval tests (#7) +* **Other changes** + * None diff --git a/build/relnotes_x.y.z.md b/build/relnotes_x.y.z.md index c419b7f..43aa5f8 100644 --- a/build/relnotes_x.y.z.md +++ b/build/relnotes_x.y.z.md @@ -5,7 +5,6 @@ * **New features** * None * **Bug fixes** - * Add compile-time checks to prevent incorrect use of `QCOMPARE` from the Catch2 framework (#6 - thanks to Fabial Kosmale of Qt) - * Now creates valid image files for new image-based approval tests (#7) + * None * **Other changes** * None diff --git a/build/version.ini b/build/version.ini index b0b3dbb..6113843 100644 --- a/build/version.ini +++ b/build/version.ini @@ -1,5 +1,5 @@ [VERSION] major = 0 minor = 0 -patch = 2 +patch = 3 diff --git a/mdsource/README.source.md b/mdsource/README.source.md index e8689a0..d5a86ce 100644 --- a/mdsource/README.source.md +++ b/mdsource/README.source.md @@ -7,7 +7,7 @@ [![Actions Status](https://github.com/approvals/ApprovalTests.cpp.Qt/workflows/build/badge.svg)](https://github.com/approvals/ApprovalTests.cpp.Qt/actions) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -Download the latest version (v.0.0.2) of the **single header file** here. +Download the latest version (v.0.0.3) of the **single header file** here. toc