v0.5.0-RC1

[armanbilge]

This is the first release candidate of sbt-typelevel v0.5.0. It brings several enhancements, unfortunately some of which may break existing builds. However for many projects with standard builds I expect upgrading to be simple and straightforward.

My goal is to update several Typelevel projects to the RC before designating a final release. If you have bandwidth to give it a try in your project, please do! I would be surprised if there aren't a few kinks to work out :)

Thank you to everyone who has contributed to this and previous releases!

Major changes

sbt v1.9.0

sbt-typelevel now requires sbt v1.9.0+.

CI jobs identified by Scala binary version

Previously, CI jobs were identified by the full Scala version e.g. 2.13.11 or 3.2.2. Now, they are identified only by the binary version e.g. 2.13 or 3. This means that CI job names are now stable to Scala updates.

However, if you have customized your CI matrix with exclusions or conditions based on the Scala version you will need to update those to match only on the binary version. To restore the old behavior set githubWorkflowScalaVersions := scalaCrossVersions.value.

• Use semantic version selector for ++ by @armanbilge in Use semantic version selector for ++ #400

Other enhancements

• Populate releaseNotesURL setting by @armanbilge in Populate releaseNotesURL setting #532

Refreshed scalac options

Compiler options are now optimized for the following Scala versions. If possible, please upgrade to these versions first.

• Scala 2.12.18+, Scala 2.13.11+, Scala 3.3.0+

Scala 2 is now tuned to behave like Scala 3, not the other way around

Previously, our compiler flags were tuned to make Scala 3 behave more like Scala 2 e.g. with -source:3.0-migration. Now, we have removed that flag and are instead tuning Scala 2 to behave more like Scala 3 e.g. with -Xsource:3.

One example of a common pattern where this makes a difference is a case class with a private constructor.

case class Foo private (bar: Bar, baz: Baz)

Under the old settings, this would still generate a public apply(bar, baz) method. Under the new settings. the apply method will also be private, and you must explicitly add a public apply method if desired. This is Scala 3 behavior. Most projects should catch this change either at compile-time or with MiMa.

• Remove -source:3.0-migration by @armanbilge in Refresh scalac settings #531
• Add -Xsource:3 to 2.12 (and future minor 2 releases) builds by @etspaceman in Add -Xsource:3 to 2.12 (and future minor 2 releases) builds #493

Unused warnings for all Scala versions

Additionally, unused warnings are now enabled on Scala 2.12 and Scala 3.3+, in addition to Scala 2.13.

• Re-enable unused warnings for scala 2.12 by @satorg in Re-enable unused warnings for scala 2.12 #312
• Add re-introduced unused/discard warnings for scala >3.3.0 by @amumurst in Add re-introduced unused/discard warnings for scala >3.3.0 #515

Scala version-specific @nowarns

To help manage fatal warnings when cross-building for multiple Scala versions, @satorg has created the scalac-compat library which provides @nowarn2, @nowarn3, etc. This is now included by default as compile-only dependency.

• Add scalac-compat dependency by default by @armanbilge in Add scalac-compat dependency by default #518

Other enhancements

• Tune Scala compiler warnings by @satorg in Tune Scala compiler warnings #344
• Fix console/scalacOptions by @satorg in Fix console/scalacOptions #349
• tlFatalWarnings now respects Compile/Test scopes by @armanbilge in Refresh scalac settings #531

Target JDK 8 by default

We now set tlJdkRelease := Some(8) so that the compiler explicitly targets JDK 8. If you are using APIs from newer JDKs your code will fail to compile. To target a newer JDK you may set e.g. tlJdkRelease := Some(11). To restore the old behavior, set tlJdkRelease := None i.e. no explicit target.

• Set default tlJdkRelease := Some(8) by @armanbilge in Set default tlJdkRelease := Some(8) #218
• -release -> -java-output-version in Scala 3.2 by @armanbilge in -release -> -java-output-version in Scala 3.2 #543

