Skip to content

Add CI to enforce clean notebook outputs and metadata#43

Closed
Nancy-Chauhan wants to merge 1 commit intomainfrom
add-ci-infrastructure
Closed

Add CI to enforce clean notebook outputs and metadata#43
Nancy-Chauhan wants to merge 1 commit intomainfrom
add-ci-infrastructure

Conversation

@Nancy-Chauhan
Copy link
Copy Markdown

@Nancy-Chauhan Nancy-Chauhan commented Mar 17, 2026

Summary

  • Adds a GitHub Actions workflow that runs jupyter nbconvert to strip notebook outputs and metadata, and fails the check if any notebooks are dirty
  • Adds a cleaning script (scripts/clean_tutorials_metadata_outputs.sh) for contributors to run locally
  • Adds .gitignore for common Python/Node artifacts
  • Posts a sticky PR comment with instructions when the check fails

Test plan

  • Verified the cleaning script runs locally and correctly detects dirty notebooks
  • Confirmed the workflow triggers on PRs touching python/, typescript/, or the workflow file itself

@github-actions
Copy link
Copy Markdown

Hey there!

We require our python tutorials to be stripped of outputs and metadata.

It seems your tutorials are not conforming to this standard. Please run:

./scripts/clean_tutorials_metadata_outputs.sh

from the root of the repo.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant