Add notebook diff workflow for PR comments #277
Merged
Conversation
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
- Automatically detects changed .ipynb files in PRs - Generates nbdime diffs for each changed notebook - Posts formatted comment with collapsible diff sections - Handles multiple notebooks and new files gracefully 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Using uvx --from nbdime nbdiff creates an ephemeral environment and avoids issues with system Python being externally managed. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Adds flags to focus diff on actual content: - --ignore-attachments: Skip attachment changes - --ignore-metadata: Skip metadata changes - --ignore-identifiers: Skip cell ID changes - --ignore-details: Skip execution counts, etc. This makes the diff more readable and focused on code/markdown changes. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Use short flags (-A -M -I -D) instead of long form flags that don't exist. - -A: ignore attachments - -M: ignore metadata - -I: ignore identifiers (cell IDs) - -D: ignore details (execution counts, etc.) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
zealoushacker
approved these changes
Nov 11, 2025
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.
Summary
Adds a GitHub Action workflow that automatically posts notebook diffs as PR comments when .ipynb files are modified. The diff excludes metadata, attachments, and other extraneous code while preserving the content and output changes in the notebook.
You can see an example of this in this test PR: #279 (comment)
What it does
Test plan
This workflow will help reviewers quickly see what changed in notebooks without having to check out the branch locally.
🤖 Generated with Claude Code
PROOF IT WORKS
BEFORE (Github native diff)
AFTER (Diff left as a comment on a PR)