2018-07-02 16:38:07 +02:00
# Releasing
2024-06-27 09:27:30 +02:00
Create a new issue from the [Release Train Issue Template ](akka-docs/release-train-issue-template.md ):
2021-06-08 09:05:16 +02:00
```
$ sh ./scripts/create-release-issue.sh 0.x.y
```
# Manually
2018-07-02 16:38:07 +02:00
## Prerequisites
2019-07-30 07:55:33 -07:00
### One Time GPG and sbt-pgp setup
If you have not set up GPG or used `sbt-pgp` on the release machine
* Check the [sbt-pgp usage ](https://www.scala-sbt.org/sbt-pgp/usage.html ) for any setup steps you may still need, for example:
```
sbt> set pgpReadOnly := false
sbt> pgp-cmd gen-key
` ``
* Check that signing works with ` sbt> publishLocalSigned`
#### Mac
When releasing from MacOS you may want to use YubiKey or have [MacGPG](https://gpgtools.org) installed.
#### Windows
2018-07-02 16:38:07 +02:00
When releasing from Windows, you need MinGW and a gpg distribution such as Gpg4Win
### Git
Make sure you have set ` core.autocrlf` to ` false` in your ` ~/.gitconfig`,
otherwise git might convert line endings in some cases.
2019-07-30 07:55:33 -07:00
### Install Graphviz
[Graphvis](https://graphviz.gitlab.io/download/) is needed for the
scaladoc generation build task, which is part of the release.
2019-03-04 14:18:40 +01:00
## Snapshot releases
2025-10-21 13:17:24 -04:00
Snapshot releases are created from ` main` and published to https://repo.akka.io/TOKEN/secure/snapshots/
2019-03-04 14:18:40 +01:00
2021-06-23 17:06:13 +02:00
To create snapshot versions manually, use ` sbt clean publishLocal`.
If you have access, you can use ` +publishSigned` to publish them to
2023-10-18 15:19:54 +02:00
repo.akka.io.
2019-03-04 14:18:40 +01:00
2020-04-01 20:41:56 +02:00
## Releasing only updated docs
It is possible to release a revised documentation to the already existing release.
2021-08-05 18:19:00 +02:00
1. Create a new branch from a release tag. If a revised documentation is for the ` v2.6.4` release, then the name of the new branch should be ` docs/v2.6.4`:
` ``
$ git checkout v2.6.4
$ git checkout -b docs/v2.6.4
` ``
2020-04-01 20:41:56 +02:00
1. 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:
` ``scala
ThisBuild / version := "2.6.4"
ThisBuild / isSnapshot := false
` ``
2021-08-05 18:19:00 +02:00
1. Switch to a new branch for your documentation change, make the change
2020-04-01 20:41:56 +02:00
1. Build documentation locally with:
` ``sh
sbt akka-docs/paradoxBrowse
` ``
2021-12-03 11:49:39 +01:00
1. If the generated documentation looks good, create a PR to the ` docs/v2.6.4` branch you created earlier.
2021-08-05 18:19:00 +02:00
1. It should automatically be published by GitHub Actions on merge.
