8000 Prepare v4.0.0 release · reactphp/async@2aa8d89 · GitHub
[go: up one dir, main page]
Skip to content

Commit 2aa8d89

Browse files
clueclue
committed
Prepare v4.0.0 release
1 parent 4dae336 commit 2aa8d89

File tree

3 files changed

+63
-20
lines changed

3 files changed

+63
-20
lines changed

‎CHANGELOG.md

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

4-
* 1.0.0 (2013-02-07)
3+
## 4.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+
`v3.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 8.1+ and add `mixed` type declarations.
29+
(#14 by @clue)
30+
31+
* Feature: Add Fiber-based `async()` and `await()` functions.
32+
(#15, #18, #19 and #20 by @WyriHaximus and #26, #28, #30, #32, #34, #55 and #57 by @clue)
33+
34+
* Project maintenance, rename `main` branch to `4.x` and update installation instructions.
35+
(#29 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 `v3.0.0` release:
39+
40+
* Feature: Support iterable type for `parallel()` + `series()` + `waterfall()`.
41+
(#49 by @clue)
42+
43+
* Feature: Forward compatibility with upcoming Promise v3.
44+
(#48 by @clue)
45+
46+
* Minor documentation improvements.
47+
(#36 by @SimonFrings and #51 by @nhedger)
48+
49+
## 3.0.0 (2022-07-11)
50+
51+
See [`3.x` CHANGELOG](https://github.com/reactphp/async/blob/3.x/CHANGELOG.md) for more details.
52+
53+
## 2.0.0 (2022-07-11)
54+
55+
See [`2.x` CHANGELOG](https://github.com/reactphp/async/blob/2.x/CHANGELOG.md) for more details.
56+
57+
## 1.0.0 (2013-02-07)
58+
59+
* First tagged release

‎README.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![CI status](https://github.com/reactphp/async/workflows/CI/badge.svg)](https://github.com/reactphp/async/actions)
44
[![installs on Packagist](https://img.shields.io/packagist/dt/react/async?color=blue&label=installs%20on%20Packagist)](https://packagist.org/packages/react/async)
55

6-
Async utilities for [ReactPHP](https://reactphp.org/).
6+
Async utilities and fibers for [ReactPHP](https://reactphp.org/).
77

88
This library allows you to manage async control flow. It provides a number of
99
combinators for [Promise](https://github.com/reactphp/promise)-based APIs.
@@ -14,16 +14,6 @@ to have an actual event loop and non-blocking libraries interacting with that
1414
event loop for it to work. As long as you have a Promise-based API that runs in
1515
an event loop, it can be used with this library.
1616

17-
> **Development version:** This branch contains the code for the upcoming 4.0
18-
> release which will be the way forward for this package. However, we will still
19-
> actively support 3.0 and 2.0 for those not yet on PHP 8.1+.
20-
>
21-
> If you're using an older PHP version, you may use the
22-
> [`3.x` branch](https://github.com/reactphp/async/tree/3.x) (PHP 7.1+) or
23-
> [`2.x` branch](https://github.com/reactphp/async/tree/2.x) (PHP 5.3+) which both
24-
> provide a compatible API but do not take advantage of newer language features.
25-
> See also [installation instructions](#install) for more details.
26-
2717
**Table of Contents**
2818

2919
* [Usage](#usage)
@@ -525,11 +515,11 @@ React\Async\waterfall([
525515
The recommended way to install this library is [through Composer](https://getcomposer.org/).
526516
[New to Composer?](https://getcomposer.org/doc/00-intro.md)
527517

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

531521
```bash
532-
composer require react/async:^4@dev
522+
composer require react/async:^4
533523
```
534524

535525
See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
@@ -547,7 +537,7 @@ You may target multiple versions at the same time to support a wider range of
547537
PHP versions like this:
548538

549539
```bash
550-
composer require "react/async:^4@dev || ^3@dev || ^2@dev"
540+
composer require "react/async:^4 || ^3 || ^2"
551541
```
552542

553543
## Tests

‎composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react/async",
3-
"description": "Async utilities for ReactPHP",
3+
"description": "Async utilities and fibers for ReactPHP",
44
"keywords": ["async", "ReactPHP"],
55
"license": "MIT",
66
"authors": [

0 commit comments

Comments
 (0)
0