release-train-issue-template.md

Release Alpakka $VERSION$

Cutting the release

• Check that open PRs and issues assigned to the milestone are reasonable
• Update the Change date and version in the LICENSE file.
• Check readiness levels in /project/project-info.conf, and put in the release date for any new modules.
• Create a new milestone for the next version
• Close the $VERSION$ milestone
• Make sure all important PRs have been merged
• Update the revision in Fossa in the Akka Group for the Akka umbrella version, e.g. 22.10. Note that the revisions for the release is udpated by Akka Group > Projects > Edit. For recent dependency updates the Fossa validation can be triggered from the GitHub actions "Dependency License Scanning".
• 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/maven)

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 on https://repo.akka.io/maven/com/lightbend/akka/akka-stream-alpakka-xml_2.13/$VERSION$/akka-stream-alpakka-xml_2.13-$VERSION$.pom

When everything is on https://repo.akka.io/maven

• Log into gustav.akka.io as akkarepo
  • If this updates the current version, run ./update-alpakka-current-version.sh $VERSION$
  • otherwise check changes and commit the new version to the local git repository

    cd ~/www
    git status
    git add libraries/alpakka/current libraries/alpakka/$VERSION$
    git add api/alpakka/current api/alpakka/$VERSION$
    git commit -m "Alpakka $VERSION$"
    

Announcements

For important patch releases, and only if critical issues have been fixed:

• Send a release notification to Lightbend discuss
• Tweet using the @akkateam account (or ask someone to) about the new release
• Announce internally (with links to Tweet, discuss)

For minor or major releases:

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

Afterwards

• If Cassandra has relevant changes, create/update PR in Akka Persistence Cassandra to upgrade to $VERSION$
• Update akka-dependencies bom
• Create an issue or PR to upgrade projects in Alpakka Samples
• Close this issue