Skip to content

Commit 9a4519c

Browse files
authored
Prepare release 2.0.0 (#329)
1 parent 9da74bd commit 9a4519c

File tree

2 files changed

+35
-27
lines changed

2 files changed

+35
-27
lines changed

CHANGELOG.md

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,36 +3,41 @@ Changelog
33

44
See also the [GitHub releases page](https://github.com/FriendsOfSymfony/FOSHttpCache/releases).
55

6-
2.0.0 (unreleased)
7-
------------------
6+
2.0.0
7+
-----
8+
9+
### PHP
10+
11+
* Raised minimum PHP version to 5.5.
812

913
### HTTP
1014

11-
* Replaced hard coupling on Guzzle HTTP client with HTTPlug. You now need
12-
to explicitly specify a supported HTTP adapter in composer.json, see [installation instructions]
13-
(http://foshttpcache.readthedocs.io/en/stable/installation.html)
14-
* BC Break: Separated the HttpDispatcher from the proxy clients. All existing
15-
clients still use HTTP to send invalidation requests.
15+
* **BC break:** Replaced hard coupling on Guzzle HTTP client with HTTPlug.
16+
You now need to explicitly specify a supported HTTP adapter in composer.json;
17+
see [installation instructions](http://foshttpcache.readthedocs.io/en/stable/installation.html).
18+
* **BC break:** Separated the HttpDispatcher from the proxy clients. All
19+
existing clients still use HTTP to send invalidation requests.
1620
* Added support and documentation for setting a custom TTL specifically for the
1721
caching proxy.
1822

1923
### Logging
2024

21-
* BC BREAK: Renamed the log event listener from Logsubscriber to LogListener.
25+
* **BC break:** Renamed the log event listener from `LogSubscriber` to
26+
`LogListener`.
2227

2328
### Tagging
2429

25-
* Abstracting tags by adding new `TagsInterface` for ProxyClients, as part of
26-
that also:
27-
BC break: Moved tag invalidation to `CacheInvalidator`, and rename TagHandler
28-
to ResponseTagger.
29-
* The ResponseTagger validates that no tags are empty. It can skip empty tags
30-
or throw exceptions
30+
* **BC break:** Moved tag invalidation to `CacheInvalidator`, and renamed
31+
`TagHandler` to `ResponseTagger`.
32+
* Abstracting tags by adding new `TagsInterface` for ProxyClients.
33+
* Added `strict` option to `ResponseTagger` that throws an exception when empty
34+
tags are added. By default, empty tags are ignored.
3135

3236
### Varnish
3337

3438
* Varnish configuration are now files that you can directly include from your
3539
.vcl and call custom functions to avoid copy-pasting VCL code.
40+
* Added support for and changed default to Varnish version 5.
3641
* Moved Varnish 4 and 5 configuration files from `resources/config/varnish-4/`
3742
to `resources/config/varnish/`.
3843
* Changed default Varnish version to 5.
@@ -46,20 +51,23 @@ See also the [GitHub releases page](https://github.com/FriendsOfSymfony/FOSHttpC
4651

4752
### Symfony HttpCache
4853

49-
* BC BREAK: Renamed all event listeners to XxListener instead of XxSubscriber.
50-
* BC BREAK: Constructors for PurgeListener and RefreshListener now use an
51-
options array for customization.
52-
* Provide a trait for the event dispatching kernel, instead of a base class.
53-
The trait offers both the addSubscriber and the addListener methods.
54+
* **BC break:** Renamed all event listeners to `XxListener` instead of
55+
`XxSubscriber`.
56+
* **BC break:** Constructors for `PurgeListener` and `RefreshListener` now use
57+
an options array for customization.
58+
* **BC break:** Converted abstract event dispatching kernel class
59+
`EventDispatchingHttpCache` to a trait, which now provides the `addSubscriber`
60+
and `addListener` methods. In your `AppCache`, replace
61+
`AppCache extends EventDispatchingHttpInterface` with a
62+
`use EventDispatchingHttpCache;` statement.
5463
* The user context by default does not use a hardcoded hash for anonymous users
55-
but does a hash lookup. You can still configure a hardcoded hash.
64+
but does a hash lookup. You can still configure a hardcoded hash.
5665

5766
### Testing
5867

59-
* In ProxyTestCase, `getHttpClient()` has been replaced with `getHttpAdapter()`;
60-
added HTTP method parameter to `getResponse()`.
61-
* Refactored the proxy client test system into traits. Removed ProxyTestCase,
62-
use the traits `CacheAssertions` and `HttpCaller` instead.
68+
* **BC break:** Refactored the proxy client test system into traits. Removed
69+
`ProxyTestCase`; use the traits `CacheAssertions` and `HttpCaller` instead.
70+
* Added HTTP method parameter to `HttpCaller::getResponse()`.
6371

6472
1.4.2
6573
-----

doc/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ This is the documentation for the `FOSHttpCache library <https://github.com/Frie
55

66
.. note::
77

8-
This documentation is for the (upcoming) 2.0 of the library. For the stable
9-
1.* version, please refer to the `stable documentation`_.
8+
This documentation is for the 2.* version of the library. For the 1.*
9+
version, please refer to the `1.4.2 documentation`_.
1010

1111
This library integrates your PHP applications with HTTP caching proxies such as
1212
Varnish, NGINX or the Symfony HttpCache class. Use this library to send
@@ -34,4 +34,4 @@ Contents:
3434
testing-your-application
3535
contributing
3636

37-
.. _stable documentation: http://foshttpcache.readthedocs.io/en/stable/
37+
.. _1.4.2 documentation: http://foshttpcache.readthedocs.io/en/1.4.2/

0 commit comments

Comments
 (0)