GitHub Action for testing notebooks
(repo renamed from 'treebeard').
What? A GitHub Action for testing notebooks, runs them from top-to-bottom
Why? To raise the quality of scientific material through better automation
Who is this for? Scientists/Developers who have written docs in notebooks and want to CI test them after every commit
Tests notebooks using nbmake via pytest.
Note: If you have some experience setting up GitHub actions already you will probably prefer the flexibility of using the
nbmakepip package directly.
- uses: actions/[email protected] - uses: actions/[email protected] - uses: "treebeardtech/[email protected]" with: path: "./examples" path-output: . notebooks: | nb1.ipynb 'sub dir/*.ipynb'
Any static site hosting platform will work, e.g. S3, Firebase, Netlify.
npm run all