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

Set allow_errors: False #33

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Set allow_errors: False #33

wants to merge 1 commit into from

Conversation

brian-rose
Copy link
Member

@brian-rose
Copy link
Member Author

This should cause CI failure since these notebooks do not execute due to data access problems.

@github-actions
Copy link

github-actions bot commented Dec 2, 2022

👋 Thanks for opening this PR! The Cookbook will be automatically built with GitHub Actions. To see the status of your deployment, click below.
🔍 Git commit SHA: c9f335e
✅ Deployment Preview URL: https://ProjectPythiaCookbooks.github.io/physical-oceanography-cookbook/_preview/33

@brian-rose
Copy link
Member Author

brian-rose commented Dec 2, 2022

Here I see a new problem. The notebook execution DID fail, e.g. these lines in build log. But CI passed.

The reason is probably because we still have execute_notebooks: cache instead of force.

@brian-rose
Copy link
Member Author

Actually it turns out that jupyter-book build does NOT normally raise exceptions when notebook execution fails, instead raises warnings. So there's a fundamental flaw in our CI testing strategy!

Some info about this here: https://github.com/orgs/executablebooks/discussions/892#discussioncomment-4348868

@brian-rose
Copy link
Member Author

We eventually addressed this problem by putting

sphinx:
  config:
    nb_execution_raise_on_error: true # raise exception in build if there are notebook errors (this flag is ignored if building on binder)

in the _config file.

This repo needs this plus quite a few other updates to bring it up to speed with the latest cookbook template.

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