Skip to content

Prepare release #149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Oct 31, 2018
Merged

Prepare release #149

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f556f62
Update change log
sagikazarmark Oct 28, 2018
8206151
Update readme
sagikazarmark Oct 28, 2018
b65f81b
Prepare release
sagikazarmark Oct 29, 2018
553478d
Remove branch alias
sagikazarmark Oct 29, 2018
e3b49c7
Update PSR-18 dependency version
sagikazarmark Oct 29, 2018
89e11fc
Fix changelog
sagikazarmark Oct 29, 2018
ad519a2
Mention in the readme that new implementations should use PSR-18
sagikazarmark Oct 29, 2018
4c5db9f
Make requested changes
sagikazarmark Oct 29, 2018
9f1ea9c
Update readme
sagikazarmark Oct 30, 2018
4db7163
Update change log
sagikazarmark Oct 30, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 36 additions & 14 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# Change Log

## 2.0.0 - UNRELEASED

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).


## [Unreleased]


## [2.0.0] - 2018-10-29

This version is no BC break for consumers using HTTPlug. However, HTTP clients that
implement HTTPlug need to adjust because we add return type declarations.
Expand All @@ -9,40 +19,41 @@ implement HTTPlug need to adjust because we add return type declarations.

- Support for PSR-18 (HTTP client).

### Changed

- **BC Break:** `HttpClient::sendRequest(RequestInterface $request)` has a return type annotation. The new
signature is `HttpClient::sendRequest(RequestInterface $request): ResponseInterface`.
- **BC Break:** `RequestException::getRequest()` has a return type annotation. The new
signature is `RequestException::getRequest(): RequestInterface`.

### Removed

- PHP 5 support

### Changed

- [BC Break] `HttpClient::sendRequest(RequestInterface $request)` has a return type annotation. The new
signature is `HttpClient::sendRequest(RequestInterface $request): ResponseInterface`.
- [BC Break] `RequestException::getRequest()` has a return type annotation. The new
signature is `RequestException::getRequest(): RequestInterface`.

## 1.1.0 - 2016-08-31
## [1.1.0] - 2016-08-31

### Added

- HttpFulfilledPromise and HttpRejectedPromise which respect the HttpAsyncClient interface


## 1.0.0 - 2016-01-26
## [1.0.0] - 2016-01-26

### Removed

- Stability configuration from composer


## 1.0.0-RC1 - 2016-01-12
## [1.0.0-RC1] - 2016-01-12

### Changed

- Updated package files
- Updated promise dependency to RC1


## 1.0.0-beta - 2015-12-17
## [1.0.0-beta] - 2015-12-17

### Added

Expand All @@ -53,7 +64,7 @@ signature is `RequestException::getRequest(): RequestInterface`.
- Exception concept


## 1.0.0-alpha3 - 2015-12-13
## [1.0.0-alpha3] - 2015-12-13

### Changed

Expand All @@ -64,14 +75,14 @@ signature is `RequestException::getRequest(): RequestInterface`.
- Promise interface moved to its own repository: [php-http/promise](https://github.com/php-http/promise)


## 1.0.0-alpha2 - 2015-11-16
## [1.0.0-alpha2] - 2015-11-16

### Added

- Async client and Promise interface


## 1.0.0-alpha - 2015-10-26
## [1.0.0-alpha] - 2015-10-26

### Added

Expand All @@ -93,3 +104,14 @@ signature is `RequestException::getRequest(): RequestInterface`.
### Added

- Initial release


[Unreleased]: https://github.com/php-http/httplug/compare/v2.0.0...HEAD
[2.0.0]: https://github.com/php-http/httplug/compare/v1.1.0...HEAD
[1.1.0]: https://github.com/php-http/httplug/compare/v1.0.0...v1.1.0
[1.0.0]: https://github.com/php-http/httplug/compare/v1.0.0-RC1...v1.0.0
[1.0.0-RC1]: https://github.com/php-http/httplug/compare/v1.0.0-beta...v1.0.0-RC1
[1.0.0-beta]: https://github.com/php-http/httplug/compare/v1.0.0-alpha3...v1.0.0-beta
[1.0.0-alpha3]: https://github.com/php-http/httplug/compare/v1.0.0-alpha2...v1.0.0-alpha3
[1.0.0-alpha2]: https://github.com/php-http/httplug/compare/v1.0.0-alpha...v1.0.0-alpha2
[1.0.0-alpha]: https://github.com/php-http/httplug/compare/v0.1.0...v1.0.0-alpha
17 changes: 9 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,15 @@
**HTTPlug, the HTTP client abstraction for PHP.**


## Intro

HTTPlug served as a reference is the predecessor of [PSR-18](https://github.com/php-fig/fig-standards/blob/master/accepted/http-client/http-client.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/served as a reference//

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and we should mention that version 2 of httplug extends the psr-18 interfaces to allow a convenient migration path.

HTTP Client standard. Since there is an entire ecosystem built around HTTPlug and since it's already widely adapted,
this package stays available, but new implementations and consumers should use the PSR-18 interfaces.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could we say instead "we will keep maintaining this package for the time being, but new ..."


This library is the official successor of the [ivory http adapter](https://github.com/egeloen/ivory-http-adapter).


## Install

Via Composer
Expand All @@ -22,14 +31,6 @@ $ composer require php-http/httplug
```


## Intro

This is the contract package for HTTP Client.
Use it to create HTTP Clients which are interoperable and compatible with [PSR-7](http://www.php-fig.org/psr/psr-7/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'd love to keep mentioning PSR-7 somewhere in the intro


This library is the official successor of the [ivory http adapter](https://github.com/egeloen/ivory-http-adapter).


## Documentation

Please see the [official documentation](http://docs.php-http.org).
Expand Down
7 changes: 1 addition & 6 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"require": {
"php": "^7.0",
"psr/http-message": "^1.0",
"psr/http-client": "^0.3",
"psr/http-client": "^1.0",
"php-http/promise": "^1.0"
},
"require-dev": {
Expand All @@ -32,10 +32,5 @@
"scripts": {
"test": "vendor/bin/phpspec run",
"test-ci": "vendor/bin/phpspec run -c phpspec.ci.yml"
},
"extra": {
"branch-alias": {
"dev-2.x": "2.0.x-dev"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should alias master to 2.x-dev when this is merged.

}
}
}