Skip to content

Latest commit

 

History

History
33 lines (29 loc) · 2.21 KB

RELEASING.md

File metadata and controls

33 lines (29 loc) · 2.21 KB

Releasing

  1. If this is a new minor (not patch) release, ask someone in the Alpakka or Akka team to rename the 'alpakka-kafka-xx-stable' report in WhiteSource to reflect the latest version (unfortunately this requires permissions that cannot be shared in a granular way)
  2. Check closed issues without a milestone and either assign them the 'upcoming' release milestone or 'invalid'
  3. Create a new release with:
    • the next tag version (e.g. v0.21)
    • title and release description including notable changes
    • link to the milestone showing an overview of closed issues for this release
    • overview of contributors generated by sbt-authors (eg. sbt authors v0.20 v0.21)
  4. Travis CI will start a CI build for the new tag and publish artifacts to Bintray.
    • When the travis build fails it must be restarted. Artifacts may already have been pushed to Bintray, however, so remove them there before restarting the build.
  5. Login to Bintray and sync artifacts to Maven Central:
  6. Close the milestone for this release and start a new one.

Publishing docs

  1. Checkout the newly released tag.
  2. Build paradox and API documentation:
    sbt docs/paradox core/doc
    
  3. Upload docs to gustav:
    rsync -azP docs/target/paradox/site/main/ gustav.akka.io:www/docs/akka-stream-kafka/<new-version>/
    rsync -azP core/target/scala-2.12/api/ gustav.akka.io:www/api/akka-stream-kafka/<new-version>/
    
  4. Update the current links on gustav:
    ln -snf <new-version> current in www/api/akka-stream-kafka/ and www/docs/akka-stream-kafka
    

If you don't have access to gustav ask someone from the core akka team to do it or give you access.