Skip to content

Commit 7d29970

Browse files
committed
Merge master and fix conflicts
2 parents 6801446 + cc1e921 commit 7d29970

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+612
-1106
lines changed

.travis.yml

Lines changed: 69 additions & 68 deletions
Large diffs are not rendered by default.

CONTRIBUTING.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,34 @@ Some things we like:
3535
Though we aren't sticklers for style, the `.stylish-haskell.yaml` and `HLint.hs`
3636
files in the repository provide a good baseline for consistency.
3737

38-
**Important**: please do not modify the changelog files nor the versions of the servant packages you are sending patches for. We take care of this before every release and do it uniformly for all the servant packages, so there's no need to worry about this for your pull requests.
38+
**Important**: please do not modify the versions of the servant packages you are sending patches for.
39+
40+
## Changelog entries
41+
42+
We experiment with using [changelog-d tool](https://github.com/phadej/changelog-d) to assemble changelogs.
43+
You are not required to install it.
44+
45+
In each PR please add a file to `changelog.d` directory named after issue you are solving or the pull request itself (in a separate commit after you know the pull request number). For example
46+
47+
```cabal
48+
synopsis: One sentence summary of the change.
49+
prs: #1219
50+
issues: #1028
51+
52+
description: {
53+
54+
A longer description. Small changes don't need this.
55+
Bigger ones definitely do, for example we try to include migration hints
56+
for breaking changes.
57+
58+
However if you don't know what to write, that's ok too.
59+
60+
By the way, the braces around are omitted when the file is parsed.
61+
They can be used so the field doesn't need to be indented, which is handy
62+
for prose.
63+
64+
}
65+
```
3966

4067
## PR process
4168

Makefile

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,13 @@ build-ghcjs :
2020

2121
packdeps :
2222
packdeps */*.cabal
23+
24+
doctest : doctest-servant doctest-servant-server
25+
perl -i -e 'while (<ARGV>) { print unless /package-id\s+base-compat-\d+(\.\d+)*/; }' .ghc.environment.*
26+
27+
doctest-servant :
28+
(cd servant && doctest src)
29+
(cd servant && doctest test/Servant/LinksSpec.hs)
30+
31+
doctest-servant-server :
32+
(cd servant-server && doctest src)

cabal.haskell-ci

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
distribution: bionic
12
folds: all-but-test
23
branches: master
34
jobs-selection: any
45
google-chrome: True
56
ghcjs-tests: True
7+
doctest: True
8+
doctest-filter-packages: base-compat-batteries
9+
doctest-skip: tutorial
610

711
-- https://github.com/haskell/cabal/issues/6176
812
ghcjs-tools: hspec-discover

cabal.project

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ packages:
1515
servant-pipes/
1616

1717
-- servant GHCJS
18-
packages:
19-
servant-jsaddle/
18+
-- packages:
19+
-- servant-jsaddle/
2020

2121
-- Cookbooks
2222
packages:
@@ -38,8 +38,6 @@ packages:
3838
doc/cookbook/using-free-client
3939
-- doc/cookbook/open-id-connect
4040

41-
42-
4341
tests: True
4442
optimization: False
4543
-- reorder-goals: True
@@ -62,3 +60,8 @@ allow-newer: openssl-streams-1.2.2.0:network
6260
-- MonadFail
6361
-- https://github.com/nurpax/sqlite-simple/issues/74
6462
constraints: sqlite-simple < 0
63+
64+
constraints: base-compat ^>=0.11
65+
66+
-- needed for doctests
67+
write-ghc-environment-files: always

changelog.d/config

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
organization: haskell-servant
2+
repository: servant

changelog.d/issue1028

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
synopsis: Add NoContentVerb
2+
prs: #1228 #1219
3+
issues: #1028
4+
significance: significant
5+
6+
description: {
7+
8+
The `NoContent` API endpoints should now use `NoContentVerb` combinator.
9+
The API type changes are usually of the kind
10+
11+
```diff
12+
- :<|> PostNoContent '[JSON] NoContent
13+
+ :<|> PostNoContent
14+
```
15+
16+
i.e. one doesn't need to specify the content-type anymore. There is no content.
17+
18+
}

changelog.d/issue1200

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
synopsis: Fix Verb with headers checking content type differently
2+
packages: servant-client-core servant-client
3+
prs: #1204
4+
issues: #1200
5+
packages: servant-client servant-client-core servant-http-streams
6+
7+
description: {
8+
9+
For `Verb`s with response `Headers`, the implementation didn't check
10+
for the content-type of the response. Now it does.
11+
12+
}

changelog.d/issue1240

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
synopsis: Merge documentation from duplicate routes
2+
packages: servant-docs
3+
prs: #1241
4+
issues: #1240
5+
6+
description: {
7+
8+
Servant supports defining the same route multiple times with different
9+
content-types and result-types, but servant-docs was only documenting
10+
the first of copy of such duplicated routes. It now combines the
11+
documentation from all the copies.
12+
13+
Unfortunately, it is not yet possible for the documentation to specify
14+
multiple status codes.
15+
16+
}

changelog.d/jsaddle

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
synopsis: Progress on servant-jsaddle
2+
packages: servant-jsaddle
3+
prs: #1216

0 commit comments

Comments
 (0)