Skip to content

Latest commit

 

History

History
24 lines (16 loc) · 1.5 KB

RELEASING.md

File metadata and controls

24 lines (16 loc) · 1.5 KB

Releasing Akka SDK

Create a release issue:

bin/create-release-issue.sh 3.1.0

and follow the instructions.

Publishing documentation hotfixes

The documentation is automatically published with regular releases.

To publish documentation of certain merged Pull Requests:

  1. mark the merged documentation PRs that should be published with the docs-publish label,
  2. check all desired PRs are on the list,
  3. trigger the Publish docs (cherry-pick batch) workflow,
  4. review the PR it creates and merge it (do not squash — squashing drops the cherry picked from trailers) to the docs-current branch,
  5. the Documentation to doc.akka.io will trigger.

(The "Publish docs" workflow adds the docs-published label to the PRs it handled.)

If a cherry-pick fails, the workflow comments on the source PR, skips it, and lists it under "Skipped" in the batch PR body. Those changes will not be published until you either cherry-pick them onto docs-current by hand, or fix the source branch and re-run the workflow (the docs-publish label is still there, so the PR will be picked up on the next run).