Publish to s01.oss.sonatype.org by default

The original oss.sonatype.org is now designated "legacy" in favor of s01.oss.sonatype.org. Typelevel and several other orgs are already publishing to s01 as well as all group IDs registered since 2021. You can migrate your org by opening a ticket on the Sonatype Jira. To restore the old behavior set tlSonatypeUseLegacyHost := true.

• Make s01.oss.sonatype.org the default host by @armanbilge in Make s01.oss.sonatype.org the default host #539

Laika 0.19

Huge thanks to @jenshalm for releasing Laika v0.19.0 and upgrading the sbt-typelevel-site plugin. This includes several enhancements and overall improves the integration.

• Site Plugin: Migrate to Laika 0.19.0-RC1 + separate generic defaults from Typelevel-specific ones by @jenshalm in Site Plugin: Migrate to Laika 0.19.0-RC1 + separate generic defaults from Typelevel-specific ones #377

Projects not published under Typelevel will no longer automatically have Typelevel-themed websites. If you are a Typelevel-affiliated project you can opt-in to the theming by setting tlSiteIsTypelevelProject := Some(TypelevelProject.Affiliate).

• Distinguish between org, affiliate projects in site plugin by @armanbilge in Distinguish between org, affiliate projects in site plugin #540

The tlSiteRelatedProjects setting is now deprecated. You may either remove it or replicate the feature as done in the following PR.

• Address tlSiteRelatedProjects deprecation by @armanbilge in Address tlSiteRelatedProjects deprecation #549

CI enhancements

JDKs and dependency caching

We now fully rely on the setup-java (and similar setup-graalvm) actions to manage JDKs and Maven dependency caching, instead of custom JDK index and caching steps.

• Setup java cache by @pjfanning in Setup java cache #300
• Use new setup-graalvm action by @armanbilge in Use new setup-graalvm action #396
• Use vanilla setup-java action, update setup-graalvm action by @armanbilge in Use vanilla setup-java action, update setup-graalvm action #538

Caching is now also more aggressive: if no cache is found, the CI job will create one by attempting to download all the dependencies used in the build (instead of only those specific to its position in the CI matrix). This greatly reduces the chance of cache misses in future CI jobs.

• Run sbt update on cache miss by @armanbilge in Run sbt update on cache miss #423
• Cache hit outputs as a string by @armanbilge in Cache hit outputs as a string #427

Dependency submission

Your project will now export its dependency graph to the GitHub API with the sbt-dependency-submission action. For example, this powers Dependabot vulnerability alerts. To opt-out, set tlCiDependencyGraphJob := false.

• Add dependency submission job to CI by @armanbilge in Add dependency submission job to CI #340
• Move submit-dependencies condition to job-level, not step-level by @armanbilge in Move submit-dependencies condition to job-level, not step-level #341
• Make dependency submission ignore non-compile scopes and no-publish projects by @armanbilge in Make dependency submission ignore non-compile scopes and no-publish projects #530

More aggressive cancelation of CI jobs

The build CI jobs now have a default 60-minute timeout that is configurable e.g. githubWorkflowBuildTimeoutMinutes := Some(30). CI is also now configured by default so that there is at most one concurrent job per PR or branch i.e. pushing another commit to a PR will cancel CI on the previous commit and merging another PR to main will cancel CI on the previous merge. Note that these concurrency limits will never affect the publishing of a tag.

• Allow configuring timeout-minutes for a job and a step by @iRevive in Allow configuring timeout-minutes for a job and a step #416
• Allow configuring concurrency for a job by @iRevive in Allow configuring concurrency for a job #417

Refreshed prePR

The prePR command now only runs "self-fixing" tasks such as scalafmt and scalafix. Furthermore, it respects your CI configuration e.g. if you have disabled formatting checks then they will not be included in prePR.

