release-train-issue-template.md

Release Alpakka $VERSION$

~ 1 week before the release

• Check that any new deprecated annotations use the correct version name
• Check that open PRs and issues assigned to the milestone are reasonable
• Decide on planned release date
• Create a new milestone for the next version
• Check closed issues without a milestone and either assign them the 'upcoming' release milestone or invalid/not release-bound

1 day before the release

• Make sure all important / big PRs have been merged by now

Preparing release notes in the documentation / announcement

• Check readiness levels in /project/project-info.conf, and put in the release date for any new modules
• For non-patch releases: Create a news item draft PR on akka.github.com, using the milestone
• Move all unclosed issues for this milestone to the next milestone
• Close the $VERSION$ milestone

Cutting the release

• Wait until the build finished after merging the release notes
• Fix up the draft release with the next tag version v$VERSION$, title and release description linking to announcement and milestone
• Check that the CI release build has executed successfully (GitHub actions will start a CI publish build for the new tag and publish artifacts to Sonatype and documentation to Gustav)

Check availability

• Check API documentation
• Check reference documentation
• Check the release on Maven central

When everything is on maven central

• Log into gustav.akka.io as akkarepo
  • update the current links on repo.akka.io to point to the latest version with

    ln -nsf $VERSION$ www/docs/alpakka/current
    ln -nsf $VERSION$ www/api/alpakka/current
    ln -nsf $VERSION$ www/docs/alpakka/$BINARY_VERSION$
    ln -nsf $VERSION$ www/api/alpakka/$BINARY_VERSION$
    

  • check changes and commit the new version to the local git repository

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

Announcements

• For non-patch releases: Merge draft news item for akka.io
• Send a release notification to Lightbend discuss
• Tweet using the akkateam account (or ask someone to) about the new release
• Announce internally

Afterwards

• If Couchbase has relevant changes, create/update PR in Akka Persistence Couchbase to upgrade to $VERSION$
• If Cassandra has relevant changes, create/update PR in Akka Persistence Cassandra to upgrade to $VERSION$
• Update version for Lightbend Supported Modules in private project
• Create an issue or PR to upgrade projects in Alpakka Samples
• Close this issue