097b645 · stackage · git.iko.soy

git.iko.soy/stackage

Add instructions for testing a package against the latest versions of dependencies

commit097b64503dda18920460b33a45604950e0d6fc0e authorAdam Bergmark <adam@bergmark.nl> dateWed 17 Aug 2016, 13:51 (10 years ago) parent404cd4b

2 files changed+15−3

compare with master

unifiedsplit

MAINTAINERS.md+14−2 README.md+1−1

MAINTAINERS.md+14−2

@@ -21,6 +21,18 @@ To add a set of packages, you would add:

2121

2222After doing that, send a pull request (with a commit message like "add foo-bar"). We do not require new submissions to be tested against the rest of Stackage before the pull request (though it is a good idea to do so if you can with `stack --resolver nightly exec stackage-curator check` and `stack --resolver nightly build`), provided you meet the dependency version requirements above. If your library depends on a C library, add a note to your pull request with the Ubuntu library name, or even better edit the `debian-bootstrap.sh` script directly

2323

24+If you want to make sure that the package builds against the newest versions of all dependecies you can do this:

25+```

26+$ cabal update

27+$ ghc --version # Should give v8.0.1

28+$ cabal get PACKAGE-VERSION # e.g. aeson-0.11.2.1

29+$ cd PACKAGE-VERSION

30+$ cabal sandbox init # Should give "Creating a new sandbox" and not "Using an existing sandbox".

31+$ cabal install --enable-tests --enable-benchmarks --dry-run | grep latest # Should give no results

32+$ cabal install --enable-tests --enable-benchmarks --allow-newer

33+$ cabal test

34+```

35+

2436**NB** Please use commit messages like "add foo-bar" or "add johndev's packages"

2537(`build-constraints.yaml` is the most frequently changed file in this git repo

2638so commit messages like "update build-constraints.yaml" are not helpful).

@@ -28,8 +40,8 @@ so commit messages like "update build-constraints.yaml" are not helpful).

2840**NB2** There can be a delay of up to an hour before package versions

2941newly uploaded to Hackage appear to our build server. If you just

3042uploaded a package to Hackage that you're trying to get included, we

31−recommend waiting an hour before opening the PR. You can also verify

32−this by making sure the latest version is listed in

43+recommend waiting an hour before opening the PR. You can verify this

44+by making sure the latest version is listed in

3345https://github.com/commercialhaskell/all-cabal-files/tree/master/PACKAGENAME.

3446

3547

README.md+1−1

@@ -21,7 +21,7 @@ We welcome all packages, provided:

2121* The package is compatible with the newest versions of all dependencies (You can find restrictive upper bounds by visiting http://packdeps.haskellers.com/feed?needle=PACKAGENAME).

2222* The package is compatible with the versions of libraries that ship with GHC ([more information on lenient lower bounds](https://www.fpcomplete.com/blog/2014/05/lenient-lower-bounds)).

2323

24−Full details on how to add a package can be found in the [maintainers agreement](https://github.com/fpco/stackage/blob/master/MAINTAINERS.md#adding-a-package).

24+Full details on how to add and test a package can be found in the [maintainers agreement](https://github.com/fpco/stackage/blob/master/MAINTAINERS.md#adding-a-package).

2525

2626__NOTE__: There is an approximate 30 minute delay between a package uploading

2727to Hackage and being available to the Travis build script to check upper