A cats-effect IO port of sbt-release for sbt, with composable error handling and resource safety.

Start with the plugin-specific onboarding guides:

• Single-project builds: docs/core/getting-started.md
• Monorepos: docs/monorepo/getting-started.md
• Full docs index: docs/README.md

Install in project/plugins.sbt:

addSbtPlugin("io.github.scalauser12" % "sbt-release-io" % "0.12.1")

The plugin activates automatically. Add version.sbt with ThisBuild / version := "0.1.0-SNAPSHOT".

First command:

sbt "releaseIO check with-defaults"

Read next:

• Core getting started
• Core customization walkthrough
• Core customization

Install in project/plugins.sbt:

addSbtPlugin("io.github.scalauser12" % "sbt-release-io-monorepo" % "0.12.1")

Note: The guidance below describes the current published monorepo contract in v0.12.1. See CHANGELOG.md for the full release history and upgrade notes.

In build.sbt:

lazy val root = (project in file("."))
  .aggregate(core, api)
  .enablePlugins(MonorepoReleasePlugin)

By default, each subproject needs its own version.sbt containing version := "0.1.0-SNAPSHOT". Because the monorepo plugin requires the core plugin, it also provides the shared/core releaseIO* settings surface transitively. The supported command in this setup remains releaseIOMonorepo.

First command:

sbt "releaseIOMonorepo check with-defaults"

Read next:

• Monorepo getting started
• Selective release walkthrough
• Monorepo customization

Customization is layered: flip a releaseIOBehavior* or releaseIOMonorepoBehavior* toggle, pass a CLI flag (with-defaults, skip-tests, cross) for one-off tweaks, pre-answer decision prompts with releaseIODefaults*, redefine a specific task key (releaseIOPublishAction, releaseIOVcsTagName, the releaseIOVersioning* family), or inject logic around phases with releaseIOHooks* / releaseIOPolicy* and their releaseIOMonorepo* counterparts. Shared releaseIO* settings live on the core plugin surface and remain available transitively when monorepo is installed. For shared-resource integration — an HTTP client, a temp workspace, anything acquired once per run — extend ReleasePluginIOLike[T] / MonorepoReleasePluginLike[T] and use the resource-hook APIs. See docs/core/customization.md and docs/monorepo/customization.md for the full catalog.

For local rehearsal recipes, see docs/core/recipes.md and docs/monorepo/recipes.md. For rollback and recovery, see docs/core/operations.md and docs/monorepo/operations.md.

sbt compile              # compile all modules
sbt test                 # run unit tests (MUnit)
sbt -Dsbt.version=2.0.0-RC9 compile  # compile on sbt 2 / Scala 3 (version defined as Sbt2Version in build.sbt)
sbt -Dsbt.version=2.0.0-RC9 test     # run unit tests on sbt 2 / Scala 3
./bin/sbt2-clean test    # same sbt 2 test lane from a clean tracked snapshot (ignores local Metals/Bloop files)
./bin/sbt2-clean core/scripted
./bin/sbt2-clean monorepo/scripted
sbt scripted             # run all scripted integration tests
sbt core/test            # core unit tests only
sbt monorepo/test        # monorepo unit tests only
sbt scalafmtAll          # format Scala sources
sbt scalafmtSbt          # format .sbt and project/*.scala build files
sbt scalafmtCheckAll     # verify Scala source formatting
sbt scalafmtSbtCheck     # verify sbt/build file formatting

Use ./bin/sbt2-clean ... for local sbt 2 verification if your checkout has generated IDE files such as project/metals.sbt or .bloop/. CI runs on a clean checkout and can use plain sbt -Dsbt.version=2.0.0-RC9 ....

• sbt: 1.12.3 and 2.0.0-RC9
• Scala: 2.12 (sbt 1) / Scala 3 (sbt 2) — plugin compile targets, not constraints on your project's Scala version
• cats-effect: 3.7.0
• VCS: Git only

This project is licensed under the Apache License 2.0.

Ports sbt-release by the sbt organization onto cats-effect IO.

Developed with the assistance of Claude Code by Anthropic.