3[](https://github.com/commercialhaskell/stackage/actions/workflows/check.yml)
5Stable sets of Haskell Packages from Hackage
7_This repository is for package authors and maintainers to get their packages into Stackage._
9If you simply want to use Stackage as an end user, please follow the instructions on [https://www.stackage.org/](https://www.stackage.org).
11We strongly recommend using the Haskell [stack](https://github.com/commercialhaskell/stack) tool for doing builds, which
12includes built-in Stackage support.
17We welcome all packages, provided:
19* The package author/maintainer agrees to the [maintainers agreement](https://github.com/commercialhaskell/stackage/blob/master/MAINTAINERS.md).
20* The package is buildable and testable from Hackage. We recommend [the Stack Travis script](https://docs.haskellstack.org/en/stable/travis_ci/), which ensures a package is not accidentally incomplete.
21* 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).
22* The package is compatible with the versions of libraries that ship with GHC ([more information on lenient lower bounds](https://tech.fpcomplete.com/blog/2014/05/lenient-lower-bounds)).
24Full details on how to add and test a package can be found in the [maintainers agreement](https://github.com/commercialhaskell/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 Github workflow action 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://github.com/fpco/stackage-server/actions/workflows/base.yml)
39* [curator](https://github.com/commercialhaskell/curator) 
40* [lts-haskell](https://github.com/commercialhaskell/lts-haskell)
41* [stackage-snapshots](https://github.com/commercialhaskell/stackage-snapshots/)
43Curious how it all fits together? See the [Stackage data
44flow](https://github.com/commercialhaskell/stackage/blob/master/DATA-FLOW.md).
49Generally only the stackage build server run by the stackage curator
50team and people interested in incorporating stackage snapshots into an
51OS distribution need to build the entire package set. If you're
52interested in trying this yourself, please check out
53[the curator guide](https://github.com/commercialhaskell/stackage/blob/master/CURATORS.md),
54though be aware that this is not a recommended practice and there
55likely will be problems you will need to debug yourself.
59The following describes at a high level the series of steps for processing
631. Get list of core packages
642. Get build constraints from list of maintained packages
653. Load up package index
664. Calculate build plan using newest versions of packages
675. Write out a YAML file with complete build plan
686. Verify that the build plan can be compiled
731. Load up most recent build plan
742. Convert build plan into constraints for next build
753. Continue from step (3) above
77Frequently Asked Questions
78--------------------------
80__Why is Stackage LTS still on an older version of GHC?__
82Typically it takes some months from a new major ghc release before
83the Haskell ecosystem supports it fully enough that we can push it
84to a new stable Stackage major version release. There can also be
85ghc regressions that hold up a LTS major release.
87The lag for minor ghc releases should be less
88but it still requires extra work and there is usually some delay - this also
89allows for some community testing before updating LTS.
91__Why does Stackage have an older version of a package than Hackage?__
93There are a number of answers to this question:
95* Simplest reason: how old of a Stackage snapshot are you using? Once a
96 snapshot is created, it's frozen for all time. So if you use
97 nightly-2016-01-01, by the time you get to 2018, it will be pretty dated.
98* If you're using an LTS snapshot: we lock down major versions when
99 first creating an LTS run, so subsequent minor versions will not get
100 new versions necessary. For example, if LTS 6.0 has `foo` version
101 1.2.3, and the author immediately thereafter releases a version
102 1.3.0 and never releases another 1.2.\* version, you'll never get
103 another update in the LTS 6 line
104* Sometimes we have upper bounds in place because other packages have
105 problems with newer versions of dependencies. Open up the
106 [build-constraints file](https://github.com/commercialhaskell/stackage/blob/master/build-constraints.yaml)
107 and search for "Stackage upper bounds"
108* Wired-in packages - those that ship with GHC and cannot be upgraded,
109 and packages depending on them - are fixed to GHC versions. Common
110 examples of this are containers and transformers. There's a lot more
111 information on this in
112 [an FP Complete blog post](https://tech.fpcomplete.com/blog/2014/05/lenient-lower-bounds)
114__How long do you maintain an LTS build?__
116We only guarantee that we will maintain a single LTS major version at
117a time, and that it will be maintained for at least three months. This
119[originally proposed support window](https://tech.fpcomplete.com/blog/2014/12/backporting-bug-fixes),
120and hasn't changed since then.
122That said, we do maintain the capability to keep multiple LTS runs
123operational in parallel, and with LTS 6 and 7 in fact did so. We
124aren't changing our guarantees yet on longevity of a release, but are
125trying to push out the bounds a bit farther.
127__What time are Stackage snapshots published?__
129Stackage Nightly and LTS are not released at a fixed time of day, they get
130pushed to stackage.org (and the metadata to the stackage-nightly and
131stackage-lts github repos) when their builds finish on the Stackage build
132server and the latest built haddocks have been synced over. This time varies
133greatly depending on build times for package updates, bounds breakage,
134problems with new packages being added and other build issues, etc. There are
135days when a release does not happen. LTS releases tend to happen over the
136weekend or early in the week.
138__Where to get help regarding uploading packages?__
140Please ask on the #stackage channel on the
141[Haskell Foundation Slack](https://join.slack.com/t/haskell-foundation/shared_invite/zt-mjh76fw0-CEjg2NbyVE8rVQDvR~0F4A)
142or open an issue or comment on the PR which uploads the package.
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