docs: link to app-version from Deployment for rolling updates#3276
Open
He-Pin wants to merge 1 commit into
Open
docs: link to app-version from Deployment for rolling updates#3276He-Pin wants to merge 1 commit into
He-Pin wants to merge 1 commit into
Conversation
Member
|
This won't work. We have no release with the pekko management changes. We would have to change the sbt setup in this repo to link pekko management docs to last management milestone release which may or may not have these docs. I'm travelling today so don't much access to check. We may even need to point to the snapshot docs for Pekko management. |
Member
Author
|
yes need thanks |
Member
Author
|
Fixed: added a |
He-Pin
added a commit
that referenced
this pull request
Jul 1, 2026
Motivation: The rolling-updates page links to the pekko-management "app-version from Deployment" section, but that page does not exist in any released version of pekko-management yet, so the extref resolved to a broken link. Modification: Add a `pekko-management-snapshot` extref prefix in Paradox.scala pointing to the snapshot docs URL, and use it for the new link. Result: The generated link resolves to https://pekko.apache.org/docs/pekko-management/snapshot/rolling-updates.html#app-version-from-deployment which is the correct target until a pekko-management release ships the page. Tests: sbt "docs/paradox" builds successfully; generated HTML verified. References: Fixes review feedback on #3276.
He-Pin
added a commit
that referenced
this pull request
Jul 1, 2026
Motivation: The rolling-updates page links to the pekko-management "app-version from Deployment" section, but that page does not exist in any released version of pekko-management yet, so the extref resolved to a broken link. Modification: Add a `pekko-management-snapshot` extref prefix in Paradox.scala pointing to the snapshot docs URL, and use it for the new link. Result: The generated link resolves to https://pekko.apache.org/docs/pekko-management/snapshot/rolling-updates.html#app-version-from-deployment which is the correct target until a pekko-management release ships the page. Tests: sbt "docs/paradox" builds successfully; generated HTML verified. References: Fixes review feedback on #3276.
He-Pin
force-pushed
the
port/d1e577a8ba-app-version-deploy-doc
branch
from
7bd6b04 to
c0e7a0f
Compare
Motivation: The rolling-updates docs explained the manual pekko.cluster.app-version setting but did not mention that Pekko Management can derive it automatically from a Kubernetes Deployment. Modification: - Add a paragraph pointing to the app-version from Deployment feature in Pekko Management - Add a pekko-management-snapshot extref prefix for the link target Result: Users on Kubernetes are pointed to the automatic app-version mechanism. Refs #3276
He-Pin
force-pushed
the
port/d1e577a8ba-app-version-deploy-doc
branch
from
c0e7a0f to
58d95d4
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
The rolling-updates docs explained the manual
pekko.cluster.app-versionsetting but did not mention that Pekko Management can derive it automatically from a Kubernetes Deployment, so users on Kubernetes bumped the version by hand unnecessarily.Modification
Add a paragraph to the rolling-updates page pointing to the app-version from Deployment feature in Pekko Management, which sets
app-versionfrom the Kubernetesdeployment.kubernetes.io/revisionannotation.The upstream commit also touched
deploying.mdand added a#kubernetes-rolling-updatesanchor to an existing link inrolling-updates.md, but pekko'sdeploying.mdhas diverged (no matching "Rolling updates" section) and pekko's correspondingrolling-updates.mdtext was rewritten without that link, so only the new app-version paragraph applies here.Result
Users running on Kubernetes Deployments are pointed to the automatic app-version mechanism instead of bumping it manually.
which is now Apache licensed
Tests
Not run - docs only.
sbt "docs/paradox"builds successfully and thepekko-management:rolling-updates.html#app-version-from-deploymentextref resolves to a real anchor in Pekko Management.References
Ports akka/akka-core@d1e577a8ba (akka#31942), which is now Apache licensed.