Update LTS minor instructions for curator-2

`CONSTRAINTS` is now deprecated
This commit is contained in:
Jens Petersen 2019-10-13 11:04:19 +02:00 committed by GitHub
parent d3f8058dde
commit 3ab9f9cadd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -283,28 +283,21 @@ we're just not there yet.
/opt/stackage-build/stackage/automated/run-nightly.sh
# Run an LTS minor bump
/opt/stackage-build/stackage/automated/build.sh lts-2.17
/opt/stackage-build/stackage/automated/build-next.sh lts-14.17
# Run an LTS major bump
/opt/stackage-build/stackage/automated/build.sh lts-3.0
/opt/stackage-build/stackage/automated/build-next.sh lts-15.0
```
Recommended: run these from inside a `tmux` session. If you get version bound
problems on nightly or LTS major, you need to fix build-constraints.yaml (see
info above). For an LTS minor bump, you'll typically want to use the
`CONSTRAINTS` environment variable, e.g.:
info above). For an LTS minor bump, you'll typically want to:
```
CONSTRAINTS='--constraint "conduit < 1.4.5" --constraint "criterion < 1.2.3"' /opt/stackage-build/stackage/automated/build.sh lts-2.17
```
* Add constraints to package `range:` fields in eg `work/lts14/constraints.yaml`.
* Add new packages versioned to eg `work/lts14/snapshot-incomplete.yaml` (the `@<hash>` suffix is optional)
* Test, benchmark, haddock failures can also be added to package fields in eg `work/lts14/constraints.yaml` if necessary, though it should be avoided if possible for LTS.
Valid arguments to include in this environment variable:
* `--constraint` to modify an upper or lower bound
* `--add-package` to add a brand new package
* `--expect-test-failure` to expect tests to fail
* `--expect-haddock-failure` to expect haddocks to fail
* `--expect-bench-failure` to expect benchmarks to fail
This replaces `CONSTRAINTS=...' /opt/stackage-build/stackage/automated/build.sh lts-x.y` for the old curator-1.
If a build fails for bounds reasons, see all of the advice above. If the code
itself doesn't build, or tests fail, open up an issue and then either put in a
@ -320,7 +313,7 @@ if one needs to revert one package, say due to a build or test regression,
one can edit `current-plan.yaml` and updated the SHA256 hash of the .cabal file,
to avoid having to rebuild everything again.)
Note LTS builds inherit the current Hackage data (stack updated for Nigthly) to avoid excess extra rebuilding.
_Sadly no longer true currently_: ~~Note LTS builds inherit the current Hackage data (stack updated for Nigthly) to avoid excess extra rebuilding.~~
### Timing