mdedetrich commented on code in PR #256: URL: https://github.com/apache/incubator-pekko/pull/256#discussion_r1143332531
########## docs/src/main/paradox/project/downstream-upgrade-strategy.md: ########## @@ -14,22 +14,22 @@ wait for intermediate libraries to update. ## Patch versions -When releasing a new patch version of Pekko (e.g. 2.5.22), we typically don't +When releasing a new patch version of Pekko (e.g. 1.1.0), we typically don't immediately bump the Pekko version in satellite projects. The reason for this is this will make it more low-friction for users to update -those satellite projects: say their project is on Pekko 2.5.22 and +those satellite projects: say their project is on Pekko 1.1.0 and Pekko Management 1.0.0, and we release Pekko Management 1.0.1 (still built with -Pekko 2.5.22) and Pekko 2.5.23. They can safely update to Pekko Management 1.0.1 -without also updating to Pekko 2.5.23, or update to Pekko 2.5.23 without updating +Pekko 1.1.0) and Pekko 1.1.1. They can safely update to Pekko Management 1.0.1 +without also updating to Pekko 1.1.1, or update to Pekko 1.1.1 without updating to Pekko Management 1.0.1. When there is reason for a satellite project to upgrade the Pekko patch version, they are free to do so at any time. ## Minor versions -When releasing a new minor version of Pekko (e.g. 2.6.0), satellite projects are +When releasing a new minor version of Pekko (e.g. 1.1.0), satellite projects are Review Comment: Related to https://github.com/apache/incubator-pekko/issues/56, if we setup scala-steward then satellite projects would pretty much be updated as soon as the release is made. Should we mention this here? ########## docs/src/main/paradox/common/binary-compatibility-rules.md: ########## @@ -78,16 +74,16 @@ If you accidentally mix Pekko versions, for example through transitive dependencies, you might get a warning at run time such as: ``` -You are using version 2.6.6 of Pekko, but it appears you (perhaps indirectly) also depend on older versions -of related artifacts. You can solve this by adding an explicit dependency on version 2.6.6 of the +You are using version 1.0.6 of Pekko, but it appears you (perhaps indirectly) also depend on older versions +of related artifacts. You can solve this by adding an explicit dependency on version 1.0.6 of the [pekko-persistence-query] artifacts to your project. Here's a complete collection of detected -artifacts: (2.5.3, [pekko-persistence-query]), (2.6.6, [pekko-actor, pekko-cluster]). +artifacts: (1.0.3, [pekko-persistence-query]), (1.0.6, [pekko-actor, pekko-cluster]). See also: https://pekko.apache.org/docs/pekko/current/common/binary-compatibility-rules.html#mixed-versioning-is-not-allowed ``` The fix is typically to pick the highest Pekko version, and add explicit dependencies to your project as needed. For example, in the example above -you might want to add `pekko-persistence-query` dependency for 2.6.6. +you might want to add `pekko-persistence-query` dependency for 1.0.6. Review Comment: Shouldn't this be `1.0.0`? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
