Use this command to create a release issue of Release Train Issue Template and follow the steps.
~/akka-persistence-jdbc> scripts/create-release-issue.sh `version-to-be-released`
It is possible to release a revised documentation to the already existing release.
- 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 bedocs/v0.3
. - Add and commit
version.sbt
file that pins the version to the one, that is being revised. Also setisSnapshot
tofalse
for the stable documentation links. For example:ThisBuild / version := "4.0.0" ThisBuild / isSnapshot := false
- Make all of the required changes to the documentation.
- Build documentation locally with
CI
settings:env CI=true sbt docs/previewSite
- If the generated documentation looks good, send it to Gustav:
env CI=true sbt docs/publishRsync
- Do not forget to push the new branch back to GitHub.
- Commit the changes to Gustav's local git repo
Snapshots are released automatically when commits are pushed to master.