Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

testuite: doctest: move to ghcup-recommended ghc #8710

Merged
merged 1 commit into from
Feb 1, 2023

Conversation

ulysses4ever
Copy link
Collaborator

@ulysses4ever ulysses4ever commented Jan 29, 2023

Another stub at #8504: choosing to upgrade existing doctest rather than anything else mentioned in the ticket. It looks like, our issue with upgrading GHC 8.10 -> 9.2 was due to the default -XGHC2021 adopted in 9.2, and nomeata suggested an easy fix (thanks!) to explicitly request -XHaskell2010.

I'm sad to declare defeat at trying to switch to the recommended way of using doctest these days (namely, via cabal repl) due to a failure described in #8504 (comment) It's not only sad because we're using a not (officially) supported way of communication with doctest, but also because we have to employ cabal-env, which has an unclear maintenance status.

I also took a liberty to use ghcup set ghc recommended (which is currently 9.2.5) instead of a specific version or version matrix for a couple of reasons:

  • the other "quick job" "Meta checks" have been using it since 475222d
  • it makes sense for explicitly secondary job (referring to the name "Quick jobs") to use just one GHC instead of e.g. the whole support window;
  • trying single GHC saves time on CI;
  • using recommended instead of a specific version will make sure that we're moving forward even if slowly instead of being stuck on one version until someone remembers to upgrade.

Please include the following checklist in your PR:

Please also shortly describe how you tested your change. Bonus points for added tests!

@ulysses4ever
Copy link
Collaborator Author

Also sadly, this doesn't address #8147 because it's still quite tricky to run doctest locally because of the cabal-env business. #8703 i.e. switching to the official way of running doctest via cabal repl may be the right way of solving it, but as noted above and in #8703, this doesn't quite work yet (works for Cabal-syntax but doesn't work for Cabal because the latter's doctests depend on QuickCheck).

ghcup install ghc 8.10.7
ghcup set ghc 8.10.7
ghcup install ghc recommended
ghcup set ghc recommended
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is optimistic, but let's try it.

Copy link
Member

@Mikolaj Mikolaj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you.

@ulysses4ever ulysses4ever added the merge me Tell Mergify Bot to merge label Jan 30, 2023
@ulysses4ever ulysses4ever linked an issue Jan 30, 2023 that may be closed by this pull request
@mergify mergify bot added the merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days label Feb 1, 2023
@ulysses4ever ulysses4ever force-pushed the ap/move-doctest-to-recommended-ghc branch from 4a082ed to ce2c92f Compare February 1, 2023 19:30
@mergify mergify bot merged commit a5ddb14 into master Feb 1, 2023
@Mikolaj
Copy link
Member

Mikolaj commented Feb 1, 2023

@ulysses4ever: shall we backport immediately or wait until in case it bombs out on master soon?

@ulysses4ever
Copy link
Collaborator Author

@Mikolaj I doubt it will blow anything but as for backporting, I don't feel strongly either way because it's not a user-visible change.

@Mikolaj
Copy link
Member

Mikolaj commented Feb 2, 2023

If this, potentially, improves CI and/or its stability, it's worth porting, because the 3.10 branch is going to stay there for a while.

@ulysses4ever
Copy link
Collaborator Author

@mergify backport 3.10

@mergify
Copy link
Contributor

mergify bot commented Feb 3, 2023

backport 3.10

✅ Backports have been created

@ulysses4ever
Copy link
Collaborator Author

@Mikolaj you're welcome to approve #8731!

@andreasabel andreasabel deleted the ap/move-doctest-to-recommended-ghc branch February 3, 2023 16:23
@Mikolaj
Copy link
Member

Mikolaj commented Feb 4, 2023

@ulysses4ever: thank you! CI got cancelled there, so I'm rerunning and keeping watch.

mergify bot added a commit that referenced this pull request Feb 4, 2023
testuite: doctest: move to ghcup-recommended ghc (backport #8710)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
continuous-integration merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days merge me Tell Mergify Bot to merge re: doctest Concerning doctest suites
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update/upgrade/switch away from our current doctest tool in CI
3 participants