Repository navigation
Java SDK: Rewrite the user docs around Dag definition - #74701
Merged
jason810496 merged 5 commits intoOct 23, 2026
Merged
Conversation
jason810496
force-pushed
the
docs/java-sdk/align-user-docs
branch
2 times, most recently
from
October 20, 2026 02:07
6cf0e4f to
bd256f1
Compare
jason810496
marked this pull request as ready for review
October 20, 2026 03:55
jason810496
requested review from
amoghrajesh,
ashb,
bugraoz93,
gopidesupavan,
jscheffl,
potiuk and
uranusjr
as code owners
October 20, 2026 03:55
FrankYang0529
left a comment
FrankYang0529
left a comment
Member
There was a problem hiding this comment.
Thanks for the PR. Leave some comments.
uranusjr
reviewed
Oct 21, 2026
uranusjr
reviewed
Oct 21, 2026
uranusjr
reviewed
Oct 21, 2026
uranusjr
reviewed
Oct 21, 2026
uranusjr
reviewed
Oct 21, 2026
uranusjr
reviewed
Oct 21, 2026
jason810496
commented
Oct 22, 2026
jason810496
left a comment
jason810496
left a comment
Member
Author
There was a problem hiding this comment.
Thanks for the review.
jason810496
force-pushed
the
docs/java-sdk/align-user-docs
branch
from
October 22, 2026 04:21
c75ec90 to
dc14053
Compare
jason810496
force-pushed
the
docs/java-sdk/align-user-docs
branch
from
October 22, 2026 08:31
dc14053 to
c289b5a
Compare
uranusjr
reviewed
Oct 22, 2026
uranusjr
reviewed
Oct 22, 2026
jason810496
force-pushed
the
docs/java-sdk/align-user-docs
branch
from
October 22, 2026 12:48
c289b5a to
b6f358f
Compare
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. Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
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. Co-Authored-By: Claude <noreply@anthropic.com>
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. Co-Authored-By: Claude <noreply@anthropic.com>
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. Co-Authored-By: Claude <noreply@anthropic.com>
jason810496
force-pushed
the
docs/java-sdk/align-user-docs
branch
from
October 23, 2026 03:07
b6f358f to
1b80207
Compare
Contributor
Backport failed to create: v3-4-test. View the failure log Run detailsNote: As of Merging PRs targeted for Airflow 3.X In matter of doubt please ask in #release-management Slack channel.
You can attempt to backport this manually by running: cherry_picker a419633 v3-4-testThis should apply the commit to the v3-4-test branch and leave the commit in conflict state marking After you have resolved the conflicts, you can continue the backport process by running: cherry_picker --continueIf you don't have cherry-picker installed, see the installation guide. |
1 task done
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
3 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.
Why
The Java SDK guide started from stub tasks of a Python Dag and did not cover conditions, switches or
TriggerDagRun, and the README mixed user docs with the contributor and release guide.What
java.rst: rewrite it in the same order as the TypeScript guide.@Airflow.If/dag.If,@Airflow.Switch/dag.SwitchandTriggerDagRun.Clientmethods and the logging integrations.java-sdk/README.md: keep installation, a quick start, links to the guide and the compatibility matrix.java-sdk/DEVELOPMENT.md: new, holding the build, release and contributing content moved from the README. References to it are updated.java-sdk/example/README.md: new, listing the example Dags under "Dag definition" and "Python Dag with stub TaskHandler".java-sdk/sdk/module.md(API reference landing page): add a quick start.Was generative AI tooling used to co-author this PR?