From 718b0571a94aa693c6fffc72182e87257ac900f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20L=C3=BCck?= Date: Wed, 20 Oct 2021 16:07:33 +0200 Subject: [PATCH] Prepare v1.5.0 release --- CHANGELOG.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ README.md | 10 +++++----- 2 files changed, 49 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 20fc7f4..5f145e9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,49 @@ # Changelog +## 1.5.0 (2021-10-20) + +* Feature: Simplify usage by supporting new [default loop](https://github.com/reactphp/event-loop#loop). + (#60 by @clue) + + ```php + // old (still supported) + Clue\React\Block\await($promise, $loop); + Clue\React\Block\awaitAny($promises, $loop); + Clue\React\Block\awaitAll($promises, $loop); + + // new (using default loop) + Clue\React\Block\await($promise); + Clue\React\Block\awaitAny($promises); + Clue\React\Block\awaitAll($promises); + ``` + +* Feature: Added support for upcoming react/promise v3. + (#61 by @davidcole1340 and @SimonFrings) + +* Improve error reporting by appending previous message for `Throwable`s. + (#57 by @clue) + +* Deprecate `$timeout` argument for `await*()` functions. + (#59 by @clue) + + ```php + // deprecated + Clue\React\Block\await($promise, $loop, $timeout); + Clue\React\Block\awaitAny($promises, $loop, $timeout); + Clue\React\Block\awaitAll($promises, $loop, $timeout); + + // still supported + Clue\React\Block\await($promise, $loop); + Clue\React\Block\awaitAny($promises, $loop); + Clue\React\Block\awaitAll($promises, $loop); + ``` + +* Improve API documentation. + (#58 and #63 by @clue and #55 by @PaulRotmann) + +* Improve test suite and use GitHub actions for continuous integration (CI). + (#54 by @SimonFrings) + ## 1.4.0 (2020-08-21) * Improve API documentation, update README and add examples. diff --git a/README.md b/README.md index 6ea17a9..d000a16 100644 --- a/README.md +++ b/README.md @@ -295,14 +295,14 @@ For long-running applications, using promise-based APIs by leveraging chained ## Install -The recommended way to install this library is [through Composer](https://getcomposer.org). +The recommended way to install this library is [through Composer](https://getcomposer.org/). [New to Composer?](https://getcomposer.org/doc/00-intro.md) This project follows [SemVer](https://semver.org/). This will install the latest supported version: ```bash -$ composer require clue/block-react:^1.4 +$ composer require clue/block-react:^1.5 ``` See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades. @@ -310,12 +310,12 @@ See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades. This project aims to run on any platform and thus does not require any PHP extensions and supports running on legacy PHP 5.3 through current PHP 8+ and HHVM. -It's *highly recommended to use PHP 7+* for this project. +It's *highly recommended to use the latest supported PHP version* for this project. ## Tests To run the test suite, you first need to clone this repo and then install all -dependencies [through Composer](https://getcomposer.org): +dependencies [through Composer](https://getcomposer.org/): ```bash $ composer install @@ -324,7 +324,7 @@ $ composer install To run the test suite, go to the project root and run: ```bash -$ php vendor/bin/phpunit +$ vendor/bin/phpunit ``` ## License