Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into scala-ide
Browse files Browse the repository at this point in the history
  • Loading branch information
SethTisue committed Oct 23, 2024
2 parents 60af20d + af1d976 commit 1538471
Show file tree
Hide file tree
Showing 5 changed files with 48 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
steps:
- uses: actions/checkout@v4
- uses: coursier/cache-action@v6
- uses: coursier/[email protected].5
- uses: coursier/[email protected].6
with:
jvm: temurin:1.17
apps: "scala-cli"
Expand Down
2 changes: 1 addition & 1 deletion bin/.scalafmt.conf
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version = "3.8.1"
version = "3.8.3"
runner.dialect = scala3

rewrite.scala3.convertToNewSyntax = yes
Expand Down
4 changes: 3 additions & 1 deletion bin/generate-proposal-listing.scala
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
//> using scala "3.4.1"
#!/usr/local/bin/env -S scala-cli shebang

//> using scala 3.5.2
//> using dep com.vladsch.flexmark:flexmark-all:0.64.8

import java.io.PrintWriter
Expand Down
41 changes: 41 additions & 0 deletions proposals/032-scala-version-guidance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
date: May 2024
---

# Provide guidance on choosing between Scala LTS and Next

## Proposer

Proposed by Zainab Ali, Community Representative, 14th May 2024.

## Abstract

There is no clear guidance on how to choose between Scala LTS or Scala Next. This has lead to some open source projects adopting Next where LTS is recommended. Examples include [xebiafunctional/fetch](https://github.com/xebia-functional/fetch/commit/60b26afb242b1e248615c811f2c23a51d6cab6fe), [kovstas/fs2-throttler](https://github.com/kovstas/fs2-throttler/commit/e265f6d585aa55d101ddd5e631abb940fccce084) and [cquiroz/scala-java-locales](https://github.com/cquiroz/scala-java-locales/issues/490).

The most prominent guidance in [the 2022 blog post on compatibility plans](https://www.scala-lang.org/blog/2022/08/17/long-term-compatibility-plans.html#the-future-best-practices) is outdated. [The 3.4.0 release notes](https://www.scala-lang.org/blog/2024/02/29/scala-3.4.0-and-3.3.3-released.html#-so-which-version-should-i-update-to) have better guidance, but are hard to discover.

## Proposal

The Scala website should include more guidance on choosing Scala versions. For example:
- There could be instructions on the [download page](https://www.scala-lang.org/download/) on choosing between LTS and Next.
- There could be an entry in the [migration guide](https://docs.scala-lang.org/scala3/guides/migration/compatibility-intro.html) on which version to choose.
- The [2022 blog post on compatibility plans](https://www.scala-lang.org/blog/2022/08/17/long-term-compatibility-plans.html#the-future-best-practices) could include a link to recent best practices.
Ideally, there should be a link to guidance wherever Next or LTS are mentioned.

Developers actively upgrading their Scala versions are unlikely to check the website, but do check other sources.
- There should be a link to guidance in the [release notes](https://github.com/scala/scala3/releases/tag/3.4.1).
- [Scala Steward's](https://github.com/scala-steward-org/scala-steward) PRs for Scala version upgrades could include explicit guidance and instructions on [pinning LTS](https://github.com/scala-steward-org/scala-steward/blob/main/docs/faq.md#how-can-version-updates-be-controlled).
- Build tools such as mill, sbt, and scala-cli could potentially inform the user if a jar is configured for publishing with a Next version.

## Cost

In level of difficulty I estimate the following order (from easiest to
hardest):

1. Updating guidance on the Scala website.
2. Updating Scala Steward's PR summary.
3. Including guidance in build tool publishing steps.

## Timescales

Updating guidance on the Scala website and release notes could be done quickly. As developers are currently in the process of adopting `3.4`, the earlier this guidance is available, the better.
2 changes: 2 additions & 0 deletions proposals/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,5 +187,7 @@
* Date proposed: June 15 2023
* Accepted: yes
* Status: **completed**
# [032-scala-version-guidance.md](./032-scala-version-guidance.md)
* Date proposed: May 2024

_This file is auto-generated. Don't edit here, instead run scala-cli run bin/ to regenerate._

0 comments on commit 1538471

Please sign in to comment.