How to Release


  • Sign up for a Sonatype account here
  • Ask for permissions to push to com.spotify domain like in this ticket
  • Add Sonatype credentials to ~/.sbt/1.0/credentials.sbt
credentials ++= Seq(
    "Sonatype Nexus Repository Manager",

Update version matrix

If the release includes a Beam version bump, update the version matrix

Automatic (CI)

Checkout and update the main branch.

git checkout main

git pull

Create and push a new version tag

git tag -a vX.Y.Z -m "vX.Y.Z"

git push origin vX.Y.Z


  • Run release skip-tests in sbt console and follow the instructions
  • Go to, find the staging repository, “close” and “release”
  • When the tag build completes, update release notes with name and change log
  • Run ./scripts/ to update documentation

After successfully published artifacts