ContextQMD
Back to Akka

Release Train Issue Template for Akka

akka-docs/release-train-issue-template.md

10.1.04.7 KB
Original Source

Release Akka $VERSION$

<!-- # Release Train Issue Template for Akka (Liberally copied and adopted from Scala itself https://github.com/scala/scala-dev/blob/b11cd2e4a4431de7867db6b39362bea8fa6650e7/notes/releases/template.md) For every release, use the `scripts/create-release-issue.sh` to make a copy of this file named after the release, and expand the variables. Variables to be expanded in this template: - $VERSION$=??? Key links: - akka/akka-core milestone: https://github.com/akka/akka-core/milestone/? -->

Cutting the release

  • Check that open PRs and issues assigned to the milestone are reasonable
  • If PRs related to clustering were merged after the previous multi-node test run, trigger the multi-node tests and see that they are green.
  • If PRs were merged after EU midnight, trigger the native-image tests and see that they are green.
  • If PRs were merged after the last nightly, trigger nightlies nightly-builds and see that they are green.
  • Update the version and change date in the LICENSE file.
  • Update the Akka version in the samples to $VERSION$, otherwise the published zip files of the samples will have the old version.
  • Create a new milestone for the next version
  • Close the $VERSION$ milestone
  • Make sure all important PRs have been merged
  • Wait until main build finished after merging the latest PR
  • Update the draft release with the next tag version v$VERSION$, title and release description. Use the Publish release button, which will create the tag.
  • Check that GitHub Actions release build has executed successfully (GitHub Actions will start a CI build for the new tag and publish artifacts to https://repo.akka.io/TOKEN/secure)

Check availability

  • Check API documentation
  • Check reference documentation. Check that the reference docs were deployed and show a version warning (see section below on how to fix the version warning).
  • Check the release mvn dependency:get -Dartifact=com.typesafe.akka:akka-actor_2.13:$VERSION$

When everything is on https://repo.akka.io/TOKEN/secure

  • Log into gustav.akka.io as akkarepo
    • If this updates the current version, run ./update-akka-current-version.sh $VERSION$
    • otherwise check changes and commit the new version to the local git repository 
      cd ~/www
git status
git add libraries/akka-core/current libraries/akka-core/$VERSION$
git add api/akka-core/current api/akka-core/$VERSION$
git add japi/akka-core/current japi/akka-core/$VERSION$
git commit -m "Akka core $VERSION$"
    • push changes to the remote git repository 
      cd ~/www
git push origin master
  • If this updated 'current' docs - trigger a re-index of the docs for search through Run workflow for the scraper

Announcements

For minor or major releases:

  • Include noteworthy features and improvements in Akka umbrella release announcement at akka.io. Coordinate with PM and marketing.

Afterwards