Skip to content

Commit

Permalink
prepare 4.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
pcai committed Feb 16, 2024
1 parent ec5fd17 commit daca176
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
8 changes: 6 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,16 @@

* Add your changelog entry here

### 4.0.0
### 4.0.1 (2024-02-16)

HTTPI is officially in maintenance mode. Our emphasis will now be on bugs, security fixes, and compatibility with the wider ecosystem. See [this issue](https://github.com/savonrb/httpi/issues/238) for details.

* Adds support for rack 3.0.
* POTENTIAL BREAKING CHANGE: `HTTPI::Request#headers` and `HTTPI::Response#headers` now return `Rack::Headers` instead of `Rack::Utils::HeaderHash`. This change is motivated by an upcoming change to rack 3.1.
* POTENTIAL BREAKING CHANGE: `HTTPI::Request#headers` and `HTTPI::Response#headers` now return `HTTPI::Utils::Headers` instead of `Rack::Utils::HeaderHash`. This change will prevent HTTPI from breaking or changing its public API whenever rack rearranges its classes. If you were relying on the `Rack::Utils::HeaderHash` implementation, you will need to update your code to use `HTTPI::Utils::Headers` instead.

### 4.0.0 (yanked)

Yanked due to a bug when used with rack 2.

### 3.0.2 (2024-02-10)

Expand Down
4 changes: 1 addition & 3 deletions UPDATING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,4 @@ In order to restore the old behavior, see the README section "SOCKS Proxy Suppor

## From 3.x to 4.x

BREAKING CHANGE: `HTTPI::Request#headers` and `HTTPI::Response#headers` now return `Rack::Headers` instead of `Rack::Utils::HeaderHash`. You may need to adjust any code that explicitly depends on the type of the return value of these methods.

This change was made to address a deprecation warning for a pending API change in the upcoming [rack](https://github.com/rack/rack) 3.1.
POTENTIAL BREAKING CHANGE: `HTTPI::Request#headers` and `HTTPI::Response#headers` now return `HTTPI::Utils::Headers` instead of `Rack::Utils::HeaderHash`. This change will prevent HTTPI from breaking or changing its public API whenever rack rearranges its classes. If you were relying on the `Rack::Utils::HeaderHash` implementation, you will need to update your code to use `HTTPI::Utils::Headers` instead.
2 changes: 1 addition & 1 deletion lib/httpi/version.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module HTTPI
VERSION = '4.0.0'
VERSION = '4.0.1'
end

0 comments on commit daca176

Please sign in to comment.