Skip to content

Latest commit

 

History

History
87 lines (68 loc) · 5.59 KB

release-train-issue-template.md

File metadata and controls

87 lines (68 loc) · 5.59 KB

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
  • Communicate that a new version is about to be released in Gitter Akka Dev Channel, so that no new Pull Requests are merged

Preparing release notes in the documentation / announcement

  • For non-patch releases: rename the 'alpakka-x.x-stable' and 'alpakka-supported-x.x-stable' reporting projects in WhiteSource accordingly (unfortunately this requires permissions that cannot be shared outside of Lightbend)
  • Check readiness levels in /project/project-info.conf, and put in the release date for any new modules
  • Check supported projects listing in whitesourceSupported
  • Use the draft release notes to create/update the release notes in docs/src/main/paradox/release-notes/, listing contributors generated by sbt-authors (eg. authors v1.1.0 HEAD)
  • 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
  • Release notes PR has been merged

Cutting the release

  • Wait until master 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, release notes and milestone
  • Check that Travis CI release build has executed successfully (Travis will start a CI build for the new tag and publish artifacts to Bintray and documentation to Gustav)
  • Go to Bintray and select the just released version
  • Go to the Maven Central tab, check the Close and release repository when done checkbox and sync with Sonatype (using your Sonatype TOKEN key and password)

Check availability

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 on Gitter akka/akka
  • Announce internally

Afterwards