Skip to content

Release preparations #74

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

Merged
merged 13 commits into from
Feb 26, 2025
Merged

Release preparations #74

merged 13 commits into from
Feb 26, 2025

Conversation

andreasabel
Copy link
Member

@andreasabel andreasabel commented Feb 24, 2025

  • Remove vanilla Setup.hs files (legacy)
  • Drop support for GHC 7 and LTS < 9.21
  • Add READMEs to direct toward the tasty test framework

@sol I am accepting reformulations of the READMEs if you want to suggest some, see

Closes #71, closes #72.

@andreasabel andreasabel changed the title drop ghc 7 Release preparations Feb 24, 2025
@andreasabel andreasabel requested review from sol and Bodigrim February 24, 2025 21:12
@andreasabel
Copy link
Member Author

@sol Would you suggest a rewording of the READMEs?

As I understood from #62, tasty is kind of the "heir" of test-framework as it is compatible in the way functions are named.
However, alternatives are of course worth mentioning.

(Thanks to HLS for the suggestions.)

This should harden the code base against ecosystem changes like what
happened for random-1.3.

QuickCheck and HUnit are not imported qualified everywhere yet,
because HLS failed on some modules.
@andreasabel
Copy link
Member Author

I had a phone conversation with @sol resulting in a new README.

Copy link
Member

@sol sol left a comment

Choose a reason for hiding this comment

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

I think we should directly link to the README. I opened a PR against your branch for that:

#76

Other than that, this looks great. Thank you Andreas! 🙏🎉


- [hspec](https://hackage.haskell.org/package/hspec)
- [tasty](https://hackage.haskell.or/package/tasty)

Copy link

@Bodigrim Bodigrim Feb 26, 2025

Choose a reason for hiding this comment

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

It would be helpful to guide users how to migrate to modern frameworks. Here is an instruction for tasty:

### Migration to `tasty`

The following steps are sufficient for the majority of packages:

* Replace packages in `build-depends`:
  * `test-framework` -> `tasty`,
  * `test-framework-hunit` -> `tasty-hunit`,
  * `test-framework-quickcheck2` -> `tasty-quickcheck`.
* Replace module imports:
  * `Test.Framework` -> `Test.Tasty`,
  * `Test.Framework.Providers.HUnit` -> `Test.Tasty.HUnit`,
  * `Test.Framework.Providers.QuickCheck2` -> `Test.Tasty.QuickCheck`.
* Replace in type signatures:
  * `Test` -> `TestTree`.
* Replace `defaultMain tests` with `defaultMain (testGroup "All" tests)`.

Copy link
Member

Choose a reason for hiding this comment

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

This section is for "new users" and kept brief on purpose.

  1. For existing users, there is no need to necessarily migrate to anything.
  2. If existing users choose to migrate to something else, I trust them to be able to figure out themselves how to do this.
  3. If you want to provide instructions on how to migrate from test-framework to your project then I think this belongs into the documentation of your project.

Copy link
Member

@sol sol Feb 26, 2025

Choose a reason for hiding this comment

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

Also, for what it's worth:

### Migration to `hspec`
The following steps are sufficient:
 * Add to `build-depends`:
   * `hspec-test-framework`
 * Remove from`build-depends`:
   * `test-framework`
   * `test-framework-hunit`
   * `test-framework-quickcheck2`
 * Replace `test-framework-th` with `hspec-test-framework-th`

But really, I don't think any of this belongs here.

andreasabel and others added 2 commits February 26, 2025 09:25
Co-authored-by: Simon Hengel <sol@typeful.net>
Co-authored-by: ˌbodʲɪˈɡrʲim <andrew.lelechenko@gmail.com>
@andreasabel
Copy link
Member Author

I merged your suggestions.
Also -Wall is now sitting in cabal.project rather than the .cabal files, so we release with only the standard warnings on (minus -Wdeprecations).

@andreasabel andreasabel requested a review from sol February 26, 2025 09:09
Copy link
Member

@sol sol left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@andreasabel
Copy link
Member Author

@andreasabel andreasabel merged commit b81b96c into master Feb 26, 2025
13 checks passed
@andreasabel andreasabel deleted the drop-ghc-7 branch February 26, 2025 19:53
@andreasabel
Copy link
Member Author

Published!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support random-1.3 Needs a release, Hackage fell behind master
3 participants