Inifinite re-compilation when BuildInfoOption.BuildTime is used inside metals + sbt bsp

[arixmkii]

If buildInfoOptions += BuildInfoOption.BuildTime is present in sbt build and VSCode/metals + sbt BSP build server are used, sometimes incremental compiler goes into infinite recompilation.

This is somehow expected, because this option makes compilation non-reproducible, but this could still come as a surprise.

I believe that it can have some workarounds per project, where settings for dev and ci builds would be different (via properties or env vars), but I don't have finalized idea if it is possible to introduce something like that in a non-breaking manner in the plugin itself (or could it be a breaking change as well?).

For now, may be it is worth to update this option documentation in README to better communicate this behavior to the end users.

Right now sbt BSP is a new kid on the block, but it should become more common in the future and improving documentation about its specifics might be a good thing to do.