Skip to content

Latest commit

 

History

History
28 lines (23 loc) · 1.05 KB

RELEASING.md

File metadata and controls

28 lines (23 loc) · 1.05 KB

Releasing

Create a new issue from the Alpakka Kafka 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 v1.1.1 release, then the name of the new branch should be docs/v1.1.1.
  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.1.1"
    ThisBuild / isSnapshot := false
  3. Make all of the required changes to the documentation.
  4. Check the documentation update locally:
    sbt docs/previewSite
  5. If the generated documentation looks good, send it to Gustav:
    sbt docs/publishRsync
  6. Do not forget to push the new branch back to GitHub.