always save execution cache

eurec4a / how_to_eurec4a

Code examples to get you started with EUREC⁴A data.

https://howto.eurec4a.eu

MIT License

6 stars 20 forks source link

always save execution cache #101

Closed d70-t closed 1 year ago

d70-t commented 1 year ago

This PR should setup github actions such that the notebook execution cache will always be saved (even in case of errors). To my understanding, jupyterbook will re-execute failed notebooks on the next build, but could reuse successfully executed notebook cells in that case. This should therefore give use a big improvement in average build time.

d70-t commented 1 year ago

I just ran two builds in a row (first and second time).

The build is failing (due to an issue with the ICON-LES notebook), but the cache has been created successfully :+1:.
The second build could restore the cache :+1:.
The second build re-ran the failing notebook :+1:, but used all the successful ones from cache :+1:.

d70-t commented 1 year ago

I just re-run the build, and as #102 is now fixed, the book was built successfully, and used the cache for execution.

d70-t commented 1 year ago

How does the new save execution cache fit in here now?

The issue here is, the default caching step will only upload the cache if the job was successful. The extra save execution cache step also uploads the cache if the job failed (which I guess is what we need as failing jobs due to a single problematic notebook are frequent).