-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b8ab749
commit a562a4e
Showing
9 changed files
with
67 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
## DON'T PANIC! | ||
|
||
We expect most of our users to have no problem with this upgrade. Changes are only needed when: | ||
|
||
1. you are passing in a specific reporter, which is usually an infrequent and temporary coding state, | ||
2. you call `verifyWithExtension(object, ".json")` is now | ||
`Approvals::verify(object, Options().fileOptions().withFileExtension(".json"))` | ||
|
||
|
||
## Deprecating verify(..., Reporter) | ||
|
||
This is the fourth and final of a series of rapid releases, to make small steps in deprecating passing in a Reporter object, in favor of an Options object, to the `verify*()` methods. See [Why We Are Converting To Options](/doc/explanations/WhyWeAreConvertingToOptions.md#top) for easy ways to update your code. | ||
|
||
1. deprecation warnings are off: users can opt-in (v.8.7.0) | ||
1. deprecation warnings are on: users can opt-out (v.8.9.1) | ||
1. deprecation warnings are forced, code still exists (v.8.9.2) | ||
1. the deprecated methods are hidden: users can opt-in (v.9.0.0) | ||
1. the deprecated methods are removed (v.10.0.0) <== you are here | ||
|
||
* **Breaking changes** | ||
|
||
* Removed methods: | ||
* `Approvals::verify(..., Reporter)` | ||
* `Approvals::verifyAll(..., Reporter)` | ||
* `Approvals::verifyExistingFile(..., Reporter)` | ||
* `Approvals::verifyExceptionMessage(..., Reporter)` | ||
* `Approvals::verifyWithExtension(...)` | ||
* `CombinationApprovals::verifyAllCombinations(Reporter, ...)` | ||
* Removed macros: | ||
* `APPROVAL_TESTS_HIDE_DEPRECATED_CODE` | ||
* `APPROVALTESTS_VERSION` | ||
* `APPROVALTESTS_VERSION_MAJOR` | ||
* `APPROVALTESTS_VERSION_MINOR` | ||
* `APPROVALTESTS_VERSION_PATCH` | ||
* `APPROVALTESTS_VERSION_STR` | ||
* `APPROVALS_CATCH_DISABLE_FILE_MACRO_CHECK` | ||
* The following macros have been changed. | ||
|
||
| Old (removed) | 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` | | ||
|
||
* **New features** | ||
* None | ||
* **Bug fixes** | ||
* None | ||
* **Other changes** | ||
* None | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,54 +1,10 @@ | ||
## DON'T PANIC! | ||
|
||
We expect most of our users to have no problem with this upgrade. Changes are only needed when: | ||
|
||
1. you are passing in a specific reporter, which is usually an infrequent and temporary coding state, | ||
2. you call `verifyWithExtension(object, ".json")` is now | ||
`Approvals::verify(object, Options().fileOptions().withFileExtension(".json"))` | ||
|
||
|
||
## Deprecating verify(..., Reporter) | ||
|
||
This is the fourth and final of a series of rapid releases, to make small steps in deprecating passing in a Reporter object, in favor of an Options object, to the `verify*()` methods. See [Why We Are Converting To Options](/doc/explanations/WhyWeAreConvertingToOptions.md#top) for easy ways to update your code. | ||
|
||
1. deprecation warnings are off: users can opt-in (v.8.7.0) | ||
1. deprecation warnings are on: users can opt-out (v.8.9.1) | ||
1. deprecation warnings are forced, code still exists (v.8.9.2) | ||
1. the deprecated methods are hidden: users can opt-in (v.9.0.0) | ||
1. the deprecated methods are removed (v.10.0.0) <== you are here | ||
<!-- 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** | ||
|
||
* Removed methods: | ||
* `Approvals::verify(..., Reporter)` | ||
* `Approvals::verifyAll(..., Reporter)` | ||
* `Approvals::verifyExistingFile(..., Reporter)` | ||
* `Approvals::verifyExceptionMessage(..., Reporter)` | ||
* `Approvals::verifyWithExtension(...)` | ||
* `CombinationApprovals::verifyAllCombinations(Reporter, ...)` | ||
* Removed macros: | ||
* `APPROVAL_TESTS_HIDE_DEPRECATED_CODE` | ||
* `APPROVALTESTS_VERSION` | ||
* `APPROVALTESTS_VERSION_MAJOR` | ||
* `APPROVALTESTS_VERSION_MINOR` | ||
* `APPROVALTESTS_VERSION_PATCH` | ||
* `APPROVALTESTS_VERSION_STR` | ||
* `APPROVALS_CATCH_DISABLE_FILE_MACRO_CHECK` | ||
* The following macros have been changed. | ||
|
||
| Old (removed) | 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 | ||
* **New features** | ||
* None | ||
* **Bug fixes** | ||
* None | ||
* **Other changes** | ||
* None | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
[VERSION] | ||
major = 9 | ||
major = 10 | ||
minor = 0 | ||
patch = 0 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters