Prepare for the 1.0.0-MF release by kailuowang · Pull Request #1702 · typelevel/cats

kailuowang · 2017-05-25T17:43:55Z

Update:

The process started July 27 and last for a couple of days, mainly due to the coordination needed between cats and cats-mtl). Here are the steps:

1. release 1.0.0-MF binary to maven central
2. build cats-mtl against it and release
3. draft a mtl migration guide and incorporate it into the current migration guide in Prepare for the 1.0.0-MF release #1702
4. merge Prepare for the 1.0.0-MF release #1702 and update readme , publish website
5. announce the release.

As mentioned in the description, 1.0.0-MF is a draft for the final API of cats 1.0. Our user community will have the next couple of months to validate this draft and propose changes.

The merged changes are included in the CHANGES.md. Let's talk about the outstanding items.

Here are the outstanding PRs scheduled for 1.0.0-MF

Maintainers, if you have time, please help review, we can push them over the finish line.

Here are the outstanding issues scheduled for 1.0.0-MF

MTL removal plan MTL removal plan #1616 PR in MTL is dead, long live MTL #1751
1.0.0 packaging Cats 1.0.0 packaging #1682
standardize between Eval.defer and Free.suspend Why does Eval use defer while Free uses suspend? #1635
StateT law violations StateT violates laws #1714
SplitLaw doesn't hold in general SplitLaw doesn't hold in general #1567 - //continued on Cats-1567 Replace Split with Commutative Arrow. Introduces Commutative Monad. #1719
Foldable instance for List breaks substitution Foldable instance for List breaks substitution #1716
ReaderWriterStateT type parameter order ReaderWriterStateT type parameter order #1763

The ones with "?" are the ones that I'm uncertain if they should or can go into 1.0.0-MF. Also obviously, these aren't the complete set of outstanding issues and PRs. It was mostly just me scheduling them based on their impacts and my personal taste. So please chime in if you see anything you would like to go in 1.0.0-MF but not in this list. I would prioritize API changes over others, since this release is a draft for the final API for cats 1.0.

Let the party begins.

UPDATEs:

removed Separate default implementations from type class definitions #992 due to consensus
removed Ported IO#ensuring (and renamed to avoid mass confusion) #1662 according to discussion.
removed add optional to Applicative #1560 according to discussion
removed cats.Traverse should implement cats.Foldable #107 and Multiple things are prefixed withBi- meaning different things. #1297 which will be continued in the next release.

kailuowang · 2017-05-25T17:58:36Z

Also we have 14 19 new first-time contributors! 💯

update: 5 more first-time contributors

codecov-io · 2017-05-28T15:25:26Z

Codecov Report

Merging #1702 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1702   +/-   ##
=======================================
  Coverage   94.87%   94.87%           
=======================================
  Files         241      241           
  Lines        4139     4139           
  Branches      103      103           
=======================================
  Hits         3927     3927           
  Misses        212      212

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 784aa10...55ffbf4. Read the comment docs.

i-am-the-slime · 2017-05-30T06:22:04Z

I was going to wish for a way to do MTL style but that's supposed to be removed instead? I guess it requires a better typeclass encoding?

LukaJCB · 2017-05-30T07:18:21Z

@i-am-the-slime It's going to be its own separate module, cats-mtl. I think you can find it here. Check issues #1616 and #1210 :)

andyscott · 2017-06-12T17:10:22Z

I will finish the PR for #1600 this week.

andyscott · 2017-06-27T22:39:06Z

+
+To migrate from 0.9.0
+
+ * `cats.free.Inject` is moved from `cats.free` to `cats.core` and renamed to `cats.InjectK`;


this implies moving to a cats.core package-- maybe use cats-core and cats-free to refer to modules?

thanks! corrected.

andyscott · 2017-06-27T22:39:40Z

