Merge pull request #1519 from haskell-servant/prepare-0.19

Changelog tweaks + servant-http-streams / servant-docs bump
haskell-servant · Feb 1, 2022 · e1b59db · e1b59db
2 parents e98ae8a + b17d018
commit e1b59db
Show file tree

Hide file tree

Showing 9 changed files with 52 additions and 20 deletions.
diff --git a/servant-auth/servant-auth-docs/servant-auth-docs.cabal b/servant-auth/servant-auth-docs/servant-auth-docs.cabal
@@ -36,7 +36,7 @@ library
   ghc-options: -Wall
   build-depends:
       base         >= 4.10    && < 4.16
-    , servant-docs >= 0.11.2  && < 0.12
+    , servant-docs >= 0.11.2  && < 0.13
     , servant      >= 0.13    && < 0.20
     , servant-auth == 0.4.*
     , lens         >= 4.16.1  && <5.1

diff --git a/servant-client-core/CHANGELOG.md b/servant-client-core/CHANGELOG.md
@@ -10,16 +10,18 @@ Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/
 
 - Drop support for GHC < 8.6.
 - Support GHC 9.0 (GHC 9.2 should work as well, but isn't fully tested yet).
-- Support Aeson 2 ([#1475](https://github.com/haskell-servant/servant/pull/1475)).
+- Support Aeson 2 ([#1475](https://github.com/haskell-servant/servant/pull/1475)),
+  which fixes a [DOS vulnerability](https://github.com/haskell/aeson/issues/864)
+  related to hash collisions.
 - Add `NamedRoutes` combinator, making support for records first-class in Servant
   ([#1388](https://github.com/haskell-servant/servant/pull/1388)).
 - Add custom type errors for partially applied combinators
   ([#1289](https://github.com/haskell-servant/servant/pull/1289),
   [#1486](https://github.com/haskell-servant/servant/pull/1486)).
-- *servant-client* / *servant-client*: Fix erroneous behavior, where only 2XX
-  status codes would be considered successful, irrelevant of the status
-  parameter specified by the verb combinator.
-  ([#1469](https://github.com/haskell-servant/servant/pull/1469))
+- *servant-client* / *servant-client-core* / *servant-http-streams*: Fix
+  erroneous behavior, where only 2XX status codes would be considered
+  successful, irrelevant of the status parameter specified by the verb
+  combinator. ([#1469](https://github.com/haskell-servant/servant/pull/1469))
 - *servant-client* / *servant-client-core*: Fix `Show` instance for
   `Servant.Client.Core.Request`.
 - *servant-client* /  *servant-client-core*: Allow passing arbitrary binary data

diff --git a/servant-client/CHANGELOG.md b/servant-client/CHANGELOG.md
@@ -10,16 +10,18 @@ Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/
 
 - Drop support for GHC < 8.6.
 - Support GHC 9.0 (GHC 9.2 should work as well, but isn't fully tested yet).
-- Support Aeson 2 ([#1475](https://github.com/haskell-servant/servant/pull/1475)).
+- Support Aeson 2 ([#1475](https://github.com/haskell-servant/servant/pull/1475)),
+  which fixes a [DOS vulnerability](https://github.com/haskell/aeson/issues/864)
+  related to hash collisions.
 - Add `NamedRoutes` combinator, making support for records first-class in Servant
   ([#1388](https://github.com/haskell-servant/servant/pull/1388)).
 - Add custom type errors for partially applied combinators
   ([#1289](https://github.com/haskell-servant/servant/pull/1289),
   [#1486](https://github.com/haskell-servant/servant/pull/1486)).
-- *servant-client* / *servant-client*: Fix erroneous behavior, where only 2XX
-  status codes would be considered successful, irrelevant of the status
-  parameter specified by the verb combinator.
-  ([#1469](https://github.com/haskell-servant/servant/pull/1469))
+- *servant-client* / *servant-client-core* / *servant-http-streams*: Fix
+  erroneous behavior, where only 2XX status codes would be considered
+  successful, irrelevant of the status parameter specified by the verb
+  combinator. ([#1469](https://github.com/haskell-servant/servant/pull/1469))
 - *servant-client* / *servant-client-core*: Fix `Show` instance for
   `Servant.Client.Core.Request`.
 - *servant-client* /  *servant-client-core*: Allow passing arbitrary binary data

diff --git a/servant-docs/CHANGELOG.md b/servant-docs/CHANGELOG.md
@@ -1,6 +1,15 @@
 [The latest version of this document is on GitHub.](https://github.com/haskell-servant/servant/blob/master/servant-docs/CHANGELOG.md)
 [Changelog for `servant` package contains significant entries for all core packages.](https://github.com/haskell-servant/servant/blob/master/servant/CHANGELOG.md)
 
+0.12
+----
+
+### Significant changes
+
+- Generate sample cURL requests
+  ([#1401](https://github.com/haskell-servant/servant/pull/1401/files)).
+  Breaking change: requires sample header values to be supplied with `headers`.
+
 0.11.9
 ------
 

diff --git a/servant-docs/servant-docs.cabal b/servant-docs/servant-docs.cabal
@@ -1,6 +1,6 @@
 cabal-version:       2.2
 name:                servant-docs
-version:             0.11.9
+version:             0.12
 
 synopsis:            generate API docs for your servant webservice
 category:            Servant, Web

diff --git a/servant-http-streams/CHANGELOG.md b/servant-http-streams/CHANGELOG.md
@@ -1,6 +1,16 @@
   [The latest version of this document is on GitHub.](https://github.com/haskell-servant/servant/blob/master/servant-http-streams/CHANGELOG.md)
 [Changelog for `servant` package contains significant entries for all core packages.](https://github.com/haskell-servant/servant/blob/master/servant/CHANGELOG.md)
 
+0.18.4
+------
+
+### Significant changes
+
+- *servant-client* / *servant-client-core* / *servant-http-streams*:
+  Fix erroneous behavior, where only 2XX status codes would be considered
+  successful, irrelevant of the status parameter specified by the verb
+  combinator. ([#1469](https://github.com/haskell-servant/servant/pull/1469))
+
 0.18.3
 ------
 

diff --git a/servant-http-streams/servant-http-streams.cabal b/servant-http-streams/servant-http-streams.cabal
@@ -1,6 +1,6 @@
 cabal-version:       2.2
 name:                servant-http-streams
-version:             0.18.3
+version:             0.18.4
 
 synopsis:            Automatic derivation of querying functions for servant
 category:            Servant, Web

diff --git a/servant-server/CHANGELOG.md b/servant-server/CHANGELOG.md
@@ -10,7 +10,9 @@ Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/
 
 - Drop support for GHC < 8.6.
 - Support GHC 9.0 (GHC 9.2 should work as well, but isn't fully tested yet).
-- Support Aeson 2 ([#1475](https://github.com/haskell-servant/servant/pull/1475)).
+- Support Aeson 2 ([#1475](https://github.com/haskell-servant/servant/pull/1475)),
+  which fixes a [DOS vulnerability](https://github.com/haskell/aeson/issues/864)
+  related to hash collisions.
 - Add `NamedRoutes` combinator, making support for records first-class in Servant
   ([#1388](https://github.com/haskell-servant/servant/pull/1388)).
 - Add custom type errors for partially applied combinators

diff --git a/servant/CHANGELOG.md b/servant/CHANGELOG.md
@@ -9,7 +9,9 @@ Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/
 
 - Drop support for GHC < 8.6.
 - Support GHC 9.0 (GHC 9.2 should work as well, but isn't fully tested yet).
-- Support Aeson 2 ([#1475](https://github.com/haskell-servant/servant/pull/1475)).
+- Support Aeson 2 ([#1475](https://github.com/haskell-servant/servant/pull/1475)),
+  which fixes a [DOS vulnerability](https://github.com/haskell/aeson/issues/864)
+  related to hash collisions.
 - Add `NamedRoutes` combinator, making support for records first-class in Servant
   ([#1388](https://github.com/haskell-servant/servant/pull/1388)).
 
@@ -89,10 +91,10 @@ Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/
 
 - Add a `HeadNoContent` verb ([#1502](https://github.com/haskell-servant/servant/pull/1502)).
 
-- *servant-client* / *servant-client*: Fix erroneous behavior, where only 2XX
-  status codes would be considered successful, irrelevant of the status
-  parameter specified by the verb combinator.
-  ([#1469](https://github.com/haskell-servant/servant/pull/1469))
+- *servant-client* / *servant-client-core* / *servant-http-streams*:
+  Fix erroneous behavior, where only 2XX status codes would be considered
+  successful, irrelevant of the status parameter specified by the verb
+  combinator. ([#1469](https://github.com/haskell-servant/servant/pull/1469))
 
 - *servant-client* / *servant-client-core*: Fix `Show` instance for
   `Servant.Client.Core.Request`.
@@ -101,11 +103,16 @@ Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/
 - *servant-client* / *servant-client-core*: Allow passing arbitrary binary data
   in Query parameters.
   ([#1432](https://github.com/haskell-servant/servant/pull/1432)).
+
+- *servant-docs*: Generate sample cURL requests
+  ([#1401](https://github.com/haskell-servant/servant/pull/1401/files)).
+
+  Breaking change: requires sample header values to be supplied with `headers`.
 
 ### Other changes
 
 - Various bit rotten cookbooks have been updated and re-introduced on
-  `haskell-servant.github.io`.
+  [docs.servant.dev](https://docs.servant.dev).
 
 - Various version bumps.