RELEASING.md

• Choose the right version number:
  • x.0.0 is reserved for incompatible changes and require a milestone cycle.
  • x.y.0 is reserved for compatible changes.
  • x.y.z is reserved for bugfixes that don't change the public API, the SemanticDB schema and major/minor versions of our dependencies.
  • For more details, consult versioning policy.
• Tag the release:
  • The tag must be called vx.y.z, e.g. v3.0.0.
  • git tag -a vx.y.z -m "vx.y.z"
  • git push upstream --tags
  • Do not create a release on GitHub just yet. Creating a release on GitHub sends out a notification to repository watchers, and the release isn't ready for that yet.
• Wait for the Travis CI job in Active Branches to build the binaries and stage them to Sonatype.
• While waiting for Travis, update the milestones:
  • https://github.com/scalameta/scalameta/milestones
  • Close the milestone or milestones corresponding to the release. For example, for 3.3.0, we closed both 3.2.1 and 3.3.0 (we never released 3.2.1, so all its tickets went straight to 3.3.0).
  • Create the milestone or milestones corresponding to future releases. For example, for 3.3.0, we created both 3.3.1 and 3.4.0.
• While waiting for Travis, draft a release on GitHub:
  • https://github.com/scalameta/scalameta/releases/new.
  • In the dropdown, pick the recently pushed tag.
  • In the release title, say Scalameta vx.y.z.
  • Write the release notes using 3.7.0 release notes as a template. In the future, we may automate this step.
  • Click "Save draft". The release is still not ready for an announcement, so we shouldn't "Publish release" just yet.
• Finalize the release on Sonatype:
  • sbt sonatypeReleaseAll
  • Alternatively:
    • Go to Staging Repositories.
    • Close the repositories that have been created by the Travis CI job. There can be several respositories produced by the job.
    • Release the repositories.
• Verify the Sonatype release:
  • Make sure that the release shows up at https://oss.sonatype.org/content/repositories/releases/org/scalameta/.
  • Run ./bin/test-release.sh $VERSION to ensure that all artifacts have successfully been released.
• Update the website:
  • Submit a pull request like scalameta/tutorial#33.
  • Wait for the Travis CI validation.
  • Merge the pull request immediately without waiting for approvals.
  • Apply the website hotfix (https://github.com/scalameta/scalameta.github.com/commit/adc7920ee56dfbe2cb615492554808ded922ae34).
• Update the SemanticDB guide:
  • Update version numbers in https://github.com/scalameta/scalameta/blob/main/semanticdb/semanticdb3/guide.md
  • Submit a pull request to scalameta/scalameta.
  • Merge the pull request immediately without waiting for travis or approvals.
• Publish the release on GitHub:
  • https://github.com/scalameta/scalameta/releases
  • Select the previously drafted release.
  • Click "Publish release".
• Verify the Maven Central release:
  • Wait for up to several hours (for 3.2.0, we waited for 15 minutes; for 3.3.0, we waited for 1.5 hours).
  • Make sure that the release shows up at https://search.maven.org/#search%7Cga%7C1%7Corg.scalameta%20a%3A%22scalameta_2.12%22.
  • If it's been a while, and the release doesn't show up at Maven Central, ping Sonatype at OSSRH-10192.
• Upgrade downstream projects:
  • https://github.com/scalacenter/scalafix
  • https://github.com/scalameta/scalafmt
  • https://github.com/scalameta/metadoc
  • https://github.com/scalameta/metals
  • https://github.com/sbt/sbt (see SemanticdbPlugin)

Releasing for a specific version

Releasing for a specific existing version might be needed for example in case of new Scala version.

To peform it on CI, create and push a tag with a special name: semanticdb_v${existing-scalameta-version}_${scala_version}. You can also do it manually. The local flow is:

• set the needed secrets (https://github.com/sbt/sbt-ci-release#secrets)

• run sbt console, check if the credentials are available using show credentials, you might need to run sbt from bash when having issues with other shells

• run set every version := "4.5.9" - replace 4.5.9 with the specific version you are releasing for

• run ++2.12.17 or another Scala version you need

• run semanticdbScalacCore/publishSigned, semanticdbScalacPlugin/publishSigned and metac/publishSigned

• make sure that everything is properly generated to target/sonatype-staging directory

• run sonatypeBundleRelease