Newman Action 开源项目教程

Newman Action 开源项目教程

newman-action Use Postman's headless collection runner, Newman, via a GitHub Action. 项目地址: https://gitcode.com/gh_mirrors/newm/newman-action

1. 项目介绍

Newman Action 是一个开源项目，它允许用户通过 GitHub Action 运行 Postman 的无头测试工具 Newman。这个项目的目的是简化在持续集成（CI）流程中自动执行 Postman 集合测试的过程。用户可以通过配置 GitHub Action 工作流，将 Postman 集合和环境的执行集成到代码的拉取请求或定期执行中。

2. 项目快速启动

以下是快速启动 Newman Action 的步骤：

首先，确保你的 GitHub 仓库已经安装了 GitHub Actions。

然后，在你的仓库中创建一个新的 .github/workflows 文件夹（如果还没有的话）。

在 .github/workflows 文件夹中创建一个新的 YAML 文件，例如 newman-run.yml。

编辑该文件，添加以下内容：

name: Newman Run

on:
  pull_request:
    branches:
      - master

jobs:
  newman:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - name: Set up Node.js
      uses: actions/setup-node@latest
      with:
        node-version: '14'
    - uses: actions/checkout@master
    - uses: matt-ball/newman-action@master
      with:
        collection: postman_collection.json
        environment: postman_environment.json

确保你已经将 postman_collection.json 和 postman_environment.json 文件放在了仓库的某个位置，或者使用 URL 指向你的 Postman 集合和环境文件。

保存并推送到 GitHub 仓库，工作流将在下一次 pull request 时自动运行。

3. 应用案例和最佳实践

• 案例：在每次代码提交时自动运行 API 测试。

  • 实践：设置 GitHub Action 工作流触发器为 push 事件，并在工作流中添加 Newman Action。

• 案例：在部署前运行测试以确保 API 的稳定性。

  • 实践：在部署工作流中集成 Newman Action，确保在代码部署前所有测试都通过。

• 案例：使用变量和秘密来保护敏感信息。

  • 实践：在 GitHub 仓库的设置中添加秘密（如 Postman API key），并在 Action 中引用这些秘密。

4. 典型生态项目

Newman Action 可以与以下典型生态项目结合使用：

• GitHub Actions：用于自动化你的软件开发工作流程。
• Postman：用于设计、构建、测试和文档化 API。
• Node.js：Newman Action 在 Node.js 环境下运行，确保兼容性和灵活性。

通过这些典型生态项目的结合，开发者可以创建一个强大的自动化测试和部署管道线。

newman-action Use Postman's headless collection runner, Newman, via a GitHub Action. 项目地址: https://gitcode.com/gh_mirrors/newm/newman-action