By default, do not constrain `doctest`

haskell-CI / haskell-ci

Scripts and instructions for using CI services (e.g. Travis CI or Appveyor) with multiple GHC configurations

GNU General Public License v3.0

436 stars 71 forks source link

By default, do not constrain `doctest` #691

Closed andreasabel closed 10 months ago

andreasabel commented 10 months ago

doctest bound has been rotting too quickly. Just use the latest version by default. Can always be overwritting by doctest-version option in cabal.haskell-ci.

Closes https://github.com/haskell-CI/haskell-ci/issues/690

phadej commented 10 months ago

You can specify doctest-version: >=0 in your configuration file.

andreasabel commented 10 months ago

You can specify doctest-version: >=0 in your configuration file.

Yes of course. But good tooling has sensible defaults. Defaulting to an outdated version isn't a good default.

Removing the constraint would lead to the following workflow:

Usually doctest: True does the job.
A user that needs an older version of doctest would go looking for a way to configure the doctest version used by haskell-ci.

Currently we have:

The doctests fail.
The user may discover that nothing is wrong other than haskell-ci pinning to an outdated version.
The user wonders where this pin comes from as they haven't specified the doctest version.

phadej commented 10 months ago

Currently we have:

The doctests fail.

Do we? If they worked, they should continue to work.

And that "if it worked, and nothing is explicitly changed, it should work" is my philosophy. You may upgrade haskell-ci (which may have different major version used by default), or change the haskell-ci config or do something else - then things may break (or unbreak) - but you'll know what you have changed.

You won't make me change my mind on this.

andreasabel commented 10 months ago

Do we? If they worked, they should continue to work.

If they weren't broken, I wouldn't have gone to the effort of changing Haskell CI. Let me see if I can recover the evidence...

Got it!

here is the commit that dropped the doctest bound: https://github.com/andreasabel/generic-lens/pull/1/commits/e8428f78c9cb7c9b609d785dc3c1b2549bb72214
here is the CI run that documents that the old doctest fails to install on GHC 9.8: https://github.com/andreasabel/generic-lens/actions/runs/6970245848/job/18967757841
here is the CI run that documents the the new doctest succeeds to install on GHC 9.8: https://github.com/andreasabel/generic-lens/actions/runs/6970602089/job/18968859617#step:11:27

phadej commented 10 months ago

If they weren't broken,

You added GHC-9.8 CI, so you did change something.