Need help with nbmake-action?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

treebeardtech
152 Stars 7 Forks Apache License 2.0 6 Commits 0 Opened issues

Description

GitHub Action for testing notebooks

Services available

!
?

Need anything else?

Contributors list

nbmake-action

(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

Functionality

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

nbmake
pip package directly.

Quick Start

      - uses: actions/[email protected]
      - uses: actions/[email protected]
      - uses: "treebeardtech/[email protected]"
        with:
          path: "./examples"
          path-output: .
          notebooks: |
            nb1.ipynb
            'sub dir/*.ipynb'

See action.yml for the parameters you can pass to this action, and see unit tests and integ tests for example invocations.

Uploading Test Reports

Any static site hosting platform will work, e.g. S3, Firebase, Netlify.

Docs on using netlify

HTML Report Example

HTML Report

Developing

Install local package

npm install

Run checks and build

npm run all

See Also

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.