Skip to content

Commit

Permalink
v.10.0.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
claremacrae committed Jun 4, 2020
1 parent b8ab749 commit a562a4e
Show file tree
Hide file tree
Showing 9 changed files with 67 additions and 52 deletions.
2 changes: 1 addition & 1 deletion ApprovalTests/ApprovalTests.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@

// This file is machine-generated. Do not edit.

#include "ApprovalTests/ApprovalsMacroDefaults.h"
#include "ApprovalTests/ApprovalTestsVersion.h"
#include "ApprovalTests/core/Reporter.h"
#include "ApprovalTests/reporters/QuietReporter.h"
#include "ApprovalTests/utilities/Blocker.h"
#include "ApprovalTests/utilities/WinMinGWUtils.h"
#include "ApprovalTests/ApprovalsMacroDefaults.h"
#include "ApprovalTests/utilities/Macros.h"
#include "ApprovalTests/core/ApprovalWriter.h"
#include "ApprovalTests/writers/StringWriter.h"
Expand Down
4 changes: 2 additions & 2 deletions ApprovalTests/ApprovalTestsVersion.h
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
#pragma once

#define APPROVAL_TESTS_VERSION_MAJOR 9
#define APPROVAL_TESTS_VERSION_MAJOR 10
#define APPROVAL_TESTS_VERSION_MINOR 0
#define APPROVAL_TESTS_VERSION_PATCH 0
#define APPROVAL_TESTS_VERSION_STR "9.0.0"
#define APPROVAL_TESTS_VERSION_STR "10.0.0"

#define APPROVAL_TESTS_VERSION \
(APPROVAL_TESTS_VERSION_MAJOR * 10000 + APPROVAL_TESTS_VERSION_MINOR * 100 + \
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.9.0.0/ApprovalTests.v.9.0.0.hpp">Download the latest version (v.9.0.0) of the **single header file** here.</a>
<a href="https://github.com/approvals/ApprovalTests.cpp/releases/download/v.10.0.0/ApprovalTests.v.10.0.0.hpp">Download the latest version (v.10.0.0) of the **single header file** here.</a>

<!-- toc -->
## Contents
Expand Down
54 changes: 54 additions & 0 deletions build/release_notes/relnotes_10.0.0.md
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

48 changes: 2 additions & 46 deletions build/relnotes_x.y.z.md
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

2 changes: 1 addition & 1 deletion build/version.ini
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[VERSION]
major = 9
major = 10
minor = 0
patch = 0

3 changes: 3 additions & 0 deletions doc/Features.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.10.0.0](#v1000)
* [Removed Deprecated Code](#removed-deprecated-code)
* [v.8.9.0](#v890)
* [Regex-based Scrubbing](#regex-based-scrubbing)
Expand Down Expand Up @@ -63,6 +64,8 @@ To change this file edit the source file and then execute ./run_markdown_templat

## v.x.y.z

## v.10.0.0

### Removed Deprecated Code

See [Why We Are Converting To Options](/doc/explanations/WhyWeAreConvertingToOptions.md#top) for easy ways to update your code.
Expand Down
2 changes: 2 additions & 0 deletions doc/mdsource/Features.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ toc

## v.x.y.z

## v.10.0.0

### Removed Deprecated Code

See [Why We Are Converting To Options](/doc/explanations/WhyWeAreConvertingToOptions.md#top) for easy ways to update your code.
Expand Down
2 changes: 1 addition & 1 deletion mdsource/README.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.9.0.0/ApprovalTests.v.9.0.0.hpp">Download the latest version (v.9.0.0) of the **single header file** here.</a>
<a href="https://github.com/approvals/ApprovalTests.cpp/releases/download/v.10.0.0/ApprovalTests.v.10.0.0.hpp">Download the latest version (v.10.0.0) of the **single header file** here.</a>

toc

Expand Down

0 comments on commit a562a4e

Please sign in to comment.