+   instead. The easiest way might be this [sbt-plugin](https://github.com/fiadliel/sbt-partial-unification).
+ * The creation methods (`left`, `right`, `apply`, `pure`, etc.) in `EitherT` is improved to take less
+   type arguments.
+ * Several `cats.core` type class instances for `cats.kernel` were moved from their compainion objects to separate traits


similar to above, this implies a cats.core package

DavidGregory084 · 2017-07-19T22:23:15Z

+
+ * `cats` no longer publish the all included bundle package `"org.typelevel" % "cats"`, use `cats-core`, `cats-free`, or `cats-law` 
+   accordingly instead. If you need `cats.free`, use `"org.typelevel" % "cats-free"`, if you need `cats-law` use 
+   `"org.typelevel" % "cats-law"`, if neither, use `"org.typelevel" % "cats-core"`.


I think it is cats-laws rather than cats-law?

You are right, thanks for the review.

peterneyens · 2017-07-27T22:25:57Z

 ```

-This will pull in all of Cats' modules. If you only require some
+This will pull in the cats-core module. If you require some other functionlaity


"functionality"

peterneyens · 2017-07-27T22:28:19Z

-To migrate from 0.9.0
+### To migrate from 0.9.0
+
+Appology for the number of breaking changes in this release. We are trying to include


alexandru · 2017-07-31T10:54:52Z

+#### Generic libraries to support pure functional programming

- * [Circe](https://github.com/circe/circe): pure functional JSON library.
+ * [cats-effects](https://github.com/typelevel/cats-effect): provide a standard `IO` type for the cats ecosystem


Project name is cats-effect (singular).

Also, this project doesn't provide just IO, but also the Sync, Async and Effect type classes, which I think are important, since this is an innovation.

alexandru · 2017-07-31T10:55:38Z


- * [Circe](https://github.com/circe/circe): pure functional JSON library.
+ * [cats-effects](https://github.com/typelevel/cats-effect): provide a standard `IO` type for the cats ecosystem
+ * [cats-mtl](https://github.com/typelevel/cats-mtl): ??????


cats-effect and cats-mtl deserve their own category imo, as they are sub-modules of Cats, just like cats-kernel, but with a different release cycle.

In fact alleycats and mouse probably fall into that category as well. But I am not sure how to name this category though. These projects all have different set of maintainers and thus are more independent from each other than just submodules of cats with different release cycle.

alexandru · 2017-07-31T10:56:17Z

+## <a name="getting-started" href="#getting-started"></a>Getting Started


 Cats is currently available for Scala 2.10, 2.11 and 2.12.


A mention that Cats supports Scala.js would be nice

edmundnoble

Wonderful work, sorry for all the nitpicks :)

edmundnoble · 2017-08-02T01:20:30Z

+
+### To migrate from 0.9.0
+
+Apology for the number of breaking changes in this release. We are trying to include


I recommend "we apologize".

edmundnoble · 2017-08-02T01:22:50Z

+### To migrate from 0.9.0
+
+Apology for the number of breaking changes in this release. We are trying to include
+as many breaking changes in this release before we lock down the API. 


I recommend "as many breaking changes in this release as possible".

edmundnoble · 2017-08-02T01:23:00Z

+Apology for the number of breaking changes in this release. We are trying to include
+as many breaking changes in this release before we lock down the API. 
+
+ * `cats` no longer publish the all inclusive bundle package `"org.typelevel" % "cats"`, use `cats-core`, `cats-free`, or `cats-law` 


"all-inclusive" here.

edmundnoble · 2017-08-02T01:41:42Z

+   instead. The easiest way might be this [sbt-plugin](https://github.com/fiadliel/sbt-partial-unification).
+ *  `FunctorFilter`, `MonadCombine`, `MonadFilter`, `MonadReader`, `MonadState`, `MonadTrans`, `MonadWriter` and `TraverseFilter` are no longer in `cats`, the functionalities they provided are inhereted by the new [cats-mtl](https://github.com/edmundnoble/cats-mtl) project. Please check [here](https://github.com/edmundnoble/cats-mtl#migration-guide) for migration guide. 
+ * `CartesianBuilder` (i.e. `|@|`) syntax is deprecated, use the apply syntanx on tuples instead. E.g. `(x |@| y |@| z).map(...)` should be replaced by `(x, y, z).mapN(...)`
+ * The creation methods (`left`, `right`, `apply`, `pure`, etc.) in `EitherT` is improved to take less


"were improved"

edmundnoble · 2017-08-02T03:16:56Z

+ * `foldLeftM` is removed from `Free`, use `foldM` on `Foldable` instead, see #1117 for detail. 
+ * `iteratorFoldM` was removed from `Foldable` due to #1716
+ * Apply syntax on tuple (e.g. `(x, y, z).map3(...)`)  was moved from `cats.syntax.tuple._` to `cats.syntax.apply._` and renamed to `mapN`, `contramapN` and `imapN` respectively.
+ * `Split` is removed, the method `split` is moved to `Arrow`. Note that only under `CommutativeArrow` does it guarantee the non-interference between the effects. see #1567


I'd add an and here after the comma.

edmundnoble · 2017-08-02T03:58:32Z

+
+ * [`cats-effect`](https://github.com/typelevel/cats-effect): `IO`, `Sync`, `Async` and `Effect` type classes for the cats ecosystem
+ * [`cats-mtl`](https://github.com/edmundnoble/cats-mtl): transformer typeclasses for cats' Monads, Applicatives and Functors.
+ * [`alleycats`](https://github.com/non/alleycats): Cats instances and classes which are outlaws, miscreants, and ne'er-do-wells.


Maybe we can be a bit more descriptive here. Perhaps "cats instances and classes which are not lawful"?

durban · 2017-08-02T07:44:44Z

+   enabled syntax ops are also removed. Please use the partial unification SI-2712 fix
+   instead. The easiest way might be this [sbt-plugin](https://github.com/fiadliel/sbt-partial-unification).
+ *  `FunctorFilter`, `MonadCombine`, `MonadFilter`, `MonadReader`, `MonadState`, `MonadTrans`, `MonadWriter` and `TraverseFilter` are no longer in `cats`, the functionalities they provided are inhereted by the new [cats-mtl](https://github.com/edmundnoble/cats-mtl) project. Please check [here](https://github.com/edmundnoble/cats-mtl#migration-guide) for migration guide. 
+ * `CartesianBuilder` (i.e. `|@|`) syntax is deprecated, use the apply syntanx on tuples instead. E.g. `(x |@| y |@| z).map(...)` should be replaced by `(x, y, z).mapN(...)`


"syntanx" -> "syntax"

durban · 2017-08-02T07:48:07Z

+ * `CartesianBuilder` (i.e. `|@|`) syntax is deprecated, use the apply syntanx on tuples instead. E.g. `(x |@| y |@| z).map(...)` should be replaced by `(x, y, z).mapN(...)`
+ * The creation methods (`left`, `right`, `apply`, `pure`, etc.) in `EitherT` is improved to take less
+   type arguments.
+ * Several `cats-core` type class instances for `cats.kernel` were moved from their compainion objects to separate traits


"compainion" -> "companion"

durban · 2017-08-02T07:52:58Z

+ * [#1691](https://github.com/typelevel/cats/pull/1691): Build JVM before JS on travis. by @peterneyens
+ * [#1677](https://github.com/typelevel/cats/pull/1677): Update readme with the new dev channel.. by @kailuowang
+ * [#1673](https://github.com/typelevel/cats/pull/1673): Use 2 workers in JVM build. by @ceedubs
+ * [#1671](https://github.com/typelevel/cats/pull/1671): Fixing `Eq[Function1]` in testsJS; break JS build to separate matrix build.. by @kailuowang


There are 2 "."-s

durban · 2017-08-02T07:53:41Z

+ * [#1591](https://github.com/typelevel/cats/pull/1591): Improve test coverage. by @peterneyens
+ * [#1590](https://github.com/typelevel/cats/pull/1590): Check monad laws for `Cokleisli`. by @peterneyens
+ * [#1588](https://github.com/typelevel/cats/pull/1588): Docs/Tutorial -- Simplify `Kleisli` example. by @RawToast
+ * [#1581](https://github.com/typelevel/cats/pull/1581): restore the alphabetical order of maintainers list.. by @kailuowang


durban · 2017-08-02T07:54:08Z

+ * [#1566](https://github.com/typelevel/cats/pull/1566): Fix mistake in documentation of `Group.remove`. by @LukaJCB
+ * [#1563](https://github.com/typelevel/cats/pull/1563): Remove references of the NEL `OneAnd` alias. by @peterneyens
+ * [#1561](https://github.com/typelevel/cats/pull/1561): Fix incorrect numbering in `FreeMonads` doc. by @cb372
+ * [#1555](https://github.com/typelevel/cats/pull/1555): by fix scala.js badge version @xuwei-k


Move "by" to the end.

kailuowang · 2017-08-02T14:42:08Z

@edmundnoble and @durban thanks so much for the review. feedback addressed.

peterneyens · 2017-08-03T17:45:45Z

+We apologize for the number of breaking changes in this release. We are trying to include
+as many breaking changes as possible in this release before we lock down the API. 
+
+ * `cats` no longer publish the all-inclusive bundle package `"org.typelevel" % "cats"`, use `cats-core`, `cats-free`, or `cats-law` 


Should it be "publishes" ?

peterneyens · 2017-08-03T17:47:45Z

+ * `traverse1_`, `intercalate1` and `sequence1_` in `Reducible` were renamed to `nonEmptyTraverse_`, `nonEmptyIntercalate` and `nonEmptySequence_` respectively. 
+ * `foldLeftM` is removed from `Free`, use `foldM` on `Foldable` instead, see #1117 for detail. 
+ * `iteratorFoldM` was removed from `Foldable` due to #1716
+ * Apply syntax on tuple (e.g. `(x, y, z).map3(...)`)  was moved from `cats.syntax.tuple._` to `cats.syntax.apply._` and renamed to `mapN`, `contramapN` and `imapN` respectively.


Should we move this up to after the related CartesianBuilder deprecation bullet?

peterneyens · 2017-08-03T17:50:04Z

+ * [#1707](https://github.com/typelevel/cats/pull/1707): Add NEL/NEV one. by @peterneyens 
+ * [#1680](https://github.com/typelevel/cats/pull/1680): ~~`MonadTrans` instance for RWST and make `MonadTrans` serializable.~~ by @wedens
+ * [#1658](https://github.com/typelevel/cats/pull/1658): Add `Validated.validNel`. by @edmundnoble
+ * [#1651](https://github.com/typelevel/cats/pull/1651): Add state method to `MonadState`. by @oskoi


Should we "strike trough" this as well, like the MonadTrans improvements bullet above?

kailuowang · 2017-08-03T18:27:52Z

merging per gitter discussion

kailuowang added this to the 1.0.0-MF milestone May 25, 2017

kailuowang added the in progress label May 25, 2017

andyscott reviewed Jun 27, 2017

View reviewed changes

DavidGregory084 reviewed Jul 19, 2017

View reviewed changes

peterneyens reviewed Jul 27, 2017

View reviewed changes

alexandru reviewed Jul 31, 2017

View reviewed changes

peterneyens approved these changes Aug 1, 2017

View reviewed changes

adding release note for 1.0.0-MF

358d55b

kailuowang force-pushed the prepare1.0.0MF branch from a46dd8a to 358d55b Compare August 2, 2017 00:57

kailuowang added 4 commits August 1, 2017 21:26

Update README.md

15b8588

Update index.md

fea96fa

Update README.md

6647116

Update index.md

0dbbb36

edmundnoble reviewed Aug 2, 2017

View reviewed changes

durban reviewed Aug 2, 2017

View reviewed changes

kailuowang added 3 commits August 2, 2017 10:36

Update CHANGES.md

2945354

Update README.md

0001b27

Update index.md

751deb4

Update CHANGES.md

84161c3

peterneyens reviewed Aug 3, 2017

View reviewed changes

feedback

55ffbf4

kailuowang merged commit 09c9077 into typelevel:master Aug 3, 2017

kailuowang deleted the prepare1.0.0MF branch August 3, 2017 18:35

kailuowang removed the in progress label Aug 3, 2017


		To migrate from 0.9.0

		* `cats.free.Inject` is moved from `cats.free` to `cats.core` and renamed to `cats.InjectK`;

		## <a name="getting-started" href="#getting-started"></a>Getting Started


		Cats is currently available for Scala 2.10, 2.11 and 2.12.


		### To migrate from 0.9.0

		Apology for the number of breaking changes in this release. We are trying to include

Uh oh!

Conversation

kailuowang commented May 25, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Update:

Uh oh!

kailuowang commented May 25, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-io commented May 28, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

i-am-the-slime commented May 30, 2017

Uh oh!

LukaJCB commented May 30, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

andyscott commented Jun 12, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

edmundnoble left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kailuowang commented Aug 2, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

peterneyens Aug 3, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kailuowang commented Aug 3, 2017

kailuowang commented May 25, 2017 •

edited

Loading

kailuowang commented May 25, 2017 •

edited

Loading

codecov-io commented May 28, 2017 •

edited

Loading

LukaJCB commented May 30, 2017 •

edited

Loading

peterneyens Aug 3, 2017 •

edited

Loading