on master help sign in
Make the local curator guide a bit clearer.
commitf6b58a99d9bcb164445446f0977efb0f6d86db30 authorLuke Murphy <lukewm@riseup.net> dateWed 4 Jan 2017, 15:24 (10 years ago) parentea6b6b4
1 file changed+28−17
CURATORS.md+28−17
CURATORS.md+28−17
@@ -304,23 +304,34 @@ $ rm /var/stackage/stackage/automated/nightly/work/builds/nightly/prevres/Build/
304304## Local curator setup
305305
306306We do not run the full stackage build locally as that might take too
307−much time. Some steps on the other hand are much faster to do
308−yourself.
309−
310−It is useful to be able to modify constraints locally before pushing to
311−the repository. To do this first install stackage-curator:
312−`git clone git@github.com:fpco/stackage-curator.git && cd stackage-curator && stack install`
313−or get the linux binary: https://s3.amazonaws.com/stackage-travis/stackage-curator/stackage-curator.bz2
314−(it is a good idea to upgrade stackage-curator at least at the start of your week as curator).
315−Then clone the stackage repo `git clone git@github.com:fpco/stackage.git`.
316−Inside it run `stack update && stackage-curator check` to get new packages and do dependency resolution.
317−
318−This can be used to make sure all version bounds are in place
319−(including for test suites and benchmarks), to check whether bounds
320−can be lifted, and to get `tell-me-when-its-released` notifications.
321−
322−Notably this does not build anything, so you wont see any compilation
323−errors for builds/tests/benchmarks.
307+much time. However, some steps on the other hand are much faster to do
308+yourself, e.g. verifying constraints without building anything.
309+
310+To get started, install `stackage-curator` via Git, or [the Linux binary]:
311+
312+```
313+$ git clone git@github.com:fpco/stackage-curator.git
314+$ cd stackage-curator && stack install
315+```
316+
317+It is a good idea to upgrade `stackage-curator` at the start of your week.
318+Then, clone the stackage repo, get the latest packages and run dependency
319+resolution:
320+
321+```
322+$ git clone git@github.com:fpco/stackage.git
323+$ stack update && stackage-curator check
324+```
325+
326+This can be used to make sure all version bounds are in place, including for
327+test suites and benchmarks, to check whether bounds can be lifted, and to get
328+[tell-me-when-its-released] notifications.
329+
330+`stackage-curator` does not build anything, so you wont see any compilation
331+errors for builds, tests and benchmarks.
332+
333+[the Linux binary]: https://s3.amazonaws.com/stackage-travis/stackage-curator/stackage-curator.bz2
334+[tell-me-when-its-released]: https://github.com/fpco/stackage/blob/master/CURATORS.md#waiting-for-new-releases
324335
325336## Adding new curators
326337