scalafix icon indicating copy to clipboard operation
scalafix copied to clipboard

Ensure versions are displayed correctly in docs

Open ckipp01 opened this issue 5 years ago • 6 comments
trafficstars

Currently in the documentation it shows that that you should install scalafix in the following way:

addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.9.13")

However, 0.9.13 is the current version of core, not the plugin. However, the version of core gets put into the plugin here. This may not be common as they may always be in sync, but this might confuse people as they try to install and they aren't able to find the artifact, which happens currently. However, the badge is showing the correct version.

Screenshot 2020-03-26 at 15 29 44

ckipp01 avatar Mar 26 '20 14:03 ckipp01

Now 0.9.15 is indicated, and should be compatible with Scala 2.13, but artifacts are not published.

cchantep avatar May 16 '20 19:05 cchantep

In fact, when releasing, there is a delay that can reach some hours, between the release of sbt-scalafix, and scalafix-core. One of the objectives of scalafix v1 is to sseparate versioning of sbt-scalafix and scalafix-core similar to sbt-scalafmt and scalafmt-core.

mlachkar avatar Jun 03 '20 09:06 mlachkar

Thx for the answer @mlachkar . That's weird this ticket was created March 26th and many days after I still see the issue.

cchantep avatar Jun 03 '20 12:06 cchantep

Right now, for example, we have the issue where the documentation is not updated despite we released 0.9.16, but there is no issue when specifying this version in your plugin conf file (all the artifacts are present). I can't explain why this happened on March 26th, but right now, the git tag is referencing a detached commit for master, which is the root cause. We are planning to improve release documentation to avoid this issue.

mlachkar avatar Jun 03 '20 13:06 mlachkar

That's weird this ticket was created March 26th and many days after I still see the issue.

@cchantep Can you elaborate? This ticket is still open.

olafurpg avatar Jun 03 '20 14:06 olafurpg

I mean for me the delay is more days than hours, so may be we're not seeing the same symptoms?

cchantep avatar Jun 03 '20 16:06 cchantep

As a mitigation, sbt-scalafix and scalafix are now already released together. Actual decoupling is tracked in https://github.com/scalacenter/scalafix/issues/1146 (although there is no active work on it).

bjaglin avatar Feb 05 '24 07:02 bjaglin