Warn instead of failing on missing 3rd-party doc inventories#63630
Merged
Conversation
potiuk
requested review from
amoghrajesh,
ashb,
bugraoz93,
choo121600,
ephraimbuddy,
gopidesupavan,
jason810496,
jedcunningham,
jscheffl and
kaxil
as code owners
Dev-iL
reviewed
Mar 15, 2026
eladkal
approved these changes
Mar 15, 2026
Dev-iL
approved these changes
Mar 15, 2026
bugraoz93
approved these changes
Mar 15, 2026
bugraoz93
left a comment
bugraoz93
left a comment
Contributor
There was a problem hiding this comment.
Awesome! This was making CI flaky for two days adn possible more in the future
Member
Author
🤞 ... Still some small issues with CI but hopefully the last one will fix it :) |
Third-party Sphinx intersphinx inventories (e.g., Pandas) are sometimes temporarily unavailable. Previously, any download failure terminated the entire doc build. Now missing 3rd-party inventories produce warnings and fall back to cached versions when available. A marker file is written for CI to detect missing inventories and send Slack notifications on canary builds. Publishing workflows fail by default but can opt out. - Add --fail-on-missing-third-party-inventories flag (default: off) - Add --clean-inventory-cache flag (--clean-build no longer deletes cache) - Cache inventories via stash action in CI and publish workflows - Send Slack warning on canary builds when inventories are missing
Document the new --clean-inventory-cache, --fail-on-missing-third-party-inventories, and --ignore-missing-inventories flags in the contributing docs, Breeze developer tasks, and release management docs.
When a third-party inventory file doesn't exist in the cache, skip it from the Sphinx intersphinx_mapping instead of referencing a non-existent file. This prevents Sphinx build errors when third-party inventory downloads fail.
potiuk
force-pushed
the
resilient-doc-inventory-handling
branch
from
f3d6148 to
169c5fd
Compare
Contributor
Backport failed to create: v3-1-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 afda438 v3-1-testThis should apply the commit to the v3-1-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. |
potiuk
added a commit
that referenced
this pull request
Mar 15, 2026
…ies (#63630) * Warn instead of failing on missing 3rd-party doc inventories Third-party Sphinx intersphinx inventories (e.g., Pandas) are sometimes temporarily unavailable. Previously, any download failure terminated the entire doc build. Now missing 3rd-party inventories produce warnings and fall back to cached versions when available. A marker file is written for CI to detect missing inventories and send Slack notifications on canary builds. Publishing workflows fail by default but can opt out. - Add --fail-on-missing-third-party-inventories flag (default: off) - Add --clean-inventory-cache flag (--clean-build no longer deletes cache) - Cache inventories via stash action in CI and publish workflows - Send Slack warning on canary builds when inventories are missing * Add documentation for inventory cache handling options Document the new --clean-inventory-cache, --fail-on-missing-third-party-inventories, and --ignore-missing-inventories flags in the contributing docs, Breeze developer tasks, and release management docs. * Skip missing third-party inventories in intersphinx mapping When a third-party inventory file doesn't exist in the cache, skip it from the Sphinx intersphinx_mapping instead of referencing a non-existent file. This prevents Sphinx build errors when third-party inventory downloads fail. (cherry picked from commit afda438) Co-authored-by: Jarek Potiuk <jarek@potiuk.com>
1 task
potiuk
added a commit
that referenced
this pull request
Mar 15, 2026
…ies (#63630) * Warn instead of failing on missing 3rd-party doc inventories Third-party Sphinx intersphinx inventories (e.g., Pandas) are sometimes temporarily unavailable. Previously, any download failure terminated the entire doc build. Now missing 3rd-party inventories produce warnings and fall back to cached versions when available. A marker file is written for CI to detect missing inventories and send Slack notifications on canary builds. Publishing workflows fail by default but can opt out. - Add --fail-on-missing-third-party-inventories flag (default: off) - Add --clean-inventory-cache flag (--clean-build no longer deletes cache) - Cache inventories via stash action in CI and publish workflows - Send Slack warning on canary builds when inventories are missing * Add documentation for inventory cache handling options Document the new --clean-inventory-cache, --fail-on-missing-third-party-inventories, and --ignore-missing-inventories flags in the contributing docs, Breeze developer tasks, and release management docs. * Skip missing third-party inventories in intersphinx mapping When a third-party inventory file doesn't exist in the cache, skip it from the Sphinx intersphinx_mapping instead of referencing a non-existent file. This prevents Sphinx build errors when third-party inventory downloads fail. (cherry picked from commit afda438) Co-authored-by: Jarek Potiuk <jarek@potiuk.com>
potiuk
added a commit
that referenced
this pull request
Mar 15, 2026
…ies (#63630) (#63646) * Warn instead of failing on missing 3rd-party doc inventories Third-party Sphinx intersphinx inventories (e.g., Pandas) are sometimes temporarily unavailable. Previously, any download failure terminated the entire doc build. Now missing 3rd-party inventories produce warnings and fall back to cached versions when available. A marker file is written for CI to detect missing inventories and send Slack notifications on canary builds. Publishing workflows fail by default but can opt out. - Add --fail-on-missing-third-party-inventories flag (default: off) - Add --clean-inventory-cache flag (--clean-build no longer deletes cache) - Cache inventories via stash action in CI and publish workflows - Send Slack warning on canary builds when inventories are missing * Add documentation for inventory cache handling options Document the new --clean-inventory-cache, --fail-on-missing-third-party-inventories, and --ignore-missing-inventories flags in the contributing docs, Breeze developer tasks, and release management docs. * Skip missing third-party inventories in intersphinx mapping When a third-party inventory file doesn't exist in the cache, skip it from the Sphinx intersphinx_mapping instead of referencing a non-existent file. This prevents Sphinx build errors when third-party inventory downloads fail. (cherry picked from commit afda438)
vincbeck
pushed a commit
that referenced
this pull request
Mar 16, 2026
* Warn instead of failing on missing 3rd-party doc inventories Third-party Sphinx intersphinx inventories (e.g., Pandas) are sometimes temporarily unavailable. Previously, any download failure terminated the entire doc build. Now missing 3rd-party inventories produce warnings and fall back to cached versions when available. A marker file is written for CI to detect missing inventories and send Slack notifications on canary builds. Publishing workflows fail by default but can opt out. - Add --fail-on-missing-third-party-inventories flag (default: off) - Add --clean-inventory-cache flag (--clean-build no longer deletes cache) - Cache inventories via stash action in CI and publish workflows - Send Slack warning on canary builds when inventories are missing * Add documentation for inventory cache handling options Document the new --clean-inventory-cache, --fail-on-missing-third-party-inventories, and --ignore-missing-inventories flags in the contributing docs, Breeze developer tasks, and release management docs. * Skip missing third-party inventories in intersphinx mapping When a third-party inventory file doesn't exist in the cache, skip it from the Sphinx intersphinx_mapping instead of referencing a non-existent file. This prevents Sphinx build errors when third-party inventory downloads fail.
fat-catTW
pushed a commit
to fat-catTW/airflow
that referenced
this pull request
Mar 22, 2026
…63630) * Warn instead of failing on missing 3rd-party doc inventories Third-party Sphinx intersphinx inventories (e.g., Pandas) are sometimes temporarily unavailable. Previously, any download failure terminated the entire doc build. Now missing 3rd-party inventories produce warnings and fall back to cached versions when available. A marker file is written for CI to detect missing inventories and send Slack notifications on canary builds. Publishing workflows fail by default but can opt out. - Add --fail-on-missing-third-party-inventories flag (default: off) - Add --clean-inventory-cache flag (--clean-build no longer deletes cache) - Cache inventories via stash action in CI and publish workflows - Send Slack warning on canary builds when inventories are missing * Add documentation for inventory cache handling options Document the new --clean-inventory-cache, --fail-on-missing-third-party-inventories, and --ignore-missing-inventories flags in the contributing docs, Breeze developer tasks, and release management docs. * Skip missing third-party inventories in intersphinx mapping When a third-party inventory file doesn't exist in the cache, skip it from the Sphinx intersphinx_mapping instead of referencing a non-existent file. This prevents Sphinx build errors when third-party inventory downloads fail.
vatsrahul1001
pushed a commit
that referenced
this pull request
Mar 25, 2026
…ies (#63630) (#63646) * Warn instead of failing on missing 3rd-party doc inventories Third-party Sphinx intersphinx inventories (e.g., Pandas) are sometimes temporarily unavailable. Previously, any download failure terminated the entire doc build. Now missing 3rd-party inventories produce warnings and fall back to cached versions when available. A marker file is written for CI to detect missing inventories and send Slack notifications on canary builds. Publishing workflows fail by default but can opt out. - Add --fail-on-missing-third-party-inventories flag (default: off) - Add --clean-inventory-cache flag (--clean-build no longer deletes cache) - Cache inventories via stash action in CI and publish workflows - Send Slack warning on canary builds when inventories are missing * Add documentation for inventory cache handling options Document the new --clean-inventory-cache, --fail-on-missing-third-party-inventories, and --ignore-missing-inventories flags in the contributing docs, Breeze developer tasks, and release management docs. * Skip missing third-party inventories in intersphinx mapping When a third-party inventory file doesn't exist in the cache, skip it from the Sphinx intersphinx_mapping instead of referencing a non-existent file. This prevents Sphinx build errors when third-party inventory downloads fail. (cherry picked from commit afda438)
abhijeets25012-tech
pushed a commit
to abhijeets25012-tech/airflow
that referenced
this pull request
Apr 9, 2026
…63630) * Warn instead of failing on missing 3rd-party doc inventories Third-party Sphinx intersphinx inventories (e.g., Pandas) are sometimes temporarily unavailable. Previously, any download failure terminated the entire doc build. Now missing 3rd-party inventories produce warnings and fall back to cached versions when available. A marker file is written for CI to detect missing inventories and send Slack notifications on canary builds. Publishing workflows fail by default but can opt out. - Add --fail-on-missing-third-party-inventories flag (default: off) - Add --clean-inventory-cache flag (--clean-build no longer deletes cache) - Cache inventories via stash action in CI and publish workflows - Send Slack warning on canary builds when inventories are missing * Add documentation for inventory cache handling options Document the new --clean-inventory-cache, --fail-on-missing-third-party-inventories, and --ignore-missing-inventories flags in the contributing docs, Breeze developer tasks, and release management docs. * Skip missing third-party inventories in intersphinx mapping When a third-party inventory file doesn't exist in the cache, skip it from the Sphinx intersphinx_mapping instead of referencing a non-existent file. This prevents Sphinx build errors when third-party inventory downloads fail.
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
4 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.
Third-party Sphinx intersphinx inventories (e.g., Pandas) are sometimes
temporarily unavailable. Previously, any download failure terminated the
entire doc build with
SystemExit(1). This is too aggressive — theseinventories are for cross-references to external docs and their temporary
unavailability should not block the build.
Changes:
.missing_third_party_inventoriesmarker file is written for CI detectioninternal-airflow-ci-cdwhen inventories are missingNew flags:
--fail-on-missing-third-party-inventories— opt-in to fail on missing 3rd-party inventories--clean-inventory-cache— separate flag to clean inventory cache (--clean-buildno longer deletes it)--ignore-missing-inventories— workflow dispatch input for publish-docsFiles changed:
fetch_inventories.py— warn-and-continue logic, marker filebuild_docs.py— new CLI flagsdoc_build_params.py— new fields and arg passingdeveloper_commands.py— new CLI flags, updated clean-build behaviorworkflow_commands.py—--ignore-missing-inventoriesoptionci-image-checks.yml— fixed stash key/condition, Slack notificationci-amd-arm.yml— pass SLACK_BOT_TOKEN secretpublish-docs-to-s3.yml— inventory cache stash, fail flag, workflow inputWas generative AI tooling used to co-author this PR?
Generated-by: Claude Code (Claude Opus 4.6) following the guidelines