Skip to content

Fix docs publishing when java-sdk is in the packages list - #69434

Merged
potiuk merged 4 commits into
apache:mainfrom
jason810496:ci/fix-java-sdk-docs-publishing
Jul 7, 2026
Merged

Fix docs publishing when java-sdk is in the packages list#69434
potiuk merged 4 commits into
apache:mainfrom
jason810496:ci/fix-java-sdk-docs-publishing

Conversation

@jason810496

@jason810496jason810496 commented Jul 6, 2026•
edited
Loading

Copy link
Copy Markdown
Member

Why

Publishing the Java SDK docs never worked end to end: include-docs containing java-sdk fails the Sphinx build job (the Java SDK docs are a Dokka build, not a Sphinx package), and breeze release-management publish-docs cannot resolve the java-sdk package name, so even an include-docs: all publish from a ref containing java-sdk/ would crash at the publish step.

What

  • Workflow: filter java-sdk out of the packages passed to breeze build-docs, skip the Sphinx build entirely for a java-sdk-only run (an empty list would mean "build everything"), and drop the redundant JAVA_SDK_DOCS publish argument.
  • Breeze: add java-sdk to REGULAR_DOC_PACKAGES so publish-docs resolves it, and skip packages whose docs were not staged instead of failing on version resolution, so publishes from refs without java-sdk/ keep working unchanged.
  • Breeze: resolve the java-sdk docs version from java-sdk/gradle.properties when staged docs lack stable.txt, mirroring the source-fallback the other doc packages have (get_java_sdk_version moved to global_constants).
  • Regenerate breeze help images and add tests for java-sdk package resolution, the publish skip ordering, and version resolution.
Was generative AI tooling used to co-author this PR?

@jason810496
Fix docs publishing when java-sdk is in the packages list
1307c50
Publishing the Java SDK docs never worked end to end: passing java-sdk in
include-docs failed the Sphinx build job (java-sdk is a Dokka build, not a
Sphinx package), and breeze release-management publish-docs could not
resolve the java-sdk package name at all, so even full 'all' publishes from
a ref containing java-sdk/ would have crashed at the publish step. Filter
java-sdk out of the Sphinx build (skipping it entirely for a java-sdk-only
run), teach breeze the java-sdk doc package, and skip packages whose docs
were not staged instead of failing on version resolution, so publishes from
refs without java-sdk keep working unchanged.
@jason810496jason810496 self-assigned this Jul 6, 2026
@jason810496
Resolve java-sdk docs version from gradle.properties when stable.txt …
777d418
…is missing
Review follow-up: a staged-but-incomplete java-sdk docs dir (stable/ present,
stable.txt missing) crashed publish-docs with "Unsupported package"; fall back
to the version in java-sdk/gradle.properties like the other doc packages fall
back to their sources. Also cover the publish skip-ordering and the stable.txt
version resolution with tests.
@jason810496
jason810496 marked this pull request as ready for review July 6, 2026 06:40
uranusjr
uranusjr reviewed Jul 6, 2026
View reviewed changes
Comment threaddev/breeze/src/airflow_breeze/utils/docs_publisher.py Outdated
uranusjr
uranusjr reviewed Jul 6, 2026
View reviewed changes
Comment threaddev/breeze/src/airflow_breeze/commands/release_management_commands.py Outdated
uranusjr
uranusjr reviewed Jul 6, 2026
View reviewed changes
Comment thread.github/workflows/publish-docs-to-s3.yml Outdated
uranusjr
uranusjr reviewed Jul 6, 2026
View reviewed changes
Comment thread.github/workflows/publish-docs-to-s3.yml Outdated
@jason810496
Trim redundant comments and merge the java-sdk unversioned check
c3b1690
Review follow-up: the workflow echo messages already describe the skip
behaviour, the java-sdk None-return folds into the adjacent check, and the
skip-before-version-resolution comment claimed a stale SystemExit reason
instead of the real one (no version resolution and no output-dir deletion
for packages with nothing staged).
phanikumv
phanikumv reviewed Jul 6, 2026
View reviewed changes
Comment threaddev/breeze/tests/test_docs_publisher.py
@jason810496
Cover preserving published docs when a publish run has nothing staged
5cb4ce0
Review follow-up: pin the destructive pre-reorder behaviour where an
override-versioned publish deleted an already-published directory and then
skipped because the build dir was missing.
@potiuk
potiuk merged commit f193bbd into apache:mainJul 7, 2026
148 checks passed
@github-actions

github-actionsBot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Backport failed to create: v3-3-test. View the failure log Run details

Note: As of Merging PRs targeted for Airflow 3.X
the committer who merges the PR is responsible for backporting the PRs that are bug fixes (generally speaking) to the maintenance branches.

In matter of doubt please ask in #release-management Slack channel.

StatusBranchResult
❌v3-3-testCommit Link

You can attempt to backport this manually by running:

cherry_picker f193bbd v3-3-test

This should apply the commit to the v3-3-test branch and leave the commit in conflict state marking
the files that need manual conflict resolution.

After you have resolved the conflicts, you can continue the backport process by running:

cherry_picker --continue

If you don't have cherry-picker installed, see the installation guide.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@uranusjruranusjruranusjr left review comments
@phanikumvphanikumvphanikumv left review comments
@potiukpotiukpotiuk approved these changes
@ashbashbAwaiting requested review from ashbashb is a code owner
@gopidesupavangopidesupavanAwaiting requested review from gopidesupavangopidesupavan is a code owner
@amoghrajeshamoghrajeshAwaiting requested review from amoghrajeshamoghrajesh is a code owner
@jscheffljschefflAwaiting requested review from jscheffljscheffl is a code owner
@bugraoz93bugraoz93Awaiting requested review from bugraoz93bugraoz93 is a code owner
@jedcunninghamjedcunninghamAwaiting requested review from jedcunninghamjedcunningham is a code owner
@ephraimbuddyephraimbuddyAwaiting requested review from ephraimbuddyephraimbuddy is a code owner
@choo121600choo121600Awaiting requested review from choo121600choo121600 is a code owner
@vatsrahul1001vatsrahul1001Awaiting requested review from vatsrahul1001vatsrahul1001 is a code owner

Assignees

@jason810496jason810496

Labels

area:dev-toolsbackport-to-v3-3-testBackport to v3-3-test

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@jason810496@potiuk@uranusjr@phanikumv