From 267ff29ada0e9b9fb5d3ac900306e58a6452fd23 Mon Sep 17 00:00:00 2001 From: PJ Fanning Date: Fri, 9 Oct 2026 04:36:23 +0100 Subject: [PATCH] docs: fix wrong PR links and other mistakes in the release notes (#3598) Motivation: Checking every PR and issue reference in the release notes against GitHub, and the dependency versions against the release tags, found wrong PR numbers, mismatched labels and URLs, two wrong dependency entries, inconsistent heading levels and some typos. Modification: - Wrong PR numbers: - 1.1.3 mixed Akka/Pekko cluster: PR1462 ("publish 1.0.3 docs") -> PR1562 - 1.1.2 OSGi metadata: PR1464 (the sharding revert) -> PR1480 - 1.1.0 virtual thread dispatcher: PR1299 (closed, not merged) -> PR1436 - 1.2.0 StreamTestKit duration timeout: PR1648 -> PR1468 - 1.2.0 CompletionStages helper: 2049 is the issue -> PR2060 - 1.3.0 PR2336 and PR2337 were swapped - 1.0.3 TcpDnsClient: 1182 is the issue -> PR1183 - 1.7.0 EndpointReader: #3169 is a PR, link it as one - Fix PR labels with issues/ URLs and vice versa (PR1743, PR1594, #1463) - 1.2.0 dependencies: slfj4 -> slf4j; jupiter-junit 5.13.3 -> junit-jupiter 5.13.4 (per the v1.2.0 tag) - 2.0.0-M3: "Bug fix" -> "Bug Fixes" heading, "Var Handles" -> "VarHandles" - Version headings in releases-1.2 to 1.7 are H2 like the 1.0, 1.1 and 2.0 pages (they were H1, the same level as the page title) - Add the missing 1.1.1 milestone link, name the 1.2.1 milestone, and add the Java support line to the 1.0.x page - Typos: "This is a milestone release", "to get it to work", "it is likely", an unfinished sentence and a stray parenthesis in 1.0 Result: Release note links point to the right PRs and issues, and the pages are consistent. Tests: - Not run - docs only References: None - found during a review of the release notes (cherry picked from commit 1dd51690af2fdb317fec4241cd476c83aac4e768) --- .../main/paradox/release-notes/releases-1.0.md | 10 ++++++---- .../main/paradox/release-notes/releases-1.1.md | 14 +++++++------- .../main/paradox/release-notes/releases-1.2.md | 16 ++++++++-------- .../main/paradox/release-notes/releases-1.3.md | 6 +++--- .../main/paradox/release-notes/releases-1.4.md | 2 +- .../main/paradox/release-notes/releases-1.5.md | 2 +- .../main/paradox/release-notes/releases-1.6.md | 2 +- .../main/paradox/release-notes/releases-1.7.md | 6 +++--- 8 files changed, 30 insertions(+), 28 deletions(-) diff --git a/docs/src/main/paradox/release-notes/releases-1.0.md b/docs/src/main/paradox/release-notes/releases-1.0.md index 56882d77328..b2f28af212a 100644 --- a/docs/src/main/paradox/release-notes/releases-1.0.md +++ b/docs/src/main/paradox/release-notes/releases-1.0.md @@ -1,12 +1,14 @@ # Release Notes (1.0.x) +Apache Pekko 1.0.x releases support Java 8 and above. + ## 1.0.3 Contains all the changes in 1.0.3-M1 but this release is safe to be used in production. There are a few additional changes. ### Bug Fixes -* TcpDnsClient cannot recover if registration on TcpConnection times out ([PR1182](https://github.com/apache/pekko/pull/1182)) +* TcpDnsClient cannot recover if registration on TcpConnection times out ([PR1183](https://github.com/apache/pekko/pull/1183)) * Fix `ByteIterator#indexWhere` ([PR1282](https://github.com/apache/pekko/pull/1282)) * Avoid unnecessary shard updates while shutting down ([PR1342](https://github.com/apache/pekko/pull/1342)) @@ -15,7 +17,7 @@ Contains all the changes in 1.0.3-M1 but this release is safe to be used in prod * Remove the deprecation of statefulMapConcat operator ([PR1161](https://github.com/apache/pekko/pull/1161)) ## 1.0.3-M1 -This is milestone release and is aimed at testing some new support for users who want to add Pekko nodes to an existing Akka cluster. This support is experimental. This release should not be used in production. +This is a milestone release and is aimed at testing some new support for users who want to add Pekko nodes to an existing Akka cluster. This support is experimental. This release should not be used in production. ### Bug Fixes @@ -26,7 +28,7 @@ This is milestone release and is aimed at testing some new support for users who * Change the manager name to use `pekko` in the name ([PR587](https://github.com/apache/pekko/pull/587)) * Support interacting with Akka Remote and Cluster nodes ([PR765](https://github.com/apache/pekko/pull/765), [PR1112](https://github.com/apache/pekko/pull/1112)) - * See the [wiki notes](https://cwiki.apache.org/confluence/display/PEKKO/Pekko+Akka+Compatibility) about uptaking this + * See the [wiki notes](https://cwiki.apache.org/confluence/display/PEKKO/Pekko+Akka+Compatibility) about using this support. * Change noisy logging in DNS handler ([PR835](https://github.com/apache/pekko/pull/835)) * Support reading akka-persistence snapshots ([PR837](https://github.com/apache/pekko/pull/837), [PR841](https://github.com/apache/pekko/pull/841)) * Fix deprecation version on GraphApply ([PR877](https://github.com/apache/pekko/pull/877)) @@ -89,4 +91,4 @@ We have tried to limit the changes to third party dependencies that are used in * scalatest 3.2.14. Pekko users who have existing tests based on Akka Testkit may need to migrate their tests due to the scalatest upgrade. The [scalatest 3.2 release notes](https://www.scalatest.org/release_notes/3.2.0) have a detailed description of the changes needed. ### Known Issues -* The Pekko tests run well in our GitHub Actions continuous integration setup but can be hard to get running locally. We are adding improvements and they can be tracked among our GitHub issues using the [make-tests-easier-to-run](https://github.com/apache/pekko/issues?q=label%3Amake-tests-easier-to-run+) label). +* The Pekko tests run well in our GitHub Actions continuous integration setup but can be hard to get running locally. We are adding improvements and they can be tracked among our GitHub issues using the [make-tests-easier-to-run](https://github.com/apache/pekko/issues?q=label%3Amake-tests-easier-to-run+) label. diff --git a/docs/src/main/paradox/release-notes/releases-1.1.md b/docs/src/main/paradox/release-notes/releases-1.1.md index 770ce04c454..ba5ba265b87 100644 --- a/docs/src/main/paradox/release-notes/releases-1.1.md +++ b/docs/src/main/paradox/release-notes/releases-1.1.md @@ -19,11 +19,11 @@ Pekko 1.1.4 is a bug fix and dependency upgrade release. See [GitHub Milestone f * Fix occasional ordering issue in FlowWithContext#unsafeOptionalDataVia ([PR1681](https://github.com/apache/pekko/pull/1681)) * Issue forming mixed Akka/Pekko cluster when classic remoting with SSL/TLS is used ([PR1857](https://github.com/apache/pekko/pull/1857)) * Join cluster check adjusted to support Akka nodes ([PR1866](https://github.com/apache/pekko/pull/1866), [PR1877](https://github.com/apache/pekko/pull/1877)) - * If you are attempting to mix Akka and Pekko nodes in a cluster, it is still recommended to disable the join cluster check but these changes may be enough to get it work ([docs](https://cwiki.apache.org/confluence/display/PEKKO/Pekko+Akka+Compatibility)). + * If you are attempting to mix Akka and Pekko nodes in a cluster, it is still recommended to disable the join cluster check but these changes may be enough to get it to work ([docs](https://cwiki.apache.org/confluence/display/PEKKO/Pekko+Akka+Compatibility)). ### Changes -* Add the missing EmptySource case to TraversalBuilder ([PR1743](https://github.com/apache/pekko/issues/1743)) +* Add the missing EmptySource case to TraversalBuilder ([PR1743](https://github.com/apache/pekko/pull/1743)) ### Dependency Changes @@ -40,7 +40,7 @@ Pekko 1.1.3 is a bug fix and dependency upgrade release. See [GitHub Milestone f ### Changes -* Extra changes needed for our [experimental support](https://cwiki.apache.org/confluence/display/PEKKO/Pekko+Akka+Compatibility) for mixed clusters with Pekko and Akka nodes ([PR1462](https://github.com/apache/pekko/issues/1462), [PR1594](https://github.com/apache/pekko/issues/1594)) +* Extra changes needed for our [experimental support](https://cwiki.apache.org/confluence/display/PEKKO/Pekko+Akka+Compatibility) for mixed clusters with Pekko and Akka nodes ([PR1562](https://github.com/apache/pekko/pull/1562), [PR1594](https://github.com/apache/pekko/pull/1594)) * Configuring persistence plugins at runtime for EventSourcedBehavior ([PR1518](https://github.com/apache/pekko/pull/1518)) * Implement EventsByTagQuery in PersistenceTestKitReadJournal ([PR1533](https://github.com/apache/pekko/pull/1533)) * Implement EventsBySliceQuery in PersistenceTestKitReadJournal ([PR1533](https://github.com/apache/pekko/pull/1533)) @@ -58,7 +58,7 @@ Pekko 1.1.2 is a bug fix and dependency upgrade release. See [GitHub Milestone f ### Bug Fixes -* Fix version issue in OSGi metadata ([PR1464](https://github.com/apache/pekko/pull/1464)) +* Fix version issue in OSGi metadata ([PR1480](https://github.com/apache/pekko/pull/1480)) * Support primitives in Flow#collectType ([PR1490](https://github.com/apache/pekko/pull/1490)) ### Changes @@ -72,7 +72,7 @@ Pekko 1.1.2 is a bug fix and dependency upgrade release. See [GitHub Milestone f ## 1.1.1 -Pekko 1.1.1 is a bug fix release. +Pekko 1.1.1 is a bug fix release. See [GitHub Milestone for 1.1.1](https://github.com/apache/pekko/milestone/10?closed=1) for a fuller list of changes. ### Bug Fixes @@ -159,7 +159,7 @@ The Stream Testkit Java DSL has some extra functions. * Remove the deprecation of statefulMapConcat operator ([PR1147](https://github.com/apache/pekko/pull/1147)) * Add AbruptStreamTerminationException as super class of some related exceptions ([PR1201](https://github.com/apache/pekko/pull/1201)) * For Pekko Persistence DurableState API, a new DeleteRevisionException has been added and the aim is to have implementations fail with that exception if a deleteObject does not delete exactly one record for that revision ([PR1271](https://github.com/apache/pekko/pull/1271)) -* Support for a dispatcher that uses Virtual Threads ([PR1299](https://github.com/apache/pekko/pull/1299)) (not in v1.1.0-M1) +* Support for a dispatcher that uses Virtual Threads ([PR1436](https://github.com/apache/pekko/pull/1436)) (not in v1.1.0-M1) * Avoid unnecessary shard updates while shutting down ([PR1342](https://github.com/apache/pekko/pull/1342)) (not in v1.1.0-M1) * Support just warning instead of error when pekko.scheduler.tick-duration < 10ms on Windows ([#1364](https://github.com/apache/pekko/issues/1364)) (not in v1.1.0-M1) * Support the flattening syntax for supervising ([PR1386](https://github.com/apache/pekko/pull/1386)) (not in v1.1.0-M1) @@ -179,7 +179,7 @@ Most of the dependency changes are small patch level upgrades. Some exceptions i ### Known Issues -* A race condition has been introduced into pekko-cluster-sharding which needs to be fixed in a Pekko 1.1.1 release. Users who use Cluster Sharding should skip this release. The problem does not appear in v1.1.0-M1. ([#1463](https://github.com/apache/pekko/pull/1463)) +* A race condition has been introduced into pekko-cluster-sharding which needs to be fixed in a Pekko 1.1.1 release. Users who use Cluster Sharding should skip this release. The problem does not appear in v1.1.0-M1. ([#1463](https://github.com/apache/pekko/issues/1463)) * For Scala 2.12 users, we have run into an issue with stream-testkit function `expectNextWithTimeoutPF` ([#1393](https://github.com/apache/pekko/issues/1393)). * For now, the consensus is not to change this as it appears to be more of a Scala 2.12 compiler issue. * Affected Scala 2.12 users can stick with Pekko 1.0 or change their code to get it to compile. The most reliable code change is to move the PartialFunction code and declare it as a `val`. diff --git a/docs/src/main/paradox/release-notes/releases-1.2.md b/docs/src/main/paradox/release-notes/releases-1.2.md index 465912f36a0..c99637ae1d2 100644 --- a/docs/src/main/paradox/release-notes/releases-1.2.md +++ b/docs/src/main/paradox/release-notes/releases-1.2.md @@ -2,9 +2,9 @@ Apache Pekko 1.2.x releases support Java 8 and above. -# 1.2.1 +## 1.2.1 -Pekko 1.2.1 has some bug fixes and some code has been deprecated to signal that it likely to be removed in 2.0.0. See the [GitHub Milestone](https://github.com/apache/pekko/milestone/20?closed=1) for a fuller list of changes. +Pekko 1.2.1 has some bug fixes and some code has been deprecated to signal that it is likely to be removed in 2.0.0. See the [GitHub Milestone for 1.2.1](https://github.com/apache/pekko/milestone/20?closed=1) for a fuller list of changes. ### Bug Fixes @@ -19,7 +19,7 @@ Pekko 1.2.1 has some bug fixes and some code has been deprecated to signal that * netty 4.2.5.Final * lightbend/config 1.4.5 -# 1.2.0 +## 1.2.0 Pekko 1.2.0 has some new features, performance updates and dependency upgrades. See [GitHub Milestone for 1.2.0-M1](https://github.com/apache/pekko/milestone/6?closed=1), [GitHub Milestone for 1.2.0-M2](https://github.com/apache/pekko/milestone/15?closed=1) and [GitHub Milestone for 1.2.0](https://github.com/apache/pekko/milestone/16?closed=1) for a fuller list of changes. @@ -33,7 +33,7 @@ Most of the changes appeared in the milestone releases (1.2.0-M1 and 1.2.0-M2) b * Add the missing EmptySource case to TraversalBuilder ([PR1743](https://github.com/apache/pekko/pull/1743)) * Issue forming mixed Akka/Pekko cluster when classic remoting with SSL/TLS is used ([PR1857](https://github.com/apache/pekko/pull/1857)) * Join cluster check adjusted to support Akka nodes ([PR1866](https://github.com/apache/pekko/pull/1866), [PR1877](https://github.com/apache/pekko/pull/1877)) - * If you are attempting to mix Akka and Pekko nodes in a cluster, it is still recommended to disable the join cluster check but these changes may be enough to get it work ([docs](https://cwiki.apache.org/confluence/display/PEKKO/Pekko+Akka+Compatibility)). + * If you are attempting to mix Akka and Pekko nodes in a cluster, it is still recommended to disable the join cluster check but these changes may be enough to get it to work ([docs](https://cwiki.apache.org/confluence/display/PEKKO/Pekko+Akka+Compatibility)). * BroadcastHub drops elements due to register/unregister race ([PR1841](https://github.com/apache/pekko/pull/1841)) * Fix issue with number deserialization in pekko-cluster-metrics ([PR1899](https://github.com/apache/pekko/pull/1899)) * Fix typed persistence stack overflow with many read only commands ([PR1919](https://github.com/apache/pekko/pull/1919)) @@ -44,7 +44,7 @@ Most of the changes appeared in the milestone releases (1.2.0-M1 and 1.2.0-M2) b * add non-default config that allows InboundQuarantineCheck to ignore 'harmless' quarantine events ([PR1555](https://github.com/apache/pekko/pull/1555)) * New Sink.none operator ([PR1614](https://github.com/apache/pekko/pull/1614)) -* Add overridden duration timeout to StreamTestKit ([PR1648](https://github.com/apache/pekko/pull/1648)) +* Add overridden duration timeout to StreamTestKit ([PR1468](https://github.com/apache/pekko/pull/1468)) * Add Identity function to Java DSL ([PR1671](https://github.com/apache/pekko/pull/1671)) * Add support for controlling the NettyTransport's byteBuf allocator type ([PR1707](https://github.com/apache/pekko/pull/1707)) * Add Pattern timeout support ([PR1424](https://github.com/apache/pekko/pull/1424)) @@ -65,7 +65,7 @@ Most of the changes appeared in the milestone releases (1.2.0-M1 and 1.2.0-M2) b * Add JournalPersistFailed and JournalPersistRejected signals ([PR1961](https://github.com/apache/pekko/pull/1961)) * Make calculateDelay a public method ([PR1940](https://github.com/apache/pekko/pull/1940)) * Allow disabling AsyncWriteJournal.Resequencer to improve latency ([#2026](https://github.com/apache/pekko/issues/2026)) -* Add CompletionStages helper ([PR2049](https://github.com/apache/pekko/pull/2049)) +* Add CompletionStages helper ([PR2060](https://github.com/apache/pekko/pull/2060)) ### Changes @@ -100,8 +100,8 @@ Most of the changes appeared in the milestone releases (1.2.0-M1 and 1.2.0-M2) b * jackson 2.19.2 * lightbend/config 1.4.4 * protobuf-java 4.32.0 -* slfj4 2.0.17 -* jupiter-junit 5.13.3 +* slf4j 2.0.17 +* junit-jupiter 5.13.4 * scala 2.12.20, 2.13.16, 3.3.6 ### Known Issues diff --git a/docs/src/main/paradox/release-notes/releases-1.3.md b/docs/src/main/paradox/release-notes/releases-1.3.md index 52e49fc8b64..8891dca85d8 100644 --- a/docs/src/main/paradox/release-notes/releases-1.3.md +++ b/docs/src/main/paradox/release-notes/releases-1.3.md @@ -2,7 +2,7 @@ Apache Pekko 1.3.x releases support Java 8 and above. -# 1.3.0 +## 1.3.0 Pekko 1.3.0 has some bug fixes, new features, performance updates and dependency upgrades. See the [GitHub Milestone for 1.3.0](https://github.com/apache/pekko/milestone/21?closed=1) for a fuller list of changes. @@ -23,8 +23,8 @@ This release includes a number of changes from Akka 2.7.0, which have recently b * ByteString: new indexOf overloaded method that allows from and to ([PR2272](https://github.com/apache/pekko/pull/2272)) * JavaDSL TestKit: add shutdownActorSystem that takes Java Duration params ([PR2277](https://github.com/apache/pekko/pull/2277)) * Add Flow#onErrorContinue operator ([PR2322](https://github.com/apache/pekko/pull/2322)) -* Add missing onErrorResume to SubFlow and SubSource ([PR2336](https://github.com/apache/pekko/pull/2336)) -* Add more recover operators for Java DSL ([PR2337](https://github.com/apache/pekko/pull/2337)) +* Add missing onErrorResume to SubFlow and SubSource ([PR2337](https://github.com/apache/pekko/pull/2337)) +* Add more recover operators for Java DSL ([PR2336](https://github.com/apache/pekko/pull/2336)) * Add doOnFirst operator ([PR2363](https://github.com/apache/pekko/pull/2363)) * Add doOnCancel operator ([PR2375](https://github.com/apache/pekko/pull/2375)) * Add actor-typed Java DSL AbstractMatchingBehavior ([PR2379](https://github.com/apache/pekko/pull/2379)) diff --git a/docs/src/main/paradox/release-notes/releases-1.4.md b/docs/src/main/paradox/release-notes/releases-1.4.md index c3c2ace56d0..2ad088d7d52 100644 --- a/docs/src/main/paradox/release-notes/releases-1.4.md +++ b/docs/src/main/paradox/release-notes/releases-1.4.md @@ -2,7 +2,7 @@ Apache Pekko 1.4.x releases support Java 8 and above. -# 1.4.0 +## 1.4.0 Pekko 1.4.0 has a dependency change and some bug fixes. See the [GitHub Milestone for 1.3.1](https://github.com/apache/pekko/milestone/24?closed=1) and the [GitHub Milestone for 1.4.0](https://github.com/apache/pekko/milestone/25?closed=1) for a fuller list of changes. diff --git a/docs/src/main/paradox/release-notes/releases-1.5.md b/docs/src/main/paradox/release-notes/releases-1.5.md index 359a1239e91..9ca59d5c62d 100644 --- a/docs/src/main/paradox/release-notes/releases-1.5.md +++ b/docs/src/main/paradox/release-notes/releases-1.5.md @@ -2,7 +2,7 @@ Apache Pekko 1.5.x releases support Java 8 and above. -# 1.5.0 +## 1.5.0 Pekko 1.5.0 has some bug fixes and small enhancements. See the [GitHub Milestone for 1.5.0](https://github.com/apache/pekko/milestone/26?closed=1) for a fuller list of changes. diff --git a/docs/src/main/paradox/release-notes/releases-1.6.md b/docs/src/main/paradox/release-notes/releases-1.6.md index b075d948247..a11731bf252 100644 --- a/docs/src/main/paradox/release-notes/releases-1.6.md +++ b/docs/src/main/paradox/release-notes/releases-1.6.md @@ -2,7 +2,7 @@ Apache Pekko 1.6.x releases support Java 8 and above. -# 1.6.0 +## 1.6.0 Pekko 1.6.0 has some bug fixes. See the [GitHub Milestone for 1.6.0](https://github.com/apache/pekko/milestone/29?closed=1) for a fuller list of changes. diff --git a/docs/src/main/paradox/release-notes/releases-1.7.md b/docs/src/main/paradox/release-notes/releases-1.7.md index 0cecf3e9ab6..32a6e7b9974 100644 --- a/docs/src/main/paradox/release-notes/releases-1.7.md +++ b/docs/src/main/paradox/release-notes/releases-1.7.md @@ -2,7 +2,7 @@ Apache Pekko 1.7.x releases support Java 8 and above. -# 1.7.1 +## 1.7.1 Pekko 1.7.1 has some bug fixes. See the [GitHub Milestone for 1.7.1](https://github.com/apache/pekko/milestone/33?closed=1) for a fuller list of changes. @@ -21,13 +21,13 @@ Pekko 1.7.1 has some bug fixes. See the [GitHub Milestone for 1.7.1](https://git * Bound inbound Artery TCP frame length at framing ([PR3525](https://github.com/apache/pekko/pull/3525)) * Bound the size a compressed payload may expand to ([PR3527](https://github.com/apache/pekko/pull/3527)) -# 1.7.0 +## 1.7.0 Pekko 1.7.0 has some bug fixes. See the [GitHub Milestone for 1.7.0](https://github.com/apache/pekko/milestone/30?closed=1) for a fuller list of changes. ### Bug Fixes -* Harden EndpointReader against NonFatal dispatch errors and unwrap WrappedMessage in writer logs ([#3169](https://github.com/apache/pekko/issues/3169)) +* Harden EndpointReader against NonFatal dispatch errors and unwrap WrappedMessage in writer logs ([PR3169](https://github.com/apache/pekko/pull/3169)) * Filter messages from remember-entities store ([PR3411](https://github.com/apache/pekko/pull/3411)) ### Changes