Skip to content

Commit 3c3b812

Browse files
committed
Prepare v3.0.0 release
1 parent 4b0b7a1 commit 3c3b812

File tree

2 files changed

+56
-13
lines changed

2 files changed

+56
-13
lines changed

CHANGELOG.md

Lines changed: 53 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,55 @@
1-
CHANGELOG
2-
=========
1+
# Changelog
32

4-
* 1.0.0 (2013-02-07)
3+
## 3.0.0 (2022-07-11)
54

6-
* First tagged release
5+
A major new feature release, see [**release announcement**](https://clue.engineering/2022/announcing-reactphp-async).
6+
7+
* We'd like to emphasize that this component is production ready and battle-tested.
8+
We plan to support all long-term support (LTS) releases for at least 24 months,
9+
so you have a rock-solid foundation to build on top of.
10+
11+
* The v4 release will be the way forward for this package. However, we will still
12+
actively support v3 and v2 to provide a smooth upgrade path for those not yet
13+
on PHP 8.1+. If you're using an older PHP version, you may use either version
14+
which all provide a compatible API but may not take advantage of newer language
15+
features. You may target multiple versions at the same time to support a wider range of
16+
PHP versions:
17+
18+
* [`4.x` branch](https://github.com/reactphp/async/tree/4.x) (PHP 8.1+)
19+
* [`3.x` branch](https://github.com/reactphp/async/tree/3.x) (PHP 7.1+)
20+
* [`2.x` branch](https://github.com/reactphp/async/tree/2.x) (PHP 5.3+)
21+
22+
This update involves some major new features and a minor BC break over the
23+
`v2.0.0` release. We've tried hard to avoid BC breaks where possible and
24+
minimize impact otherwise. We expect that most consumers of this package will be
25+
affected by BC breaks, but updating should take no longer than a few minutes.
26+
See below for more details:
27+
28+
* Feature / BC break: Require PHP 7.1+ and add type declarations.
29+
(#11 by @clue)
30+
31+
* Feature: Add Generator-based `coroutine()` function.
32+
(#12, #13 and #54 by @clue)
33+
34+
* Feature: Support iterable type for `parallel()` + `series()` + `waterfall()`.
35+
(#45 by @clue)
36+
37+
The following changes had to be ported to this release due to our branching
38+
strategy, but also appeared in the `v2.0.0` release:
39+
40+
* Feature: Only stop loop for `await()` if a pending promise resolves/rejects.
41+
(#33 by @SimonFrings)
42+
43+
* Feature: Forward compatibility with upcoming Promise v3.
44+
(#47 by @clue)
45+
46+
* Minor documentation improvements.
47+
(#37 by @SimonFrings and #52 by @nhedger)
48+
49+
## 2.0.0 (2022-07-11)
50+
51+
See [`2.x` CHANGELOG](https://github.com/reactphp/async/blob/2.x/CHANGELOG.md) for more details.
52+
53+
## 1.0.0 (2013-02-07)
54+
55+
* First tagged release

README.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -329,11 +329,11 @@ React\Async\waterfall([
329329
The recommended way to install this library is [through Composer](https://getcomposer.org/).
330330
[New to Composer?](https://getcomposer.org/doc/00-intro.md)
331331

332-
Once released, this project will follow [SemVer](https://semver.org/).
333-
At the moment, this will install the latest development version:
332+
This project follows [SemVer](https://semver.org/).
333+
This will install the latest supported version from this branch:
334334

335335
```bash
336-
composer require react/async:dev-main
336+
composer require react/async:^3
337337
```
338338

339339
See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
@@ -342,12 +342,6 @@ This project aims to run on any platform and thus does not require any PHP
342342
extensions and supports running on PHP 7.1 through current PHP 8+.
343343
It's *highly recommended to use the latest supported PHP version* for this project.
344344

345-
We're committed to providing long-term support (LTS) options and to provide a
346-
smooth upgrade path. If you're using an older PHP version, you may use the
347-
[`2.x` branch](https://github.com/reactphp/async/tree/2.x) which provides a
348-
compatible API but does not take advantage of newer language features. You may
349-
target both versions at the same time to support a wider range of PHP versions.
350-
351345
## Tests
352346

353347
To run the test suite, you first need to clone this repo and then install all

0 commit comments

Comments
 (0)