v0.5.0-RC10

This is the tenth release candidate of sbt-typelevel v0.5.0.

Fixes

• Sort rendered matrixes in GHA by @etspaceman in #619

Updates

• Update sbt-mima-plugin to 1.1.3 by @typelevel-steward in #614
• Update sbt to 1.9.3 by @typelevel-steward in #616

Full Changelog: v0.5.0-RC9...v0.5.0-RC10

v0.5.0-RC9

This is the 9th candidate release of SBT typelevel, removing an sbt update call for validate steward.

What's Changed

• Remove sbt update from steward job by @etspaceman in #612
• Update scalafmt-core to 3.7.10 by @typelevel-steward in #613

Full Changelog: v0.5.0-RC8...v0.5.0-RC9

v0.5.0-RC8

This is the eighth release candidate of sbt-typelevel v0.5.0.

What's Changed

Features

• Add global permissions by @etspaceman in #609

Fixes

• Revert #508 by @etspaceman in #611

Docs

• Fix syntax highlighting for g8 snippet by @armanbilge in #607

Full Changelog: v0.5.0-RC7...v0.5.0-RC8

v0.5.0-RC7

This is the seventh release candidate of sbt-typelevel v0.5.0.

What's Changed

Fixes

• Fix rendering of modules-ignore by @armanbilge in #604

Documentation

• update docs by @mzuehlke in #603

Updates

• Update sbt to 1.9.2 by @typelevel-steward in #605

Full Changelog: v0.5.0-RC6...v0.5.0-RC7

v0.5.0-RC6

This is the sixth release candidate of sbt-typelevel v0.5.0.

What's Changed

Enhancements

• New Theme Inversion by @j-mie6 in #590

Fixes

• only use parameter for Some(NonEmptyList) by @mzuehlke in #589
• javadoc.io now supports sbt plugins by @armanbilge in #585
• Deprecate tlSkipIrrelevantScalas by @armanbilge in #591
• Added binary versions to module-ignore inputs by @j-mie6 in #600
• Added test-internal to the ignored configs by @j-mie6 in #602

Docs

• Publish docs site from main branch by @armanbilge in #583
• fix rendering of bullet lists by @mzuehlke in #588
• Fixed unclosed bracket in the index by @j-mie6 in #596

Updates

• Update laika-sbt to 0.19.3 by @typelevel-steward in #594
• Update sbt-crossproject, ... to 1.3.2 by @typelevel-steward in #598
• Update typelevel-scalafix to 0.1.6 by @typelevel-steward in #599

Full Changelog: v0.5.0-RC5...v0.5.0-RC6

v0.5.0-RC5

This is the fifth release candidate of sbt-typelevel v0.5.0. It features an exciting new theme for Typelevel documentation sites, contributed by @j-mie6!

What's Changed

Enhancements

• New light theme for sbt-typelevel-site! by @j-mie6 in #573

Fixes

• Also add scalac-compat to Test scope by @armanbilge in #578

Full Changelog: v0.5.0-RC4...v0.5.0-RC5

v0.5.0-RC4

This is the fourth release candidate of sbt-typelevel v0.5.0.

What's Changed

Features

• Support new Java Distributions by @mzuehlke in #564
• Allow to independently configure components of CrossRootProject by @armanbilge in #571

Fixes

• Scaladoc3 Wiki Syntax Flag by @j-mie6 in #563
• Corrected stale 2.13 version in WorkflowJob by @j-mie6 in #565
• skip mima task, if no artifacts should be published by @mzuehlke in #576

Documentation

• docs for site plugin: adjust for recent changes to tlSiteIsTypelevelProject by @jenshalm in #562
• Link to sbt-dependency-submission and Scala Steward by @armanbilge in #567
• doc updates: by @mzuehlke in #572

Updates

• Update sbt to 1.9.1 by @typelevel-steward in #569
• Update scalac-compat-annotation to 0.1.2 by @typelevel-steward in #574

Full Changelog: v0.5.0-RC3...v0.5.0-RC4

v0.5.0-RC3

This is the third release candidate of sbt-typelevel v0.5.0.

Fixes

• Clear sbt step preamble in dependency submission job by @armanbilge in #561
• fix GHA problems by @mzuehlke in #558

Updates

• Update sbt-scalajs to 1.13.2 by @typelevel-steward in #559

Full Changelog: v0.5.0-RC2...v0.5.0-RC3

v0.5.0-RC2

This is the second release candidate of sbt-typelevel v0.5.0.

Fixes

• Move noPublishProjectRefs to always-triggered plugin by @armanbilge in #554

Updates

• Update scalac-compat-annotation to 0.1.1 by @typelevel-steward in #555

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

v0.5.0-RC1

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 #400

Other enhancements

• Populate releaseNotesURL setting by @armanbilge in #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 #531
• Add -Xsource:3 to 2.12 (and future minor 2 releases) builds by @etspaceman in #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 #312
• Add re-introduced unused/discard warnings for scala >3.3.0 by @amumurst in #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 #518

Other enhancements

• Tune Scala compiler warnings by @satorg in #344
• Fix console/scalacOptions by @satorg in #349
• tlFatalWarnings now respects Compile/Test scopes by @armanbilge in #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 #218
• -release -> -java-output-version in Scala 3.2 by @armanbilge in #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 #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 #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 #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 #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 #300
• Use new setup-graalvm action by @armanbilge in #396
• Use vanilla setup-java action, update setup-graalvm action by @armanbilge in #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 #423
• Cache hit outputs as a string by @armanbilge in #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 #340
• Move submit-dependencies condition to job-level, not step-level by @armanbilge in #341
• Make dependency submission ignore non-compile scopes and no-publish projects by @armanbilge in #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 #416
• Allow configuring concurrency for a job by @iRevive in #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 #542, #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 #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 #517
• Add TypelevelScalaNativeGitHubPlugin by @armanbilge in #545

Other changes with compatibility concerns

• ...