Newman Action 项目启动与配置教程

1. 项目的目录结构及介绍

Newman Action 项目是一个GitHub Action，它允许用户通过GitHub Action运行Postman的头部集合运行器（headless collection runner）。项目的目录结构如下：

• .github/workflows: 存放GitHub Actions的工作流文件。
• dist: 可能包含编译后的JavaScript文件，但具体内容取决于项目的细节。
• src: 源代码目录，包含项目的JavaScript源文件。
• tests: 测试文件目录，存放项目的单元测试代码。
• .gitignore: 定义哪些文件和目录应该被Git忽略。
• LICENSE.md: Apache-2.0 许可证文件。
• Makefile: 可能包含构建项目所需的Makefile脚本。
• README.md: 项目自述文件，包含项目描述、安装和使用指南。
• action.yml: GitHub Action的配置文件，定义了Action的接口和使用方式。
• index.js: 主JavaScript文件，实现Action的核心逻辑。
• package-lock.json: npm包锁定文件，确保安装的依赖版本一致。
• package.json: npm包配置文件，定义了项目的依赖和脚本。

2. 项目的启动文件介绍

项目的启动主要是通过GitHub Action的工作流文件来实现的。通常，这些文件位于 .github/workflows 目录中。以下是一个简单的启动文件示例：

name: Newman Run

on:
  pull_request:
    branches:
      - master

jobs:
  newman:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - uses: matt-ball/newman-action@master
        with:
          collection: postman_collection.json
          environment: postman_environment.json

这个工作流定义了一个名为 Newman Run 的工作流，它会在提交到 master 分支的pull request上自动触发。它运行在 ubuntu-latest 虚拟环境上，执行以下步骤：

• 使用 actions/checkout@master 步骤检出代码。
• 使用 matt-ball/newman-action@master 步骤运行Newman Action，其中指定了Postman集合和环境的路径。

3. 项目的配置文件介绍

项目的配置主要是通过 action.yml 文件来实现的。这个文件定义了Action的输入参数和选项。下面是一个配置文件的示例：

name: 'Newman Action'
description: 'Use Postman\'s headless collection runner, Newman, via a GitHub Action.'
inputs:
  apiKey:
    description: 'Your Postman API key'
    required: false
    default: ''
  collection:
    description: 'The path or URL to your Postman collection'
    required: true
  environment:
    description: 'The path or URL to your Postman environment'
    required: false
  reporters:
    description: 'The reporters to use for the Newman run'
    required: false
  delayRequest:
    description: 'Delay between requests in milliseconds'
    required: false
  envVar:
    description: 'Environment variables to set for the Newman run'
    required: false

在这个配置文件中，定义了几个输入参数：

• apiKey: Postman API密钥，用于通过Postman API获取集合和环境。
• collection: Postman集合的路径或URL。
• environment: Postman环境的路径或URL。
• reporters: Newman运行时使用的报告器。
• delayRequest: 请求之间的延迟时间（毫秒）。
• envVar: 设置给Newman运行的环境变量。

用户在使用这个Action时可以根据需要提供这些参数的值。