84 lines
3.2 KiB
Markdown
84 lines
3.2 KiB
Markdown
# servant - A Type-Level Web DSL
|
|
|
|
|
|
|
|
## Getting Started
|
|
|
|
We have a [tutorial](http://docs.servant.dev/en/stable/tutorial/index.html) that
|
|
introduces the core features of servant. After this article, you should be able
|
|
to write your first servant webservices, learning the rest from the haddocks'
|
|
examples.
|
|
|
|
The central documentation can be found [here](http://docs.servant.dev/).
|
|
Other blog posts, videos and slides can be found on the
|
|
[website](http://www.servant.dev/).
|
|
|
|
If you need help, drop by the IRC channel (#servant on freenode).
|
|
|
|
## Contributing
|
|
|
|
See `CONTRIBUTING.md`
|
|
|
|
## Release process outline (by phadej)
|
|
|
|
- Update changelog and bump versions in `master`
|
|
- `git log --oneline v0.12.. | grep 'Merge pull request'` is a good starting point (use correct previous release tag)
|
|
- Create a release branch, e.g. `release-0.13`
|
|
- Release branch is useful for backporting fixes from `master`
|
|
- Smoke test in [`servant-universe`](https://github.com/phadej/servant-universe)
|
|
- `git submodule foreach git checkout master` and `git submodule foreach git pull` to get newest of everything.
|
|
- `cabal new-build --enable-tests all` to verify that everything builds, and `cabal new-test all` to run tests
|
|
- It's a good idea to separate these steps, as tests often pass, if they compile :)
|
|
- See `cabal.project` to selectively `allow-newer`
|
|
- If some packages are broken, on your discretisation there are two options:
|
|
- Fix them and make PRs: it's good idea to test against older `servant` version too.
|
|
- Temporarily comment out broken package
|
|
- If you make a commit for `servant-universe`, you can use it as submodule in private projects to test even more
|
|
- When ripples are cleared out:
|
|
- `git tag -s` the release
|
|
- `git push --tags`
|
|
- `cabal sdist` and `cabal upload`
|
|
|
|
## travis
|
|
|
|
`.travis.yml` is generated using `make-travis-yml` tool, in
|
|
[multi-ghc-travis](https://github.com/haskell-hvr/multi-ghc-travis) repository.
|
|
|
|
To regenerate the script use (*note:* atm you need to comment `doc/cookbook/` packages).
|
|
|
|
```sh
|
|
runghc ~/Documents/other-haskell/multi-ghc-travis/make_travis_yml_2.hs regenerate
|
|
```
|
|
|
|
In case Travis jobs fail due failing build of dependency, you can temporarily
|
|
add `constraints` to the `cabal.project`, and regenerate the `.travis.yml`.
|
|
For example, the following will disallow single `troublemaker-13.37` package version:
|
|
|
|
```
|
|
constraints:
|
|
troublemaker <13.37 && > 13.37
|
|
```
|
|
|
|
## TechEmpower framework bechmarks
|
|
|
|
We develop & maintain the servant TFB entry in https://github.com/haskell-servant/FrameworkBenchmarks/
|
|
|
|
To verify (i.e. compile and test that it works)
|
|
|
|
```sh
|
|
./tfb --mode verify --test servant servant-beam servant-psql-simple --type json plaintext db fortune
|
|
```
|
|
|
|
To compare with `warp`
|
|
|
|
```sh
|
|
./tfb --mode benchmark --test warp servant servant-beam servant-psql-simple --type json plaintext db fortune
|
|
```
|
|
|
|
To compare with `reitit` (Clojure framework)
|
|
|
|
```sh
|
|
./tfb --mode benchmark --test reitit reitit-async reitit-jdbc servant servant-beam servant-psql-simple --type json plaintext db fortune
|
|
```
|
|
|
|
And visualise the results at https://www.techempower.com/benchmarks/#section=test
|