The GitHub Actions job "Binary Compatibility" on pekko.git/deprecate-source-queue-overloads has succeeded. Run started by GitHub user He-Pin (triggered by He-Pin).
Head commit for run: 44e3d67c4209935da834138c7647b8e1d812b861 / 虎鸣 <[email protected]> docs(stream): broaden deprecation coverage across actor-interop and see-also links Motivation: A reviewer pointed out that docs/src/main/paradox/stream/actor-interop.md still describes the deprecated OverflowStrategy.backpressure path as the recommended Source.queue usage, while the #source-queue snippet it references was updated in the previous commit to use BoundedSourceQueue with a synchronous match. The surrounding prose (lines 131-161) was therefore inconsistent with the snippet — telling the reader "offer returns a Future" while the snippet showed a direct match on QueueOfferResult. Separately, the "See also" entry for Source.queue in operators/Source/actorRefWithBackpressure.md still referred to the deprecated "SourceQueue" wording, even though the recommended path now materializes a BoundedSourceQueue. A second reviewer pass also flagged that the #source-queue-synchronous Scala snippet still declared `implicit val ec = system.dispatcher` even though the synchronous match on QueueOfferResult does not need an ExecutionContext. This was misleading in an example that is explicitly labeled "synchronous". Modification: - actor-interop.md: prepend a @@@ warning { } callout at the top of the Source.queue subsection flagging the deprecated API and explicitly noting that the referenced snippet has been updated to the non-deprecated path. Existing prose (lines 131-173) is left untouched so historical context is preserved. - actorRefWithBackpressure.md: update the Source.queue "See also" entry wording from "SourceQueue" to "BoundedSourceQueue". - queue.md: keep the original prose and structure intact (both BoundedSourceQueue and SourceQueue sections, both examples, all existing wording). Add a @@@ warning { } callout after the operator summary (post-index-extractor block) that points readers to the recommended API and to the migration table. Add a smaller warning directly above the deprecated Signature(SourceQueue) block. Append the per-OverflowStrategy migration table at the bottom. - index.md: restored (no change vs HEAD~1) — the landing row still mentions both BoundedSourceQueue and SourceQueue. - IntegrationDocSpec.scala: drop `implicit val ec = system.dispatcher` from the #source-queue-synchronous Scala snippet. The synchronous match on QueueOfferResult does not require an ExecutionContext. Result: Readers landing on actor-interop.md or the Source.queue page see a clear deprecation notice before the legacy prose. Operators index entry is unchanged. The SourceQueue subsection of queue.md still documents the deprecated path for users on older versions, with an explicit warning above it. The synchronous Scala snippet no longer declares an unused ExecutionContext. No historical prose was removed. Tests: - sbt "docs / Compile / managedResources" — pass (paradox StreamOperatorsIndexGenerator extracts the summary/category link successfully) - sbt "docs / Test / compile" — pass (1 Scala source incremental recompile after the ec removal; prior run had passed 224 Scala + 234 Java sources) References: Refs apache/pekko#3094 Report URL: https://github.com/apache/pekko/actions/runs/27842137961 With regards, GitHub Actions via GitBox --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
