doctest-0.25.0

[mihaimaruseac]

doctest-0.25.0 (changelog) (Simon Hengel sol@typeful.net @sol) is out of bounds for:

• co-log-core-0.3.2.6 (>=0.16.0 && < 0.25). Andreas Ländle @alaendle. Used by: test-suite
• no-recursion-0.4.0.0 (^>=0.21.1 || ^>=0.22.2 || ^>=0.24.0). Greg Pfeil greg@technomadic.org @sellout. Used by: test-suite
• polysemy-1.9.2.0 (>=0.16.0.1 && < 0.25). Torsten Schmits stackage@schmits.me @tek. Used by: test-suite
• polysemy-plugin-0.4.5.3 (>=0.16.0.1 && < 0.25). Torsten Schmits stackage@schmits.me @tek. Used by: test-suite
• relude-1.2.2.2 (>=0.20 && < 0.25). Tom Ellis tom-stackage@jaguarpaw.co.uk @tomjaguarpaw. Used by: test-suite
• servant-auth-docs-0.2.11.0 (>=0.16 && < 0.25). Domen Kozar domen@enlambda.com @domenkozar. Used by: test-suite
• servant-swagger-1.2.3 (>=0.17 && < 0.25). Haskell Servant haskell-servant-maintainers@googlegroups.com. Used by: test-suite
• tasty-checklist-1.0.9.0 (>=0.10 && < 0.25). Frank Dedden frank@systemf.dev @fdedden. Used by: test-suite
• yaya-1.0.0.0 (^>=0.16.2 || ^>=0.18.1 || ^>=0.20.1 || ^>=0.21.1 || ^>=0.22.2 || ^>=0.24.0). Greg Pfeil greg@technomadic.org @sellout. Used by: test-suite
• yaya-containers-1.0.0.0 (^>=0.16.2 || ^>=0.18.1 || ^>=0.20.1 || ^>=0.21.1 || ^>=0.22.2 || ^>=0.24.0). Greg Pfeil greg@technomadic.org @sellout. Used by: test-suite
• yaya-hedgehog-1.0.0.0 (^>=0.16.2 || ^>=0.18.1 || ^>=0.20.1 || ^>=0.21.1 || ^>=0.22.2 || ^>=0.24.0). Greg Pfeil greg@technomadic.org @sellout. Used by: test-suite
• yaya-quickcheck-1.0.0.0 (^>=0.16.2 || ^>=0.18.1 || ^>=0.20.1 || ^>=0.21.1 || ^>=0.22.2 || ^>=0.24.0). Greg Pfeil greg@technomadic.org @sellout. Used by: test-suite
• yaya-unsafe-1.0.0.1 (^>=0.16.2 || ^>=0.18.1 || ^>=0.20.1 || ^>=0.21.1 || ^>=0.22.2 || ^>=0.24.0). Greg Pfeil greg@technomadic.org @sellout. Used by: test-suite

For now I'm going to put an upper bound on doctest to not have tests silently disabled for everyone, but in the future we might change it so that packages that still don't accept the new version of doctest will have testing disabled.

[sol]

Please use cabal doctest to run Doctest:

$ cabal update
$ cabal install --ignore-project doctest --flag cabal-doctest
$ cabal doctest

If it does not work for you then please open an issue.

See documentation: https://github.com/sol/doctest#cabal-integration

NB: Don't use -w with cabal-install-3.16.* and GHC < 9.4.1, due to haskell/cabal#11373

Regarding breaking changes:

1. I will continue to bump the major version on breaking changes that may affect a small minority of users. The breaking change in this specific release is related to how response files are handled (before you could put doctest and ghc options into response files, now only the ghc options). However, you most likely don't use response files, and if you were using response files, you most likely didn't put doctest options in them.
2. I don't randomly introduce breaking changes that will affect a wide range of users.
   • I may want to switch the default from --magic to --no-magic and eventually even get rid of --magic (it's basically broken for modern cabal, but some stack users may still rely on it)
   • I may at some point wanna try to avoid the GHC API for parsing, but for such a drastic change I would probably do a super major version bump (1.0, or maybe 0.99 as a pre-release first).
3. Ask yourself if it is really worth your time to use upper bounds to guard yourself against a hypothetical breaking change to your tests in 10 years. If you insist on using upper bounds then maybe consider something like < 0.90.

But really, just use cabal doctest and pin ghc and cabal versions (ghc and cabal are way more likely to break your tests than doctest).

Similarly, if you're using hspec use < 3 as an upper bound (unless you heavily rely on internals from hspec-core like the exact shape of the internal tree, even here I do everything I can to avoid breakage, but some features required the addition of new fields...).

Two final points:

• introducing random breaking changes to widely used software is disrespectful to your users
• tight upper bounds evidently don't scale; GHC 9.14.1 has been out for months and you can still not build many major package without running into dependency issues

[mihaimaruseac]

We'll probably need to update for Stack

[juhp]

Thanks for the detailed comment @sol - I could suggest most packages could just use doctest < 1.

I think Stackage could use commenter to disable the affected package tests.