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

Foundations health checks fail to identify failing code #345

Closed
brian-rose opened this issue Nov 23, 2022 · 2 comments · Fixed by #348
Closed

Foundations health checks fail to identify failing code #345

brian-rose opened this issue Nov 23, 2022 · 2 comments · Fixed by #348
Labels
infrastructure Infrastructure related issue

Comments

@brian-rose
Copy link
Member

We recently discovered an example of code in a Foundations notebook that is failing (#343). We discovered this by accident while perusing the published pages. It's not clear how long that code has been failing.

This is basically a bug in our nightly health checks. We currently use allow_errors: True in the Foundations config file, so any run-time errors are silent and do not show up as CI failures.

The reason for using allow_errors: True is because we have cells in notebooks that are supposed to fail for demonstration purposes.

But we need a better way of identify unexpected failures.

We discussed the same question for Cookbooks here: ProjectPythia/cookbook-template#53.
The consensus there was to use allow_errors: False but set raises-exception flags on cells that are expected to fail.

It's unclear if anyone has tested this and if it will play well with JupyterBook.

I think we should investigate this option for Foundations.

@brian-rose brian-rose added the infrastructure Infrastructure related issue label Nov 23, 2022
@brian-rose
Copy link
Member Author

Scanning through all pages in Foundations, here are places where I found that we have an expected failure for a cell:

I will open a PR that sets the raises-exception flag for all those cells, and sets allow_errors: False for the Foundations jupyterbook build.

@brian-rose
Copy link
Member Author

Actually it appears that all those cells in the notebooks I identified above already have the raises-exception tag.

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

Successfully merging a pull request may close this issue.

1 participant