diff --git a/CHANGELOG.markdown b/CHANGELOG.markdown deleted file mode 100644 --- a/CHANGELOG.markdown +++ /dev/null @@ -1,334 +0,0 @@ -Release Notes -============= - -All notable changes to this project will be documented in this file. - -This project is versioned according to the [Package Versioning Policy](https://pvp.haskell.org), the -*de facto* standard Haskell versioning scheme. - - -1.0.1.0 -------- - -- **Date** 2018-02-13 -- **Git tag** [hunit-dejafu-1.0.1.0][] -- **Hackage** https://hackage.haskell.org/package/hunit-dejafu-1.0.1.0 - -### Test.HUnit.DejaFu - -- New `testDejafusDiscard` function (#200). - -[hunit-dejafu-1.0.1.0]: https://github.com/barrucadu/dejafu/releases/tag/hunit-dejafu-1.0.1.0 - - ---------------------------------------------------------------------------------------------------- - - -1.0.0.0 -------- - -- **Date** 2017-12-23 -- **Git tag** [hunit-dejafu-1.0.0.0][] -- **Hackage** https://hackage.haskell.org/package/hunit-dejafu-1.0.0.0 - -### Test.HUnit.DejaFu - -- The `ConcST` functions have been removed and replaced by the `ConcIO` functions. -- The `Testable` and `Assertable` instances for `ConcST t ()` are gone. -- All test functions are generalised to take a `ProPredicate`. -- All test functions now take the action to test as the last parameter. - -### Miscellaneous - -- The minimum supported version of dejafu is now 1.0.0.0. - -[hunit-dejafu-1.0.0.0]: https://github.com/barrucadu/dejafu/releases/tag/hunit-dejafu-1.0.0.0 - - ---------------------------------------------------------------------------------------------------- - - -0.7.1.1 -------- - -- **Date** 2017-11-30 -- **Git tag** [hunit-dejafu-0.7.1.1][] -- **Hackage** https://hackage.haskell.org/package/hunit-dejafu-0.7.1.1 - -### Test.HUnit.DejaFu - -- Fix a missing `@since` annotation. - -[hunit-dejafu-0.7.1.1]: https://github.com/barrucadu/dejafu/releases/tag/hunit-dejafu-0.7.1.1 - - ---------------------------------------------------------------------------------------------------- - - -0.7.1.0 -------- - -- **Date** 2017-11-30 -- **Git tag** [hunit-dejafu-0.7.1.0][] -- **Hackage** https://hackage.haskell.org/package/hunit-dejafu-0.7.1.0 - -### Test.HUnit.DejaFu - -- A new `testPropertyFor` function for checking refinement properties with a custom number of seed - values and variable assignments. - -[hunit-dejafu-0.7.1.0]: https://github.com/barrucadu/dejafu/releases/tag/hunit-dejafu-0.7.1.0 - - ---------------------------------------------------------------------------------------------------- - - -0.7.0.2 -------- - -- **Date** 2017-10-11 -- **Git tag** [hunit-dejafu-0.7.0.2][] -- **Hackage** https://hackage.haskell.org/package/hunit-dejafu-0.7.0.2 - -### Miscellaneous - -- dejafu-0.9 support - -[hunit-dejafu-0.7.0.2]: https://github.com/barrucadu/dejafu/releases/tag/hunit-dejafu-0.7.0.2 - - ---------------------------------------------------------------------------------------------------- - - -0.7.0.1 -------- - -- **Date** 2017-09-26 -- **Git tag** [hunit-dejafu-0.7.0.1][] -- **Hackage** https://hackage.haskell.org/package/hunit-dejafu-0.7.0.1 - -### Miscellaneous - -- dejafu-0.8 support - -[hunit-dejafu-0.7.0.1]: https://github.com/barrucadu/dejafu/releases/tag/hunit-dejafu-0.7.0.1 - - ---------------------------------------------------------------------------------------------------- - - -0.7.0.0 -------- - -- **Date** 2017-08-10 -- **Git tag** [hunit-dejafu-0.7.0.0][] -- **Hackage** https://hackage.haskell.org/package/hunit-dejafu-0.7.0.0 - -### Test.HUnit.DejaFu - -- Two new functions: `testDejafuDiscard` and `testDejafuDiscardIO`, allowing you to selectively - discard results or traces. -- The `Discard` type and `defaultDiscarder` function from dejafu is now re-exported. - -### Miscellaneous - -- Lower version bound on dejafu raised to 0.7.1.0. - -[hunit-dejafu-0.7.0.0]: https://github.com/barrucadu/dejafu/releases/tag/hunit-dejafu-0.7.0.0 - - ---------------------------------------------------------------------------------------------------- - - -0.6.0.0 -------- - -- **Date** 2017-06-07 -- **Git tag** [hunit-dejafu-0.6.0.0][] -- **Hackage** https://hackage.haskell.org/package/hunit-dejafu-0.6.0.0 - -### Test.HUnit.DejaFu - -- The refinement property testing functionality of dejafu is exposed in the new `testProperty` - function, and re-exported values. -- Due to changes in dejafu, the `Way` type is now abstract and exposes smart constructor functions: - - `systematically`, corresponding to the old `Systematically`. - - `randomly`, corresponding to the old `Randomly`. - - `uniformly`, a new uniform random (as opposed to weighted random) scheduler. - - `swarmy`, corresponding to the old `Randomly` and specifying how many executions to use the - same weights for. -- The `defaultWay`, `defaultMemType`, and `defaultBounds` values are all now re-exported. - -### Miscellaneous - -- Only dejafu 0.7 is supported. - -[hunit-dejafu-0.6.0.0]: https://github.com/barrucadu/dejafu/releases/tag/hunit-dejafu-0.6.0.0 - - ---------------------------------------------------------------------------------------------------- - - -0.5.0.0 -------- - -- **Date** 2017-04-08 -- **Git tag** [hunit-dejafu-0.5.0.0][] -- **Hackage** https://hackage.haskell.org/package/hunit-dejafu-0.5.0.0 - -### Test.HUnit.DejaFu - -- Due to changes in dejafu, the `Way` type no longer takes a parameter; it is now a GADT. - -### Miscellaneous - -- There is now a changelog. -- Every definition and instance now has a Haddock "@since" annotation. -- Only dejafu 0.6 is supported. - -[hunit-dejafu-0.5.0.0]: https://github.com/barrucadu/dejafu/releases/tag/hunit-dejafu-0.5.0.0 - - ---------------------------------------------------------------------------------------------------- - - -0.4.0.1 -------- - -- **Date** 2017-03-20 -- **Git tag** [hunit-dejafu-0.4.0.1][] -- **Hackage** https://hackage.haskell.org/package/hunit-dejafu-0.4.0.1 - -### Miscellaneous - -- Now supports HUnit 1.6. - -[hunit-dejafu-0.4.0.1]: https://github.com/barrucadu/dejafu/releases/tag/hunit-dejafu-0.4.0.1 - - ---------------------------------------------------------------------------------------------------- - - -0.4.0.0 -------- - -- **Date** 2017-02-21 -- **Git tag** [hunit-dejafu-0.4.0.0][] -- **Hackage** https://hackage.haskell.org/package/hunit-dejafu-0.4.0.0 - -### Test.HUnit.DejaFu - -- All the functions which did take a `Bounds` now take a `Way` instead and support random scheduling - as well. -- The `Way` type from dejafu is now re-exported. - -### Miscellaneous - -- The minimum supported version of dejafu has been increased to 0.5 (from 0.2) - -[hunit-dejafu-0.4.0.0]: https://github.com/barrucadu/dejafu/releases/tag/hunit-dejafu-0.4.0.0 - - ---------------------------------------------------------------------------------------------------- - - -0.3.0.3 -------- - -- **Date** 2016-10-22 -- **Git tag** [hunit-dejafu-0.3.0.3][] -- **Hackage** https://hackage.haskell.org/package/hunit-dejafu-0.3.0.3 - -### Miscellaneous - -- Now supports HUnit 1.4 and 1.5. - -[hunit-dejafu-0.3.0.3]: https://github.com/barrucadu/dejafu/releases/tag/hunit-dejafu-0.3.0.3 - - ---------------------------------------------------------------------------------------------------- - - -0.3.0.2 -------- - -- **Date** 2016-09-10 -- **Git tag** [hunit-dejafu-0.3.0.2][] -- **Hackage** https://hackage.haskell.org/package/hunit-dejafu-0.3.0.2 - -### Miscellaneous - -- Now supports concurrency 1.0.0.0 and dejafu 0.4.0.0 - -[hunit-dejafu-0.3.0.2]: https://github.com/barrucadu/dejafu/releases/tag/hunit-dejafu-0.3.0.2 - - ---------------------------------------------------------------------------------------------------- - - -0.3.0.1 -------- - -- **Date** 2016-05-26 -- **Git tag** [hunit-dejafu-0.3.0.1][] -- **Hackage** https://hackage.haskell.org/package/hunit-dejafu-0.3.0.1 - -### Miscellaneous - -- Now supports GHC 8. - -[hunit-dejafu-0.3.0.1]: https://github.com/barrucadu/dejafu/releases/tag/hunit-dejafu-0.3.0.1 - - ---------------------------------------------------------------------------------------------------- - - -0.3.0.0 -------- - -- **Date** 2016-04-28 -- **Git tag** [hunit-dejafu-0.3.0.0][] -- **Hackage** https://hackage.haskell.org/package/hunit-dejafu-0.3.0.0 - -### Test.HUnit.DejaFu - -- New `Assertable` and `Testable` instances for `ConcST t ()` and `ConcIO ()`. -- The `Bounds` type from dejafu is now re-exported. - -### Miscellaneous - -- Now supports dejafu 0.2 (again). - -[hunit-dejafu-0.3.0.0]: https://github.com/barrucadu/dejafu/releases/tag/hunit-dejafu-0.3.0.0 - - ---------------------------------------------------------------------------------------------------- - - -0.2.1.0 -------- - -- **Date** 2016-04-03 -- **Git tag** [hunit-dejafu-0.2.1.0][] -- **This version was never pushed to hackage, whoops!** - -### Miscellaneous - -- Now supports dejafu 0.3, but drops support for dejafu 0.2. - -[hunit-dejafu-0.2.1.0]: https://github.com/barrucadu/dejafu/releases/tag/hunit-dejafu-0.2.1.0 - - ---------------------------------------------------------------------------------------------------- - - -0.2.0.0 -------- - -- **Date** 2015-12-01 -- **Git tag** [0.2.0.0][] -- **Hackage** https://hackage.haskell.org/package/hunit-dejafu-0.2.0.0 - -Initial release. Go read the API docs. - -[0.2.0.0]: https://github.com/barrucadu/dejafu/releases/tag/0.2.0.0 diff --git a/CHANGELOG.rst b/CHANGELOG.rst new file mode 100644 --- /dev/null +++ b/CHANGELOG.rst @@ -0,0 +1,310 @@ +Release Notes +============= + +This project is versioned according to the PVP_, the *de facto* +standard Haskell versioning scheme. + +.. _PVP: https://pvp.haskell.org/ + + +1.0.1.1 (2018-02-22) +-------------------- + +* Git: :tag:`hunit-dejafu-1.0.1.1` +* Hackage: :hackage:`hunit-dejafu-1.0.1.1` + +Miscellaneous +~~~~~~~~~~~~~ + +* The upper bound on :hackage:`dejafu` is <1.2. + + +1.0.1.0 (2018-02-13) +-------------------- + +* Git: :tag:`hunit-dejafu-1.0.1.0` +* Hackage: :hackage:`hunit-dejafu-1.0.1.0` + +Added +~~~~~ + +* (:pull:`200`) ``Test.HUnit.DejaFu.testDejafusDiscard`` function. + + +1.0.0.0 - The API Friendliness Release (2017-12-23) +--------------------------------------------------- + +* Git: :tag:`hunit-dejafu-1.0.0.0` +* Hackage: :hackage:`hunit-dejafu-1.0.0.0` + +Added +~~~~~ + +* (:issue:`124`) Re-exports of ``Test.DejaFu.Predicate`` and + ``ProPredicate``. + +Changed +~~~~~~~ + +* All testing functions require ``MonadConc``, ``MonadRef``, and + ``MonadIO`` constraints. Testing with ``ST`` is no longer possible. + +* (:issue:`123`) All testing functions take the action to run as the + final parameter. + +* (:issue:`124`) All testing functions have been generalised to take a + ``Test.DejaFu.ProPredicate`` instead of a ``Predicate``. + +Removed +~~~~~~~ + +* The ``Test.DejaFu.Conc.ConcST`` specific functions. + +* The orphan ``Testable`` and ``Assertable`` instances for + ``Test.DejaFu.Conc.ConcST t ()``. + +Miscellaneous +~~~~~~~~~~~~~ + +* The version bounds on :hackage:`dejafu` are >=1.0 && <1.1. + + +0.7.1.1 (2017-11-30) +-------------------- + +* Git: :tag:`hunit-dejafu-0.7.1.1` +* Hackage: :hackage:`hunit-dejafu-0.7.1.1` + +Fixed +~~~~~ + +* A missing Haddock ``@since`` comments. + + +0.7.1.0 (2017-11-30) +-------------------- + +* Git: :tag:`hunit-dejafu-0.7.1.0` +* Hackage: :hackage:`hunit-dejafu-0.7.1.0` + +Added +~~~~~ + +* ``Test.HUnit.DejaFu.testPropertyFor`` function. + + +0.7.0.2 (2017-10-11) +-------------------- + +* Git: :tag:`hunit-dejafu-0.7.0.2` +* Hackage: :hackage:`hunit-dejafu-0.7.0.2` + +Miscellaneous +~~~~~~~~~~~~~ + +* The upper bound on :hackage:`dejafu` is <0.10. + + +0.7.0.1 (2017-09-26) +-------------------- + +* Git: :tag:`hunit-dejafu-0.7.0.1` +* Hackage: :hackage:`hunit-dejafu-0.7.0.1` + +Miscellaneous +~~~~~~~~~~~~~ + +* The upper bound on :hackage:`dejafu` is <0.9. + + +0.7.0.0 - The Discard Release (2017-08-10) +------------------------------------------ + +* Git: :tag:`hunit-dejafu-0.7.0.0` +* Hackage: :hackage:`hunit-dejafu-0.7.0.0` + +Added +~~~~~ + +* Re-export for ``Test.DejaFu.SCT.Discard`` and + ``Test.DejaFu.Defaults.defaultDiscarder``. + +* ``Test.HUnit.DejaFu.testDejafuDiscard`` and ``testDejafuDiscardIO`` + functions. + +Miscellaneous +~~~~~~~~~~~~~ + +* The lower bound on :hackage:`dejafu` is >=0.7.1. + + +0.6.0.0 - The Refinement Release (2017-06-07) +--------------------------------------------- + +* Git: :tag:`hunit-dejafu-0.6.0.0` +* Hackage: :hackage:`hunit-dejafu-0.6.0.0` + +Added +~~~~~ + +* ``Test.HUnit.DejaFu.testProperty`` function + +* Re-exports for ``Test.DejaFu.SCT.systematically``, ``randomly``, + ``uniformly``, and ``swarmy``. + +* Re-exports for ``Test.DejaFu.Defaults.defaultWay``, + ``defaultMemType``, and ``defaultBounds``. + +Removed +~~~~~~~ + +* Re-exports of the ``Test.DejaFu.SCT.Way`` constructors: + ``Systematically`` and ``Randomly``. + +Miscellaneous +~~~~~~~~~~~~~ + +* The version bounds on :hackage:`dejafu` are >=0.7 && <0.8. + + +0.5.0.0 - The Way Release (2017-04-08) +-------------------------------------- + +* Git: :tag:`hunit-dejafu-0.5.0.0` +* Hackage: :hackage:`hunit-dejafu-0.5.0.0` + +Changed +~~~~~~~ + +* Due to changes in :hackage:`dejafu`, the ``Way`` type no longer + takes a parameter; it is now a GADT. + +Miscellaneous +~~~~~~~~~~~~~ + +* Every definition, class, and instance now has a Haddock ``@since`` + annotation. + +* The version bounds on :hackage:`dejafu` are >=0.6 && <0.7. + +* Remove an unnecessary dependency on :hackage:`random`. + + +0.4.0.1 (2017-03-20) +-------------------- + +* Git: :tag:`hunit-dejafu-0.4.0.1` +* Hackage: :hackage:`hunit-dejafu-0.4.0.1` + +Miscellaneous +~~~~~~~~~~~~~ + +* The upper bound on :hackage:`HUnit` is <1.7. + + +0.4.0.0 (2017-02-21) +-------------------- + +* Git: :tag:`hunit-dejafu-0.4.0.0` +* Hackage: :hackage:`hunit-dejafu-0.4.0.0` + +Added +~~~~~ + +* Re-export of ``Test.DejaFu.SCT.Way``. + +Changed +~~~~~~~ + +* All the functions which took a ``Test.DejaFu.SCT.Bounds`` now take a + ``Way``. + +Miscellaneous +~~~~~~~~~~~~~ + +* The version bounds on :hackage:`dejafu` are >=0.5 && <0.6. + +* Dependency on :hackage:`random` with bounds >=1.0 && <1.2. + + +0.3.0.3 (2016-10-22) +-------------------- + +* Git: :tag:`hunit-dejafu-0.3.0.3` +* Hackage: :hackage:`hunit-dejafu-0.3.0.3` + +Miscellaneous +~~~~~~~~~~~~~ + +* The upper bound on :hackage:`HUnit` is <1.6. + + +0.3.0.2 (2016-09-10) +-------------------- + +* Git: :tag:`hunit-dejafu-0.3.0.2` +* Hackage: :hackage:`hunit-dejafu-0.3.0.2` + +Miscellaneous +~~~~~~~~~~~~~ + +* The upper bound on :hackage:`dejafu` is <0.5. + + +0.3.0.1 (2016-05-26) +-------------------- + +* Git: :tag:`hunit-dejafu-0.3.0.1` +* Hackage: :hackage:`hunit-dejafu-0.3.0.1` + +Miscellaneous +~~~~~~~~~~~~~ + +* The lower bound on :hackage:`base` is >=4.8. + +* The upper bound on :hackage:`dejafu` is <0.4. + + +0.3.0.0 (2016-04-28) +-------------------- + +* Git: :tag:`hunit-dejafu-0.3.0.0` +* Hackage: :hackage:`hunit-dejafu-0.3.0.0` + +Added +~~~~~ + +* Orphan ``Assertable`` and ``Testable`` instances for + ``Test.DejaFu.Conc.ConcST t ()`` and ``ConcIO ()``. + +* Re-export ``Test.DejaFu.SCT.Bounds``. + +Miscellaneous +~~~~~~~~~~~~~ + +* The version bounds on :hackage:`dejafu` are >=0.2 + + +0.2.1.0 (2016-04-03) +-------------------- + +* Git: :tag:`hunit-dejafu-0.2.1.0` + +**Note:** this was never pushed to Hackage, whoops! + +Miscellaneous +~~~~~~~~~~~~~ + +* The version bounds on :hackage:`dejafu` are 0.3.*. + + +0.2.0.0 - The Initial Release (2015-12-01) +------------------------------------------ + +* Git: :tag:`0.2.0.0` +* Hackage: :hackage:`hunit-dejafu-0.2.0.0` + +Added +~~~~~ + +* Everything. diff --git a/hunit-dejafu.cabal b/hunit-dejafu.cabal --- a/hunit-dejafu.cabal +++ b/hunit-dejafu.cabal @@ -2,7 +2,7 @@ -- documentation, see http://haskell.org/cabal/users-guide/ name: hunit-dejafu -version: 1.0.1.0 +version: 1.0.1.1 synopsis: Deja Fu support for the HUnit test framework. description: @@ -20,7 +20,7 @@ copyright: (c) 2015--2017 Michael Walker category: Testing build-type: Simple -extra-source-files: README.markdown CHANGELOG.markdown +extra-source-files: README.markdown CHANGELOG.rst cabal-version: >=1.10 source-repository head @@ -30,7 +30,7 @@ source-repository this type: git location: https://github.com/barrucadu/dejafu.git - tag: hunit-dejafu-1.0.1.0 + tag: hunit-dejafu-1.0.1.1 library exposed-modules: Test.HUnit.DejaFu @@ -38,7 +38,7 @@ -- other-extensions: build-depends: base >=4.8 && <5 , exceptions >=0.7 && <0.9 - , dejafu >=1.0 && <1.1 + , dejafu >=1.0 && <1.2 , HUnit >=1.2 && <1.7 -- hs-source-dirs: default-language: Haskell2010