4[](https://travis-ci.org/fpco/stackage)
6"Stable Hackage": creating a vetted set of packages from Hackage.
7This repository is for package authors and maintainers to get their packages into Stackage.
8If you simply want to use Stackage as an end user, please follow the instructions on [https://www.stackage.org/](https://www.stackage.org).
10We strongly recommend using the Haskell tool stack for doing builds, which
11includes built-in Stackage support: [stack](https://github.com/commercialhaskell/stack) [](https://travis-ci.org/commercialhaskell/stack).
17We welcome all packages, provided:
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.
21* The package is compatible with the newest versions of all dependencies.
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)).
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).
26__NOTE__: There is an approximate 30 minute delay between a package uploading
27to Hackage and being available to the Travis build script to check upper
28bounds. If a pull request is marked as failed due to using an older version,
29please close and reopen the PR to retrigger a Travis build.
34The Stackage project consists of multiple repositories. This repository
35contains the metadata on packages to be included in future builds and some
36project information. In addition, we have the following repositories:
38* [stackage-server](https://github.com/fpco/stackage-server) [](https://travis-ci.org/fpco/stackage-server)
39* [stackage-curator](https://github.com/fpco/stackage-curator) [](https://travis-ci.org/fpco/stackage-curator)
40* [stackage-types](https://github.com/fpco/stackage-types) [](https://travis-ci.org/fpco/stackage-types)
41* [lts-haskell](https://github.com/fpco/lts-haskell)
42* [stackage-nightly](https://github.com/fpco/stackage-nightly)
44We also support some add-on tools to cabal-install to make its usage with
45Stackage both easier and more secure:
47* [stackage-cli](https://github.com/fpco/stackage-cli) [](https://travis-ci.org/fpco/stackage-cli)
48* [stackage-update](https://github.com/fpco/stackage-update) [](https://travis-ci.org/fpco/stackage-update)
49* [stackage-upload](https://github.com/fpco/stackage-upload) [](https://travis-ci.org/fpco/stackage-upload)
50* [stackage-install](https://github.com/fpco/stackage-install) [](https://travis-ci.org/fpco/stackage-install)
51* [stackage-build-plan](https://github.com/fpco/stackage-build-plan) [](https://travis-ci.org/fpco/stackage-build-plan)
53Curious how it all fits together? See the [Stackage data
54flow](https://github.com/fpco/stackage/blob/master/DATA-FLOW.md).
60Generally, building the package set should be done only by the Stackage build
61machine by the Stackage curation team. If you're interested in trying this
62yourself, please check out [the curator
63guide](https://github.com/fpco/stackage/blob/master/CURATORS.md), though be
64aware that this is not a recommended practice and there likely will be problems
65you will need to debug yourself.
69Note: This method has been disabled for now, but may be enabled again in the future.
71If you'd like to check a build plan, or perform an entire build, without
72specially configuring your system, Docker may be a good approach. To check if
73some modifications to `build-constraints.yaml` are valid, try the following:
751. Create a local clone of the `stackage` repo
762. Make modifications to your local `build-constraints.yaml`
773. Inside the `stackage` working directory, run the following:
80 $ docker run -it --rm -v $(pwd):/stackage -w /stackage snoyberg/stackage /bin/bash -c 'cabal update && stackage check'
83Similarly, if you'd like to perform an entire build, you can replace the last step with:
86$ docker run -it --rm -v $(pwd):/stackage -w /stackage snoyberg/stackage /bin/bash -c 'cabal update && stackage nightly --skip-upload'
91The following describes at a high level the series of steps for processing
951. Get list of core packages
962. Get build constraints from list of maintained packages
973. Load up package index
984. Calculate build plan using newest versions of packages
995. Write out a YAML file with complete build plan
1006. Verify that the build plan can be compiled
1051. Load up most recent build plan
1062. Convert build plan into constraints for next build
1073. Continue from step (3) above
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list