RELEASING.md

Releasing

Use this command to create a release issue of Alpakka Release Train Issue Template and follow the steps.

~/alpakka> scripts/create-release-issue.sh `version-to-be-released`

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. Add and commit version.sbt file that pins the version to the one, that is being revised. Also set isSnapshot to false for the stable documentation links. For example:

   ThisBuild / version := "1.0.4"
   ThisBuild / isSnapshot := false

3. Make all of the required changes to the documentation.
4. Build documentation locally with CI settings:

   env CI=true sbt docs/previewSite

5. If the generated documentation looks good, send it to Gustav:

   env CI=true sbt docs/publishRsync

6. Do not forget to push the new branch back to GitHub.