5bdaafa · stackage · git.iko.soy

git.iko.soy/stackage

Update links to this repo

commit5bdaafae46dd753598af6abad2c8335babb6171a authorAdam Bergmark <adam@bergmark.nl> dateMon 21 May 2018, 18:25 (8 years ago) parent6d7d553

6 files changed+27−27

compare with master

unifiedsplit

CURATORS.md+16−16 DATA-FLOW.md+3−3 README.md+5−5 become-a-curator.md+1−1 debian-bootstrap.sh+1−1 stackage/stackage.cabal+1−1

CURATORS.md+16−16

@@ -17,12 +17,12 @@ The following is the current list of curators, in alphabetical order:

1717This section sketches out at a high level how the entire Stackage build/curation

1818process works:

1919

20−* [build-constraints.yaml](https://github.com/fpco/stackage/blob/master/build-constraints.yaml) specifies packages to be included in Stackage

20+* [build-constraints.yaml](https://github.com/commercialhaskell/stackage/blob/master/build-constraints.yaml) specifies packages to be included in Stackage

2121* [stackage-curator](http://www.stackage.org/package/stackage-curator) combines build-constraints.yaml with the current state of Hackage to create a build plan for a Stackage Nightly

2222* stackage-curator can check that build plan to ensure all version bounds are consistent

23− * The [Travis job](https://github.com/fpco/stackage/blob/master/.travis.yml) performs these two steps to provide immediate feedback on pull requests

24−* Docker Hub [builds](https://github.com/fpco/stackage/blob/master/Dockerfile) a [Docker image](https://registry.hub.docker.com/u/snoyberg/stackage/) for running builds

25−* The stackage-build server (described below) is able to run automated builds using the [build.sh script](https://github.com/fpco/stackage/blob/master/automated/build.sh)

23+ * The [Travis job](https://github.com/commercialhaskell/stackage/blob/master/.travis.yml) performs these two steps to provide immediate feedback on pull requests

24+* Docker Hub [builds](https://github.com/commercialhaskell/stackage/blob/master/Dockerfile) a [Docker image](https://registry.hub.docker.com/u/snoyberg/stackage/) for running builds

25+* The stackage-build server (described below) is able to run automated builds using the [build.sh script](https://github.com/commercialhaskell/stackage/blob/master/automated/build.sh)

2626* When a new Nightly build is completed, it is uploaded to [the nightly repo](https://github.com/fpco/stackage-nightly)

2727* Once a week, we run an LTS minor bump. Instead of using build-constraints.yaml, that job takes the previous LTS release, turns it into constraints, and then bumps the version numbers to the latest on Hackage, in accordance with the version bounds in the build plan. This plans are uploaded to [the LTS repo](https://github.com/fpco/lts-haskell)

2828* Cutting a new LTS major release is essentially just a Stackage Nightly that gets rebuilt and uploaded as an LTS

@@ -34,7 +34,7 @@ author only added packages under his/her own name, merge it. If the

3434build later fails (see [Adding Debian packages]), then block the

3535package until it's fixed.

3636

37−[Adding Debian packages]: https://github.com/fpco/stackage/blob/master/CURATORS.md#adding-debian-packages-for-required-system-tools-or-libraries

37+[Adding Debian packages]: https://github.com/commercialhaskell/stackage/blob/master/CURATORS.md#adding-debian-packages-for-required-system-tools-or-libraries

3838

3939If benchmarks, haddocks, or test suites fails at this point we

4040typically also block the package until these issues are fixed. This in

@@ -73,13 +73,13 @@ being included immediately. This also applies to when only benchmarks

7373and tests are affected.

7474

7575* Copy the stackage-curator output and create a new issue, see e.g

76−https://github.com/fpco/stackage/issues/2108

76+https://github.com/commercialhaskell/stackage/issues/2108

7777

7878* Add a new entry under the "stackage upper bounds" section of `build-constraints.yaml`. For the above example it would be

7979

8080```yaml

8181 "Stackage upper bounds":

82− # https://github.com/fpco/stackage/issues/2108

82+ # https://github.com/commercialhaskell/stackage/issues/2108

8383 - pipes < 4.3.0

8484```

8585

@@ -90,7 +90,7 @@ https://github.com/fpco/stackage/issues/2108

9090

9191Sometimes releases for different packages are tightly coupled. Then it

9292can make sense to combine them into one issue, as in

93−https://github.com/fpco/stackage/issues/2143.

93+https://github.com/commercialhaskell/stackage/issues/2143.

9494

9595If a dependency that is not explicitly in stackage is causing test or

9696benchmark failures you can skip or expect them to fail (see "Skipping

@@ -123,7 +123,7 @@ enough time to upgrade for this case as well.

123123With the `pipes` example above there was later a new release of

124124`pipes-safe` that required the **newer** version of `pipes`. You can

125125add that package to the same upper bounds section,

126−(e.g. https://github.com/fpco/stackage/commit/6429b1eb14db3f2a0779813ef2927085fa4ad673)

126+(e.g. https://github.com/commercialhaskell/stackage/commit/6429b1eb14db3f2a0779813ef2927085fa4ad673)

127127as we want to lift them simultaneously.

128128

129129### Skipping tests and benchmarks

@@ -149,7 +149,7 @@ dependencies and compile them.

149149

150150If there are no version bounds that would fix the issue or if you

151151can't figure it out, file it

152−(e.g. https://github.com/fpco/stackage/issues/2133) to ask the

152+(e.g. https://github.com/commercialhaskell/stackage/issues/2133) to ask the

153153maintainer for help.

154154

155155### Waiting for new releases

@@ -228,7 +228,7 @@ docker rmi $(docker images -q)

228228but `docker pull snoyberg/stackage:nightly` can also be run instead just to update the nightly image say.

229229

230230For a new GHC version you should also delete the cache directories on the stackage-build server to

231−force all packages to be rebuilt. See: [issue#746](https://github.com/fpco/stackage/issues/746). Eg:

231+force all packages to be rebuilt. See: [issue#746](https://github.com/commercialhaskell/stackage/issues/746). Eg:

232232```

233233rm -r nightly/work/builds/nightly/

234234```

@@ -241,7 +241,7 @@ following command:

241241```

242242DIR=$(mktemp -d)

243243(cd $DIR \

244− && git clone https://github.com/fpco/stackage \

244+ && git clone https://github.com/commercialhaskell/stackage \

245245 && cd stackage \

246246 && docker build --tag snoyberg/stackage:nightly .)

247247rm -rf $DIR

@@ -360,7 +360,7 @@ Then, clone the stackage repo, get the latest packages and run dependency

360360resolution:

361361

362362```

363−$ git clone git@github.com:fpco/stackage.git

363+$ git clone git@github.com:commercialhaskell/stackage.git

364364$ stack update && stackage-curator check

365365```

366366

@@ -372,12 +372,12 @@ test suites and benchmarks, to check whether bounds can be lifted, and to get

372372errors for builds, tests and benchmarks.

373373

374374[the Linux binary]: https://s3.amazonaws.com/stackage-travis/stackage-curator/stackage-curator.bz2

375−[tell-me-when-its-released]: https://github.com/fpco/stackage/blob/master/CURATORS.md#waiting-for-new-releases

375+[tell-me-when-its-released]: https://github.com/commercialhaskell/stackage/blob/master/CURATORS.md#waiting-for-new-releases

376376

377377## Adding new curators

378378

3793791. Add public ssh key to `~/.ssh/authorized_keys` on build server

380−2. Add to fpco/stackage project.

380+2. Add to commercialhaskell/stackage project.

381381

382382## Dealing with a new GHC release

383383

@@ -401,4 +401,4 @@ After the first LTS release, the package pruning process may begin in the

401401nightly build in order to move forward with getting the latest versions of

402402packages compatible with the new GHC release.

403403

404−[GHC upgrade note]: https://github.com/fpco/stackage/blob/master/MAINTAINERS.md#upgrading-to-a-new-ghc-version

404+[GHC upgrade note]: https://github.com/commercialhaskell/stackage/blob/master/MAINTAINERS.md#upgrading-to-a-new-ghc-version

DATA-FLOW.md+3−3

@@ -15,7 +15,7 @@ There are three inputs into the data flow:

1515 Hackage provides both cabal file metadata (via the 00-index.tar file) and

1616 tarballs of the individual packages.

1717

18−* [build-constraints.yaml](https://github.com/fpco/stackage/blob/master/build-constraints.yaml)

18+* [build-constraints.yaml](https://github.com/commercialhaskell/stackage/blob/master/build-constraints.yaml)

1919 is the primary Stackage input file. This is where package maintainers can add

2020 packages to the Stackage package set. This also defines upper bounds, skipped

2121 tests, and a few other pieces of metadata.

@@ -60,7 +60,7 @@ The heart of running Stackage builds is the

6060[stackage-curator](https://github.com/fpco/stackage-curator) tool. We run this

6161on a daily basis on the Stackage build server for Stackage Nightly, and on a

6262weekly basis for LTS Haskell. The build process is [highly

63−automated](https://github.com/fpco/stackage/blob/master/automated/build.sh) and

63+automated](https://github.com/commercialhaskell/stackage/blob/master/automated/build.sh) and

6464leverages Docker quite a bit.

6565

6666stackage-curator needs to know about the most recent versions of all packages,

@@ -80,7 +80,7 @@ By combining these constraints with the current package data, stackage-curator

8080can generate a build plan and check it. (As an aside, this build plan

8181generation and checking also occurs every time you make a pull request to the

8282stackage repo.) If there are version bounds problems, one of the [Stackage

83−curators](https://github.com/fpco/stackage/blob/master/CURATORS.md) will open

83+curators](https://github.com/commercialhaskell/stackage/blob/master/CURATORS.md) will open

8484up a Github issue and will add upper bounds, temporarily block a package, or

8585some other corrective action.

8686

README.md+5−5

@@ -16,12 +16,12 @@ Add your package

1616

1717We welcome all packages, provided:

1818

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/commercialhaskell/stackage/blob/master/MAINTAINERS.md).

2020* 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.

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 and test 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/commercialhaskell/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

@@ -50,7 +50,7 @@ Stackage both easier and more secure:

5050* [stackage-build-plan](https://github.com/fpco/stackage-build-plan) [![Build Status](https://travis-ci.org/fpco/stackage-build-plan.svg?branch=master)](https://travis-ci.org/fpco/stackage-build-plan)

5151

5252Curious how it all fits together? See the [Stackage data

53−flow](https://github.com/fpco/stackage/blob/master/DATA-FLOW.md).

53+flow](https://github.com/commercialhaskell/stackage/blob/master/DATA-FLOW.md).

5454

5555

5656Build the package set

@@ -60,7 +60,7 @@ Generally only the stackage build server run by the stackage curator

6060team and people interested in incorporating stackage snapshots into an

6161OS distribution need to build the entire package set. If you're

6262interested in trying this yourself, please check out

63−[the curator guide](https://github.com/fpco/stackage/blob/master/CURATORS.md),

63+[the curator guide](https://github.com/commercialhaskell/stackage/blob/master/CURATORS.md),

6464though be aware that this is not a recommended practice and there

6565likely will be problems you will need to debug yourself.

6666

@@ -102,7 +102,7 @@ There are a number of answers to this question:

102102 another update in the LTS 6 line

103103* Sometimes we have upper bounds in place because other packages have

104104 problems with newer versions of dependencies. Open up the

105− [build-constraints file](https://github.com/fpco/stackage/blob/master/build-constraints.yaml)

105+ [build-constraints file](https://github.com/commercialhaskell/stackage/blob/master/build-constraints.yaml)

106106 and search for "Stackage upper bounds"

107107* Wired-in packages - those that ship with GHC and cannot be upgraded,

108108 and packages depending on them - are fixed to GHC versions. Common

become-a-curator.md+1−1

@@ -37,7 +37,7 @@ The current curator team consists of:

3737We onboarded Luke as the newest member a few months ago and this

3838helped us iron out and document the process further.

3939

40−You can read the curator documentation here: https://github.com/fpco/stackage/blob/master/CURATORS.md

40+You can read the curator documentation here: https://github.com/commercialhaskell/stackage/blob/master/CURATORS.md

4141

4242To apply, please fill in this form: [REDACTED]

4343

debian-bootstrap.sh+1−1

@@ -4,7 +4,7 @@

44# up-and-running on a freshly installed Debian-based system (including Ubuntu).

66# Quick start:

7−# wget -O - https://raw.github.com/fpco/stackage/master/debian-bootstrap.sh | bash -ex

7+# wget -O - https://raw.github.com/commercialhaskell/stackage/master/debian-bootstrap.sh | bash -ex

99# NOTE: Requires that GHC and Cabal are installed and on your PATH. For

1010# instructions, see:

stackage/stackage.cabal+1−1

@@ -26,4 +26,4 @@ library

2626

2727source-repository head

2828 type: git

29− location: git://github.com/fpco/stackage.git

29+ location: git://github.com/commercialhaskell/stackage.git