RELEASING.md

Releasing

1. Check closed issues without a milestone and either assign them the 'upcoming' release milestone or 'invalid'
2. Make sure any new deprecations got the correct designated version
3. Create a PR that adds release notes for the upcoming version and get it merged before continuing with the release. Release notes should include:
   • 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
4. Ask someone in the Akka team to rename the 'alpakka-xx-stable' report in WhiteSource to reflect the latest version (unfortunately this requires permissions that cannot be shared in a granular way)
5. Create a new release with the next tag version (e.g. v0.3)
6. 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.
7. Login to Bintray and sync artifacts to Maven Central:
   • Go to the 'Maven Central' tab and use your sonatype credentials.
   • This can take a long time (you can check https://oss.sonatype.org/#stagingRepositories for progress)
8. Close the milestone for this release and start a new one

Releasing only updated docs

It is possible to release a revised documentation to the already existing release.

1. Create a new branch from a release tag. If a revised documentation is for the v0.3 release, then the name of the new branch should be docs/v0.3.
2. Make all of the required changes to the documentation.
3. Add and commit version.sbt file that sets the version to the one, that is being revised. For example version in ThisBuild := "0.3".
4. Push the branch. Tech Hub will see the new branch and will build and publish revised documentation.