rules_scala icon indicating copy to clipboard operation
rules_scala copied to clipboard

Improve documentation on selecting a Scala version

Open lexspoon opened this issue 1 year ago • 1 comments
trafficstars

I am trying to upgrade from 2.12.18 to 2.12.19, and the docs are very unclear about how to do this. If you start at Selecting Scala version, you get two pieces of information:

  • How to configure using scala_config, but this only works for a very limited set of version numbers. At the time of writing, the only choices are one version from 2.11.x, one version from 2.12.x, and one version from 2.13.x. As such, this option does not work for what I want to do.
  • How to configure multiple versions. I don't want multiple versions, though. So this option doesn't work, either.

I am filing an issue to request specific documentation on how to choose a Scala version in the cases that scala_config doesn't already have support for it.

This is a huge usability issue for something that seems like it is probably pretty simple once it is understood how to do it. Two of the top engineers at my company have spent hours, now, and are still digging around. I realize there are issues with expanding scala_config for more versions, but let us not make the perfect the enemy of the good. Can the maintainers document the correct way to update your WORKSPACE file for a different Scala version, with as few assumptions as possible that the reader knows the ins and outs of Bazel? It seems like it should be a chunk of WORKSPACE plus a few SHAs; it would be helpful to see the chunk of configuration and then directions on where to get the SHAs.

lexspoon avatar Jul 26 '24 15:07 lexspoon