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

only execute notebooks that appear in the TOC #61

Open
brian-rose opened this issue May 15, 2023 · 1 comment
Open

only execute notebooks that appear in the TOC #61

brian-rose opened this issue May 15, 2023 · 1 comment
Labels
hackathon Issue highlighted for active hackathon session infrastructure Infrastructure related issue

Comments

@brian-rose
Copy link
Member

Currently if we are executing notebooks via binderbot, the TOC file is ignored during execution phase and we just run every *.ipynb file.

On the other hand if execution occurs via jupyter-book, then TOC is parsed within jupyter-book and only those notebooks that appear in the TOC are executed.

Ideally the list of executed notebooks would be identical regardless of where the execution takes place. Only notebooks in the TOC should be executed.

One possibility is to add some code to the binderbot-specific sections of the build-book workflow to parse the TOC and generate a list of notebooks to pass to the binderbot call.

Alternatively, it may be possible to leverage jupyter-book for this. Is is possible to get the jupyter-book CLI to just report back the list of notebooks it "would have executed" without actually executing them?

@brian-rose brian-rose added the infrastructure Infrastructure related issue label May 15, 2023
@brian-rose
Copy link
Member Author

This came up in discussion on ProjectPythia/cmip6-cookbook#48. It would be helpful to remove the failing notebook from the TOC until a solution to the secrets issue is found, so that the failure is not holding up other development on the CMIP6 cookbook. But as things stand right now, removing the notebook from the TOC will not prevent it from being executed.

@brian-rose brian-rose added medium priority hackathon Issue highlighted for active hackathon session labels Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hackathon Issue highlighted for active hackathon session infrastructure Infrastructure related issue
Projects
Status: Backlog
Development

No branches or pull requests

2 participants