nbmake-action 使用教程

nbmake-action 使用教程

nbmake-action GitHub Action for testing notebooks 项目地址: https://gitcode.com/gh_mirrors/nb/nbmake-action

1. 项目介绍

nbmake-action 是一个用于测试 Jupyter Notebooks 的 GitHub Action。它通过 pytest 运行 Notebooks，确保每个 Notebook 都能从上到下顺利执行。这个 Action 特别适合科学家和开发者，他们使用 Notebooks 编写文档，并希望在每次提交后通过 CI 测试这些 Notebooks。

2. 项目快速启动

安装与配置

首先，确保你已经有一个 GitHub 仓库，并且已经配置了 GitHub Actions。接下来，在你的 GitHub Actions 工作流文件（通常是 .github/workflows/main.yml）中添加以下内容：

name: Test Notebooks

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
    - uses: actions/setup-python@v2
    - uses: "treebeardtech/nbmake-action@v0.2"
      with:
        path: "examples"
        path-output: "notebooks"

参数说明

• path: 指定要测试的 Notebooks 的路径。
• path-output: 指定输出路径，通常用于存放测试结果。

3. 应用案例和最佳实践

应用案例

假设你有一个包含多个 Jupyter Notebooks 的项目，并且你希望在每次提交代码时自动测试这些 Notebooks。通过使用 nbmake-action，你可以轻松实现这一目标。

最佳实践

1. 路径配置: 确保 path 参数指向你存放 Notebooks 的目录。
2. 输出路径: 使用 path-output 参数指定测试结果的存放路径，便于后续分析。
3. 版本管理: 建议固定 nbmake-action 的版本号，以避免因版本更新导致的兼容性问题。

4. 典型生态项目

nbmake

nbmake 是 nbmake-action 的核心依赖，它是一个用于测试 Jupyter Notebooks 的 Python 工具。通过 nbmake，你可以直接在本地测试 Notebooks，而不依赖于 GitHub Actions。

Jupyter Book

Jupyter Book 是一个用于创建交互式书籍和文档的工具，它支持使用 Jupyter Notebooks 作为内容源。结合 nbmake-action，你可以在每次构建书籍时自动测试所有 Notebooks，确保内容的正确性。

通过以上步骤，你可以轻松地将 nbmake-action 集成到你的项目中，并确保 Notebooks 的质量和可靠性。

nbmake-action GitHub Action for testing notebooks 项目地址: https://gitcode.com/gh_mirrors/nb/nbmake-action