[go: up one dir, main page]

Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test notebooks run as part of CI checks #18

Open
nathancooperjones opened this issue May 13, 2021 · 1 comment
Open

Test notebooks run as part of CI checks #18

nathancooperjones opened this issue May 13, 2021 · 1 comment
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@nathancooperjones
Copy link
Collaborator

Is your feature request related to a problem? Please describe.

Not a problem, rather something that would be nice to eventually have.

Currently we have tutorial notebooks and a quickstart notebook in the tutorials directory that we do not test as we make changes to the library.

Describe the solution you'd like

Ideally, we would have a part of the CI checks for each PR that runs all Jupyter notebooks and only allows merging if the notebooks run without error.

Describe alternatives you've considered

Worst case scenario, we can just add something to the PR checklist ensuring that notebooks still run, but that's not as nice I think.

Any additional information?

I think this might be possible by having the test first export the notebook as a python file programmatically, then have the test run the Python file in its entirety. We don't really care about output, just that we finish without error.

@nathancooperjones nathancooperjones added enhancement New feature or request help wanted Extra attention is needed labels May 13, 2021
@nathancooperjones
Copy link
Collaborator Author

Looks like a tool to enable this has been created: nbmake 🎉

https://github.com/treebeardtech/nbmake

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant