How to Release

Prerequisites

  • 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(
Credentials(
    "Sonatype Nexus Repository Manager",
    "oss.sonatype.org",
    "$USERNAME",
    "$PASSWORD"))

Update documentation and version matrix

  • Pick a release name from here, here, here, here, or other interesting sources*
  • Update the list of release names below
  • 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

Manual

  • Run the slow integration tests with SLOW=true sbt it:test
  • Run release skip-tests in sbt console and follow the instructions
  • Go to oss.sonatype.org, find the staging repository, “close” and “release”
  • When the tag build completes, update release notes with name and change log
  • Run ./scripts/make-site.sh to update documentation

After successfully published artifacts

*Starting with 0.4.0 all release names are scientific names of animals with genus and species starting with the same letter, in ascending alphabetical order; Harry Potter spells starting with 0.8.0; Latin names of cities in ascending alphabetical order starting 0.10.0; Latin names of countries in ascending alphabetical order starting 0.11.0.

Past release names

0.11.x

0.10.x

0.9.x

0.8.x

  • v0.8.4 - “Expecto Patronum”
  • v0.8.3 - “Draconifors”
  • v0.8.2 - “Capacious Extremis”
  • v0.8.1 - “Bombarda Maxima”
  • v0.8.0 - “Amato Animo Animato Animagus”

0.7.x

  • v0.7.4 - “Watsonula wautieri”
  • v0.7.3 - “Vulpes Vulpes”
  • v0.7.2 - “Ursus t. Ussuricus”
  • v0.7.1 - “Taxidea Taxus”
  • v0.7.0 - “Suricata suricatta”

0.6.x

  • v0.6.1 - “Rhyncholestes raphanurus”
  • v0.6.0 - “Quelea Quelea”

0.5.x

0.4.x

  • v0.4.7 - “Hydrochoerus hydrochaeris”
  • v0.4.6 - “Galago gallarum”
  • v0.4.5 - “Felis ferus”
  • v0.4.4 - “Erinaceus europaeus”
  • v0.4.3 - “Dendrohyrax dorsalis”
  • v0.4.2 - “Castor canadensis”
  • v0.4.1 - “Blarina brevicauda”
  • v0.4.0 - “Atelerix albiventris”

0.3.x

  • v0.3.6 - “Veritas odit moras”
  • v0.3.5 - “Unitas, veritas, carnitas”
  • v0.3.4 - “Sectumsempra”
  • v0.3.3 - “Petrificus totalus”
  • v0.3.2 - “Ut tensio sic vis”
  • v0.3.1 - “Expecto patronum”
  • v0.3.0 - “Lux et veritas”

0.2.x

  • v0.2.13 - “Ex luna scientia”
  • v0.2.12 - “In extremo”
  • v0.2.11 - “Saltatio mortis”
  • v0.2.10 - “De Mysteriis Dom Sathanas”
  • v0.2.9 - “Hoc tempore atque nunc et semper”
  • v0.2.8 - “Consummatum est”
  • v0.2.7 - “Crescat scientia vita excolatur”
  • v0.2.6 - “Sensu lato”
  • v0.2.5 - “Imperium in imperio”
  • v0.2.4 - “Ab imo pectore”
  • v0.2.3 - “Aurea mediocritas”
  • v0.2.2 - “Intelligenti pauca”
  • v0.2.1 - “Sedes incertae”
  • v0.2.0 - “Nulli secundus”

0.1.x