on master help sign in
MAINTAINERS.md: Deduplicate verify-package steps
f9500a1Adam Bergmark
MAINTAINERS.md+3−11
@@ -33,16 +33,8 @@ After doing that commit with a message like "add foo-bar" and send a pull reques
33The continuous integration job will do some checks to see if your package's dependencies are up-to-date.
33The continuous integration job will do some checks to see if your package's dependencies are up-to-date.
34
34
35The CI job notably doesn't compile packages, run tests, build documentation, or find missing C libraries.
35The CI job notably doesn't compile packages, run tests, build documentation, or find missing C libraries.
36−If you want to be proactive or if CI fails, you can make sure that your package builds against the latest nightly:
36+If you want to be proactive or if CI fails, you can make sure that your package builds against the latest nightly.
37−
37+See the [verify-package](https://github.com/commercialhaskell/stackage/blob/master/verify-package) script in this repository.
38−```
39−# Build from the tarball on Hackage to check for missing files
40−$ stack unpack yourpackage && cd yourpackage-*
41−# Generate a pristine stack.yaml, adding any missing extra-deps
42−$ rm -f stack.yaml && stack init --resolver nightly
43−# Build, generate docs, test, and build benchmarks
44−$ stack build --resolver nightly --haddock --test --bench --no-run-benchmarks
45−```
46
38
47This approach works well, but has two limitations you should be aware
39This approach works well, but has two limitations you should be aware
48of:
40of:
@@ -173,7 +165,7 @@ ending in `.0`), the package set is taken from Stackage Nightly. Therefore, by
173following the above steps, you can get your package into the next major LTS
165following the above steps, you can get your package into the next major LTS
174Haskell release.
166Haskell release.
175
167
176−If you would like to get your package added to the current LTS Haskell
168+If you would like to get your package added to the current LTS Haskell
177major release, please do the following in addition to the steps for Nightly described earlier:
169major release, please do the following in addition to the steps for Nightly described earlier:
178
170
179* Check that your package can be built with the current LTS version (e.g. `stack build --test --bench --haddock --resolver lts`)
171* Check that your package can be built with the current LTS version (e.g. `stack build --test --bench --haddock --resolver lts`)