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

Run notebooks in CI #299

Open
huard opened this issue Jul 6, 2023 · 2 comments
Open

Run notebooks in CI #299

huard opened this issue Jul 6, 2023 · 2 comments

Comments

@huard
Copy link
Contributor

huard commented Jul 6, 2023

The notebooks defined here are not actually run by sphinx, they're just rendered to HTML on ReadTheDocs. Testing actually occurs on Jenkins, which is not directly connected here. I think we could improve on our development cycle by having an action that runs the notebooks here for each PR.

Why this hasn't been done yet is because installing all the dependencies for the notebooks is really long and the resulting environment pretty big. Also, we don't want to test the environment itself, we want to test the notebooks.

One solution could be to write an action built on the same docker image used for the jupyterlab kernels.
https://docs.github.com/en/actions/creating-actions/creating-a-docker-container-action
The action would download the image, create a container, then simply execute pytest --nbval on the notebooks. If no errors are raised, this means the notebooks will run on the prod instance.

@Zeitsperre
Copy link
Contributor

I've already created a new repository based on this idea (and a team for general workflow/DevOps-related work @Ouranosinc/devops). The new repo is at: https://github.com/Ouranosinc/jupyter-pavics-docker-action

It should be really simple to get something up and running. I'd like to see us write an action that can be configured to be useful for testing a few PAVICS-related components, if possible, but let's start with something that gets the job done here.

@Zeitsperre
Copy link
Contributor

Relevant discussion concerning @huard's idea to upload prebuilt docs to ReadTheDocs: readthedocs/readthedocs.org#1083

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants