Catch deprecated API warnings from tutorial builds#3810
Draft
Catch deprecated API warnings from tutorial builds#3810
Conversation
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/tutorials/3810
Note: Links to docs will display an error until the docs builds have been completed. ⏳ No Failures, 19 PendingAs of commit 92d49b3 with merge base f79c3d9 ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
f5997b5 to
9c7d7db
Compare
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
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.
When tutorials use deprecated PyTorch APIs, Python fires
DeprecationWarningandFutureWarningat runtime — but these warnings are currently silently ignored during the Sphinx Gallery build. We do not notice them until a user tries to run a tutorial and hits a broken API.This PR attempts two capture those during the CI build, parses them, and automatically creates/updates a GitHub Issue listing the deprecated API usage by tutorial file.
Changes
tools/deprecation_checker/(new) — parses build log forDeprecationWarning/FutureWarning, generates Markdown report, optionally creates/updates a GitHub Issue.jenkins/build.sh— add a function to capture make docs output to _build/build.log via tee, generates report per worker, merges logs and files issue in manager. Guarded with || true..github/workflows/_build-tutorials-base.yml— added an entry to upload report as build artifactHow it works
Test Plan