2086eb0 · stackage · git.iko.soy

git.iko.soy/stackage

Clarify the addition of packages and building the package set.

* Packdeps can be used to make sure a package supports the latest version of all its dependencies. * The all-cabal-files repository can be used to check if newly released packages have been synced. * People who want to make an os distribution of stackage may also want to build the entire package set. * Delete old text about the disabled docker image.

commit2086eb0f142595a008279d8fd028d7cea9992227 authorAdam Bergmark <adam@bergmark.nl> dateTue 16 Aug 2016, 12:51 (10 years ago) parentfa27ed9

2 files changed+15−34

compare with master

unifiedsplit

MAINTAINERS.md+7−5 README.md+8−29

MAINTAINERS.md+7−5

@@ -3,7 +3,7 @@ This project is built around the concept of maintainers taking responsibility fo

33The idea behind Stackage is that, if all packages work with the newest versions of dependencies, we avoid dependency hell. Specifically, we aim for:

55* 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).

77* 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)).

99## Adding a package

@@ -25,10 +25,12 @@ After doing that, send a pull request (with a commit message like "add foo-bar")

2525(`build-constraints.yaml` is the most frequently changed file in this git repo

2626so commit messages like "update build-constraints.yaml" are not helpful).

2727

28−**NB2** There can be a delay of up to an hour before package versions newly

29−uploaded to Hackage appear to our build server. If you just uploaded a package

30−to Hackage that you're trying to get included, we recommend waiting an hour

31−before opening the PR.

28+**NB2** There can be a delay of up to an hour before package versions

29+newly uploaded to Hackage appear to our build server. If you just

30+uploaded a package to Hackage that you're trying to get included, we

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.

3234

3335

3436## Uploading a new package

README.md+8−29

@@ -18,7 +18,7 @@ We welcome all packages, provided:

1818

1919* The package author/maintainer agrees to the [maintainers agreement](https://github.com/fpco/stackage/blob/master/MAINTAINERS.md).

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

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

2424Full 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).

5757Build the package set

5858---------------------

5959

60−Generally, building the package set should be done only by the Stackage build

61−machine by the Stackage curation team. If you're interested in trying this

62−yourself, please check out [the curator

63−guide](https://github.com/fpco/stackage/blob/master/CURATORS.md), though be

64−aware that this is not a recommended practice and there likely will be problems

65−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−```

60+Generally only the stackage build server run by the stackage curator

61+team and people intrested in incorporating stackage snapshots into an

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

63+interested in trying this yourself, please check out

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

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

66+likely will be problems you will need to debug yourself.

8867

8968## Processing

9069