Skip to content

Use nbstripout with pre-commit to ensure notebook outputs are cleared #518

Closed
@jonathansick

Description

@jonathansick

Our goal is to keep this astropy-tutorials repo easy to clone, so that means we'd like to ensure that all notebooks committed to main don't include their outputs. pre-commit with an nbstripout hook is a great way to do this. We can have instructions on how to set up pre-commit as a contributor, and also run pre-commit as part of CI.

We'd want to have a policy of squashing all PRs so that intermediate commits that might have outputs arn't included on the main branch.

We want this to be as easy as possible for a contributor to use. Definitely we should document setting up pre-commit, and also document a command to run if a PR does have notebook outputs present. Another option is to look at https://pre-commit.ci, which automatically pushes fixes to a PR. This is free for open source repos.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions