v.8.7.0 release

claremacrae · claremacrae · commit 3dcea03a6050 · 2020-05-15T18:49:50.000+01:00
diff --git a/ApprovalTests/ApprovalTests.hpp b/ApprovalTests/ApprovalTests.hpp
@@ -13,6 +13,7 @@
 #include "ApprovalTests/core/ApprovalWriter.h"
 #include "ApprovalTests/writers/StringWriter.h"
 #include "ApprovalTests/utilities/FileUtils.h"
+#include "ApprovalTests/utilities/StringMaker.h"
 #include "ApprovalTests/utilities/StringUtils.h"
 #include "ApprovalTests/utilities/SystemUtils.h"
 #include "ApprovalTests/utilities/MachineBlocker.h"
diff --git a/ApprovalTests/ApprovalTestsVersion.h b/ApprovalTests/ApprovalTestsVersion.h
@@ -3,9 +3,9 @@
 #include "ApprovalTests/ApprovalsMacroDefaults.h"
 
 #define APPROVAL_TESTS_VERSION_MAJOR 8
-#define APPROVAL_TESTS_VERSION_MINOR 6
+#define APPROVAL_TESTS_VERSION_MINOR 7
 #define APPROVAL_TESTS_VERSION_PATCH 0
-#define APPROVAL_TESTS_VERSION_STR "8.6.0"
+#define APPROVAL_TESTS_VERSION_STR "8.7.0"
 
 #define APPROVAL_TESTS_VERSION                                                           \
     (APPROVAL_TESTS_VERSION_MAJOR * 10000 + APPROVAL_TESTS_VERSION_MINOR * 100 +         \
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ To change this file edit the source file and then execute ./run_markdown_templat
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](/CODE_OF_CONDUCT.md#top)
 
-<a href="https://github.com/approvals/ApprovalTests.cpp/releases/download/v.8.6.0/ApprovalTests.v.8.6.0.hpp">Download the latest version (v.8.6.0) of the **single header file** here.</a>
+<a href="https://github.com/approvals/ApprovalTests.cpp/releases/download/v.8.7.0/ApprovalTests.v.8.7.0.hpp">Download the latest version (v.8.7.0) of the **single header file** here.</a>
 
 <!-- toc -->
 ## Contents
diff --git a/build/release_notes/relnotes_8.7.0.md b/build/release_notes/relnotes_8.7.0.md
@@ -0,0 +1,43 @@
+See the [v.8.7.0 milestone](https://github.com/approvals/ApprovalTests.cpp/milestone/8?closed=1) for the full list of changes.
+
+* **Breaking changes**
+    * **Planned deprecation:** The overloads of `verify()`, `verifyAll()` and `verifyAllCombinations()` which take a `Reporter` have been deprecated.
+        * The `Reporter` argument is `replaced` by Options - see below.
+        * By default, there is currently no change, but this release marks the start of the [plan to remove them](/doc/explanations/WhyWeAreConvertingToOptions.md#the-plan).
+    * If you happen to have specialised `StringUtils::toString()`, you would now need to specialize `StringMaker::toString()` instead.
+        * Note: this was previously unsupported behavior, so we are not bumping the major version number.
+        * Here is how to update your code:
+```diff
+template <>
+-std::string ApprovalTests::StringUtils::toString(const StringMakerPrintable& printable)
++std::string ApprovalTests::StringMaker::toString(const StringMakerPrintable& printable)
+```
+* **New features**
+    * New [Options](/doc/Options.md#top) class provides consistent interface for customising the following in all `verify()`, `verifyAll()` and `verifyAllCombinations()` calls:
+        * Reporter: see [Why We Are Converting To Options](/doc/explanations/WhyWeAreConvertingToOptions.md#top)
+        * Scrubber: [How to Scrub Non-Deterministic Output](/doc/how_tos/ScrubNonDeterministicOutput.md#top).  (#126, thank you @abdulg, @haraldreingruber, @jawn)
+        * File extensions now customizable with `verifyAll()` and `verifyAllCombinations()`: See [File Extensions](/doc/Options.md#file-extensions) (#127)
+    * New mechanics for [String conversions](/doc/ToString.md#top)
+        * The class `Approvals` is now an alias for `TApprovals< ToStringCompileTimeOptions< StringMaker > >`
+        * This is a completely backwards-compatible feature.
+        * It has been done to support a new feature in a future release.
+    * Our Conan.io package now supports our Boost.Test integration (#121)
+* **Bug fixes**
+    * None
+* **Other changes**
+    * [User Guide available on Read the Docs](https://approvaltestscpp.readthedocs.io/en/latest/index.html)
+        * This is more easily searchable and better formatted than on GitHub, and a PDF download is available. (#129)
+    * Documented workarounds for when [running Catch2 tests in CLion gives 'unexpected exception'](/doc/Troubleshooting.md#running-catch2-tests-in-clion-gives-unexpected-exception) (#131)
+    * Consistent macro names
+        * All our Macros now start with `APPROVAL_TESTS_`.
+        * We have kept the old macros, redirecting to the new ones, for backwards compatibility.
+
+
+| Old                                        | New                                       |
+| ------------------------------------------ | ----------------------------------------- |
+| `APPROVALTESTS_VERSION`                    | `APPROVAL_TESTS_VERSION`                  |
+| `APPROVALTESTS_VERSION_MAJOR`              | `APPROVAL_TESTS_VERSION_MAJOR`            |
+| `APPROVALTESTS_VERSION_MINOR`              | `APPROVAL_TESTS_VERSION_MINOR`            |
+| `APPROVALTESTS_VERSION_PATCH`              | `APPROVAL_TESTS_VERSION_PATCH`            |
+| `APPROVALTESTS_VERSION_STR`                | `APPROVAL_TESTS_VERSION_STR`              |
+| `APPROVALS_CATCH_DISABLE_FILE_MACRO_CHECK` | `APPROVAL_TESTS_DISABLE_FILE_MACRO_CHECK` |
diff --git a/build/relnotes_x.y.z.md b/build/relnotes_x.y.z.md
@@ -1,43 +1,10 @@
-See the [v.x.y.z milestone](https://github.com/approvals/ApprovalTests.cpp/milestone/8?closed=1) for the full list of changes.
+<!-- See the [v.x.y.z milestone](https://github.com/approvals/ApprovalTests.cpp/milestone/__MILESTONE_NUMBER__?closed=1) for the full list of changes. -->
 
 * **Breaking changes**
-    * **Planned deprecation:** The overloads of `verify()`, `verifyAll()` and `verifyAllCombinations()` which take a `Reporter` have been deprecated.
-        * The `Reporter` argument is `replaced` by Options - see below.
-        * By default, there is currently no change, but this release marks the start of the [plan to remove them](/doc/explanations/WhyWeAreConvertingToOptions.md#the-plan).
-    * If you happen to have specialised `StringUtils::toString()`, you would now need to specialize `StringMaker::toString()` instead.
-        * Note: this was previously unsupported behavior, so we are not bumping the major version number.
-        * Here is how to update your code:
-```diff
-template <>
--std::string ApprovalTests::StringUtils::toString(const StringMakerPrintable& printable)
-+std::string ApprovalTests::StringMaker::toString(const StringMakerPrintable& printable)
-```
+    * None
 * **New features**
-    * New [Options](/doc/Options.md#top) class provides consistent interface for customising the following in all `verify()`, `verifyAll()` and `verifyAllCombinations()` calls:
-        * Reporter: see [Why We Are Converting To Options](/doc/explanations/WhyWeAreConvertingToOptions.md#top)
-        * Scrubber: [How to Scrub Non-Deterministic Output](/doc/how_tos/ScrubNonDeterministicOutput.md#top).  (#126, thank you @abdulg, @haraldreingruber, @jawn)
-        * File extensions now customizable with `verifyAll()` and `verifyAllCombinations()`: See [File Extensions](/doc/Options.md#file-extensions) (#127)
-    * New mechanics for [String conversions](/doc/ToString.md#top)
-        * The class `Approvals` is now an alias for `TApprovals< ToStringCompileTimeOptions< StringMaker > >`
-        * This is a completely backwards-compatible feature.
-        * It has been done to support a new feature in a future release.
-    * Our Conan.io package now supports our Boost.Test integration (#121)
+    * None
 * **Bug fixes**
     * None
 * **Other changes**
-    * [User Guide available on Read the Docs](https://approvaltestscpp.readthedocs.io/en/latest/index.html)
-        * This is more easily searchable and better formatted than on GitHub, and a PDF download is available. (#129)
-    * Documented workarounds for when [running Catch2 tests in CLion gives 'unexpected exception'](/doc/Troubleshooting.md#running-catch2-tests-in-clion-gives-unexpected-exception) (#131)
-    * Consistent macro names
-        * All our Macros now start with `APPROVAL_TESTS_`.
-        * We have kept the old macros, redirecting to the new ones, for backwards compatibility.
-
-
-| Old                                        | New                                       |
-| ------------------------------------------ | ----------------------------------------- |
-| `APPROVALTESTS_VERSION`                    | `APPROVAL_TESTS_VERSION`                  |
-| `APPROVALTESTS_VERSION_MAJOR`              | `APPROVAL_TESTS_VERSION_MAJOR`            |
-| `APPROVALTESTS_VERSION_MINOR`              | `APPROVAL_TESTS_VERSION_MINOR`            |
-| `APPROVALTESTS_VERSION_PATCH`              | `APPROVAL_TESTS_VERSION_PATCH`            |
-| `APPROVALTESTS_VERSION_STR`                | `APPROVAL_TESTS_VERSION_STR`              |
-| `APPROVALS_CATCH_DISABLE_FILE_MACRO_CHECK` | `APPROVAL_TESTS_DISABLE_FILE_MACRO_CHECK` |
+    * None
diff --git a/build/version.ini b/build/version.ini
@@ -1,5 +1,5 @@
 [VERSION]
 major = 8
-minor = 6
+minor = 7
 patch = 0
 
diff --git a/doc/Features.md b/doc/Features.md
@@ -15,6 +15,7 @@ To change this file edit the source file and then execute ./run_markdown_templat
 ## Contents
 
   * [v.x.y.z](#vxyz)
+  * [v.8.7.0](#v870)
     * [Options](#options)
     * [Scrubbers](#scrubbers)
     * [StringMaker and TApprovals](#stringmaker-and-tapprovals)
@@ -57,6 +58,8 @@ To change this file edit the source file and then execute ./run_markdown_templat
 
 ## v.x.y.z
 
+## v.8.7.0
+
 ### Options
 
 See [Options](/doc/Options.md#top).
diff --git a/doc/mdsource/Features.source.md b/doc/mdsource/Features.source.md
@@ -8,6 +8,8 @@ toc
 
 ## v.x.y.z
 
+## v.8.7.0
+
 ### Options
 
 See [Options](/doc/Options.md#top).
diff --git a/mdsource/README.source.md b/mdsource/README.source.md
@@ -8,7 +8,7 @@
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](/CODE_OF_CONDUCT.md#top)
 
-<a href="https://github.com/approvals/ApprovalTests.cpp/releases/download/v.8.6.0/ApprovalTests.v.8.6.0.hpp">Download the latest version (v.8.6.0) of the **single header file** here.</a>
+<a href="https://github.com/approvals/ApprovalTests.cpp/releases/download/v.8.7.0/ApprovalTests.v.8.7.0.hpp">Download the latest version (v.8.7.0) of the **single header file** here.</a>
 
 toc
 
