Skip to content
play

GitHub Action

nbmake

v0.2.1 Latest version

nbmake

play

nbmake

Test notebooks

Installation

Copy and paste the following snippet into your .yml file.

              

- name: nbmake

uses: treebeardtech/[email protected]

Learn more about this action in treebeardtech/nbmake-action

Choose a version

nbmake-action

GitHub Action for testing notebooks (repo renamed from 'treebeard').

Functionality

Tests notebooks using nbmake via pytest.

Quick Start

      - 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