on master help sign in
MAINTAINERS: Improve add package instructions
b9b145eAdam Bergmark
MAINTAINERS.md+5−6
@@ -25,8 +25,7 @@ effort basis.
25
25
26Anyone can add any package to Stackage but you may only add packages under your own name. It's highly encouraged that the actual package maintainer is also the Stackage maintainer, if that is not the case you should drop the package maintainer a note first.
26Anyone can add any package to Stackage but you may only add packages under your own name. It's highly encouraged that the actual package maintainer is also the Stackage maintainer, if that is not the case you should drop the package maintainer a note first.
27
27
28−To add your package, first fork this repository.
29−In the [`build-constraints.yaml`](https://github.com/fpco/stackage/blob/master/build-constraints.yaml) file, there's a section called `packages`.
28+To add your package you can edit [`build-constraints.yaml`](https://github.com/fpco/stackage/blob/master/build-constraints.yaml) directly on github or fork the project. There's a section called `packages`.
30To add a set of packages, you would add:
29To add a set of packages, you would add:
31
30
32 "My Name <myemail@example.com> @mygithubuser":
31 "My Name <myemail@example.com> @mygithubuser":
@@ -34,16 +33,16 @@ To add a set of packages, you would add:
34 - package2
33 - package2
35 - package3
34 - package3
36
35
37−Note that the `master` branch is used for Stackage Nightly (not the `nightly` branch, which is used for the nightly docker builder imagine).
36+Note that you should edit on the `master` branch (and not the `nightly` branch, which is used for the nightly docker builder image).
38
37
39After 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
38After 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
40
39
41If you want to make sure that the package builds against the newest versions of all dependencies you can do this:
40If you want to make sure that the package builds against the newest versions of all dependencies you can do this:
42```
41```
43$ cabal update
42$ cabal update
44−$ ghc --version # Should give v8.0.2
43+$ ghc --version # Should be the same as the latest nightly, it's in the title of https://www.stackage.org/nightly
45−$ cabal get PACKAGE-VERSION # e.g. aeson-0.11.2.1
44+$ cabal get PACKAGE
46−$ cd PACKAGE-VERSION
45+$ cd PACKAGE-*
47$ cabal sandbox init # Should give "Creating a new sandbox" and not "Using an existing sandbox".
46$ cabal sandbox init # Should give "Creating a new sandbox" and not "Using an existing sandbox".
48$ cabal install --enable-tests --enable-benchmarks --dry-run | grep latest # Should give no results
47$ cabal install --enable-tests --enable-benchmarks --dry-run | grep latest # Should give no results
49$ cabal install --enable-tests --enable-benchmarks --allow-newer
48$ cabal install --enable-tests --enable-benchmarks --allow-newer