newman-action 的安装和配置教程

项目基础介绍和主要编程语言

newman-action 是一个开源项目，它允许用户通过 GitHub Action 来运行 Postman 的无头集合运行器（Newman）。这样用户就可以在持续集成（CI）过程中自动化地执行 Postman 集合。该项目主要是用 JavaScript 编写的。

项目使用的关键技术和框架

• GitHub Actions：GitHub 提供的自动化您的软件开发工作流程的工具。
• Newman：Postman 的命令行工具，用于执行 Postman 集合。
• Node.js：运行 JavaScript 的环境，本项目使用 Node.js 执行 Newman。

项目安装和配置的准备工作

在开始安装和配置 newman-action 之前，您需要确保以下准备工作已完成：

1. 您有一个 GitHub 帐户并且已经创建了一个仓库。
2. 您熟悉 GitHub Actions 的基本概念。
3. 您已经安装了 Node.js 和 npm。

安装步骤

以下是安装和配置 newman-action 的详细步骤：

1. 创建 GitHub 仓库

   首先，您需要在 GitHub 上创建一个新的仓库，如果您还没有的话。

2. 添加项目依赖

   克隆或下载项目到本地，然后进入项目目录。在项目目录中，运行以下命令来安装依赖：

   npm install
   

3. 创建 GitHub Actions 工作流文件

   在您的 GitHub 仓库中，创建一个名为 .github/workflows/newman.yml 的工作流文件。

   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:
             # 如果您是通过 URL 或 Postman API 指定集合和环境，请取消注释并填写相应的值
             # collection: 'https://example.com/path/to/collection.json'
             # environment: 'https://example.com/path/to/environment.json'
   
             # 如果您是在仓库中直接存储集合和环境文件，请取消注释并填写相应的路径
             collection: 'postman_collection.json'
             environment: 'postman_environment.json'
   

4. 配置 Secrets

   为了安全地使用您的 Postman API 密钥，您需要在 GitHub 仓库的 Settings -> Secrets 中添加一个新的秘密，命名为 POSTMAN_API_KEY，并将您的 Postman API 密钥作为值。

5. 修改工作流文件以使用 Secrets

   修改您的 .github/workflows/newman.yml 文件，以便使用刚才添加的 Secrets。

   - uses: actions/checkout@master
   - uses: matt-ball/newman-action@master
     with:
       apiKey: ${{ secrets.POSTMAN_API_KEY }}
       # 其他配置...
   

6. 推送到 GitHub

   将您的更改推送到 GitHub 仓库，GitHub Actions 将自动执行您定义的工作流。

   git add .
   git commit -m "Add newman-action to the project"
   git push origin master
   

完成以上步骤后，newman-action 应该已经成功集成到您的 GitHub Actions 工作流程中，并且可以在拉取请求发生时自动运行 Postman 集合。