Skip to content

[v3-4-test] Java SDK: Rewrite the user docs around Dag definition (#74701) - #75439

Merged
jason810496 merged 1 commit into
apache:v3-4-testfrom
jason810496:backport-74701-v3-4-test
Oct 23, 2026
Merged

jason810496 merged 1 commit into
apache:v3-4-testfrom
jason810496:backport-74701-v3-4-test

Conversation

@jason810496

Copy link
Copy Markdown
Member

Backport of #74701 to v3-4-test. The automatic backport failed to cherry-pick it (run details), so it is picked by hand from a419633.

One adaptation, since v3-4-test and main differ here: v3-4-test keeps the signal-aware Context (#74690, backported in #75386) because the revert on main (#75421) was not backported, so this keeps the "Stopping when Airflow asks" section that the main version of the rewrite no longer has. Everything else matches the original commit.


Was generative AI tooling used to co-author this PR?

* Java SDK: Rewrite the user docs around Dag definition

Reorder the Java SDK guide to start from a Dag defined in Java, document
conditions, switches and TriggerDagRun, and add a table of how stub task
arguments bind. Split the README into a user landing page and
DEVELOPMENT.md, and add an example README.

* Add Logback and appender to the docs spelling wordlist

* Address review: Dag-level queue, version sync, dropped constraints

Set the queue once on the Dag in every example, now that a Java Dag takes
one, and bump the documented version to 1.0.0-beta2 everywhere. Add a prek
hook that fails when the guide, the README and the Dokka landing page name
different versions. Restore the TaskInput constraints, correct the
LocalExecutor wording, and drop the Python Label comparison.

* Generate the quick start of the Java SDK README and Dokka page

The quick start appears on three pages. The guide owns it now, between
SHARED SNIPPET markers, and the sync-java-sdk-docs hook copies it into the
other two and still checks that all three install the same version.

* Address review: install a version placeholder, not a release

The three pages that show how to install the SDK pinned a release that is
not out yet, which also held the PR back. They now install `<version>` and
link to Maven Central, and the sync hook fails when a page names a release
instead. The parse-failure bullet leads with the SDK release a JAR was built
with, and keeps the supervisor schema version as the explanation.

---------

(cherry picked from commit a419633)
@jason810496
jason810496 merged commit 217ec2d into apache:v3-4-test Oct 23, 2026
130 checks passed
jason810496 added a commit that referenced this pull request Oct 23, 2026
This reverts commit eda782f.

Since it merged, the K8S Lang-SDK test has hung in about 40% of CI runs:
a Java task stops right after its first request to the supervisor and
stays running until the test times out. Every run before the merge
passed. Reverting keeps CI usable while the hang is investigated on
#74690.

Generated-by: Claude Opus 5
(cherry picked from commit 40b5d36)

One adaptation: #75439 rewrote the "Stopping when Airflow asks" section
of java.rst, so the section is removed in that rewritten form rather
than the one the original revert deletes. java.rst now matches main.

Co-authored-by: Jarek Potiuk <jarek@potiuk.com>
Co-authored-by: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant