Skip to content

Latest commit

 

History

History
44 lines (33 loc) · 1.52 KB

RELEASING.md

File metadata and controls

44 lines (33 loc) · 1.52 KB
Raw

Releasing

When to release

Akka gRPC is released when there is a need for it.

If you want to test an improvement that is not yet released, you can use a snapshot version. We publish snapshot versions for every commit to the main branch. Snapshot builds are available at https://repo.akka.io/snapshots.

How to release

Create a new issue from the Release Train Issue Template:

$ sh ./scripts/create-release-issue.sh 0.x.y

Gradle plugin release details

The Gradle plugin goes directly to the Gradle Plugin Portal. Publishing keys are stored as Github Action secrets and referred to in the Github Action job.

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 := "0.6.1"
ThisBuild / isSnapshot := false
  3. Make all of the required changes to the documentation.
  4. Build documentation locally with: 
    sbt akka-grpc-docs/previewSite
  5. If the generated documentation looks good, send it to Gustav: 
    rm -r docs/target/site
sbt akka-grpc-docs/publishRsync
  6. Do not forget to push the new branch back to GitHub.