git.iko.soy/stackage
on master help sign in
Clarify the addition of packages and building the package set.
2086eb0Adam Bergmark
MAINTAINERS.md+7−5
compare with master
unifiedsplit
@@ -3,7 +3,7 @@ This project is built around the concept of maintainers taking responsibility fo
3The idea behind Stackage is that, if all packages work with the newest versions of dependencies, we avoid dependency hell. Specifically, we aim for:
3The idea behind Stackage is that, if all packages work with the newest versions of dependencies, we avoid dependency hell. Specifically, we aim for:
4
4
5* All packages are buildable and testable from Hackage. We recommend [the Stack Travis script](http://docs.haskellstack.org/en/stable/GUIDE.html#travis-with-caching), which ensures a package is not accidentally incomplete.
5* All packages are buildable and testable from Hackage. We recommend [the Stack Travis script](http://docs.haskellstack.org/en/stable/GUIDE.html#travis-with-caching), which ensures a package is not accidentally incomplete.
6−* All packages are compatible with the newest versions of all dependencies.
6+* All packages are compatible with the newest versions of all dependencies (You can verify this by checking http://packdeps.haskellers.com/feed?needle=PACKAGENAME).
7* All packages in a snapshot are compatible with the versions of libraries that ship with the GHC used in the snapshot ([more information on lenient lower bounds](https://www.fpcomplete.com/blog/2014/05/lenient-lower-bounds)).
7* All packages in a snapshot are compatible with the versions of libraries that ship with the GHC used in the snapshot ([more information on lenient lower bounds](https://www.fpcomplete.com/blog/2014/05/lenient-lower-bounds)).
8
8
9## Adding a package
9## Adding a package
@@ -25,10 +25,12 @@ After doing that, send a pull request (with a commit message like "add foo-bar")
25(`build-constraints.yaml` is the most frequently changed file in this git repo
25(`build-constraints.yaml` is the most frequently changed file in this git repo
26so commit messages like "update build-constraints.yaml" are not helpful).
26so commit messages like "update build-constraints.yaml" are not helpful).
27
27
28−**NB2** There can be a delay of up to an hour before package versions newly
28+**NB2** There can be a delay of up to an hour before package versions
29−uploaded to Hackage appear to our build server. If you just uploaded a package
29+newly uploaded to Hackage appear to our build server. If you just
30−to Hackage that you're trying to get included, we recommend waiting an hour
30+uploaded a package to Hackage that you're trying to get included, we
31−before opening the PR.
31+recommend waiting an hour before opening the PR. You can also verify
32+this by making sure the latest version is listed in
33+https://github.com/commercialhaskell/all-cabal-files/tree/master/PACKAGENAME.
32
34
33
35
34## Uploading a new package
36## Uploading a new package
README.md+8−29
@@ -18,7 +18,7 @@ We welcome all packages, provided:
18
18
19* The package author/maintainer agrees to the [maintainers agreement](https://github.com/fpco/stackage/blob/master/MAINTAINERS.md).
19* The package author/maintainer agrees to the [maintainers agreement](https://github.com/fpco/stackage/blob/master/MAINTAINERS.md).
20* The package is buildable and testable from Hackage. We recommend [the Stack Travis script](http://docs.haskellstack.org/en/stable/GUIDE.html#travis-with-caching), which ensures a package is not accidentally incomplete.
20* The package is buildable and testable from Hackage. We recommend [the Stack Travis script](http://docs.haskellstack.org/en/stable/GUIDE.html#travis-with-caching), which ensures a package is not accidentally incomplete.
21−* The package is compatible with the newest versions of all dependencies.
21+* The package is compatible with the newest versions of all dependencies (You can verify this by checking http://packdeps.haskellers.com/feed?needle=PACKAGENAME).
22* 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)).
22* 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)).
23
23
24Full 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).
24Full 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).
@@ -57,34 +57,13 @@ flow](https://github.com/fpco/stackage/blob/master/DATA-FLOW.md).
57Build the package set
57Build the package set
58---------------------
58---------------------
59
59
60−Generally, building the package set should be done only by the Stackage build
60+Generally only the stackage build server run by the stackage curator
61−machine by the Stackage curation team. If you're interested in trying this
61+team and people intrested in incorporating stackage snapshots into an
62+OS distribution need to build the entire package set. If you're
62−yourself, please check out [the curator
63+interested in trying this yourself, please check out
63−guide](https://github.com/fpco/stackage/blob/master/CURATORS.md), though be
64+[the curator guide](https://github.com/fpco/stackage/blob/master/CURATORS.md),
64−aware that this is not a recommended practice and there likely will be problems
65+though be aware that this is not a recommended practice and there
65−you will need to debug yourself.
66+likely will be problems you will need to debug yourself.
66−
67−### Docker
68−
69−Note: This method has been disabled for now, but may be enabled again in the future.
70−
71−If you'd like to check a build plan, or perform an entire build, without
72−specially configuring your system, Docker may be a good approach. To check if
73−some modifications to `build-constraints.yaml` are valid, try the following:
74−
75−1. Create a local clone of the `stackage` repo
76−2. Make modifications to your local `build-constraints.yaml`
77−3. Inside the `stackage` working directory, run the following:
78−
79− ```
80− $ docker run -it --rm -v $(pwd):/stackage -w /stackage snoyberg/stackage /bin/bash -c 'cabal update && stackage check'
81− ```
82−
83−Similarly, if you'd like to perform an entire build, you can replace the last step with:
84−
85−```
86−$ docker run -it --rm -v $(pwd):/stackage -w /stackage snoyberg/stackage /bin/bash -c 'cabal update && stackage nightly --skip-upload'
87−```
88
67
89## Processing
68## Processing
90
69