• Better prePR command by @armanbilge in Better prePR command #542, tlPrePRBotHook should respect ci config #552

Configurable BSP

Cross-platform projects that are "pure" (i.e., 100% share sources for all platforms) now enable BSP only for the JVM platform by default. This should reduce the load on IDEs.

You may configure which platforms you want to enable BSP for any cross project (pure or otherwise) by setting e.g. tlBspCrossProjectPlatforms := Set(JVMPlatform, JSPlatform). This setting does not affect non-cross projects, including JS- or Native-only projects.

• BSP control plugin by @satorg in BSP control plugin #465

Enhanced support for Scala Native

It is now easier to cross-build for Scala Native out-of-the-box.

• Add sbt-scala-native-crossproject to core by @armanbilge in Add sbt-scala-native-crossproject to core #517
• Add TypelevelScalaNativeGitHubPlugin by @armanbilge in Add TypelevelScalaNativeGitHubPlugin #545

Other changes with compatibility concerns

• Keep publish secrets scoped to specific steps by @armanbilge in Keep publish secrets scoped to specific steps #92
• Don't set version scheme in settings plugin by @armanbilge in Don't set version scheme in settings plugin #127
• Port sbt project naming macro for tlCrossRootProject by @DavidGregory084 in Port sbt project naming macro for tlCrossRootProject #207
• Do not require binary compat on 0.0.z versions by @valencik in Do not require binary compat on 0.0.z versions #358
• Disable publishing-related steps in CI plugin by @armanbilge in Disable publishing-related steps in CI plugin #397
• Move GitHub-related settings to GitHub plugin by @armanbilge in Move GitHub-related settings to GitHub plugin #398
• Run ci check steps only for primary value of axes by @armanbilge in Run ci check steps only for primary value of axes #536

Other changes

• Auto-populate developers w/ GH info by @armanbilge in Auto-populate developers w/ GH info #279
• Don't upload artifacts for no-publish projects by @armanbilge in Don't upload artifacts for no-publish projects #534
• Run scalafix before test by @armanbilge in Run scalafix before test #537

Documentation

Thanks to @mzuehlke for on-going work to update our documentation with the latest and greatest!

• update plugin doc by @mzuehlke in update plugin doc #550

Updates

• Update sbt-git to 2.0.0 by @armanbilge in Update sbt-git to 2.0.0 #233
• Update snakeyaml to 1.33 by @typelevel-steward in Update snakeyaml to 1.33 #380
• Update mdoc, sbt-mdoc to 2.3.7 by @typelevel-steward in Update mdoc, sbt-mdoc to 2.3.7 #461
• Update sbt to 1.9.0 by @typelevel-steward in Update sbt to 1.9.0 #521
• Update sbt-sonatype to 3.9.21 by @typelevel-steward in Update sbt-sonatype to 3.9.21 #524
• Update sbt-header to 5.10.0 by @typelevel-steward in Update sbt-header to 5.10.0 #528
• Update peaceiris/actions-gh-pages to v3.9.3 by @armanbilge in Update peaceiris/actions-gh-pages to v3.9.3 #535
• Update versions, steward pins by @armanbilge in Update versions, steward pins #546
• Update laika-sbt to 0.19.2 by @typelevel-steward in Update laika-sbt to 0.19.2 #548

New Contributors

• @jenshalm made their first contribution in Site Plugin: Migrate to Laika 0.19.0-RC1 + separate generic defaults from Typelevel-specific ones #377
• @pjfanning made their first contribution in Setup java cache #300
• @iRevive made their first contribution in Minor improvements #418
• @etspaceman made their first contribution in Add -Xsource:3 to 2.12 (and future minor 2 releases) builds #493
• @amumurst made their first contribution in Add re-introduced unused/discard warnings for scala >3.3.0 #515

Full Changelog: v0.4.22...v0.5.0-RC1

---

This discussion was created from the release v0.5.0-RC1.