GitHub Action：Find Comment 使用教程

GitHub Action：Find Comment 使用教程

find-comment A GitHub action to find an issue or pull request comment 项目地址: https://gitcode.com/gh_mirrors/fi/find-comment

1. 项目目录结构及介绍

Find Comment 是一个GitHub Action，用于在GitHub的问题或拉取请求中查找评论。以下是其目录结构及文件介绍：

.
├── .github
│   └── workflows
│       └── example.yml  # 示例工作流程文件
├── __test__
│   └── ...              # 测试文件和目录
├── dist
│   └── ...              # 构建产物
├── src
│   └── ...              # 源代码文件
├── .eslintignore        # ESLint忽略文件
├── .eslintrc.json       # ESLint配置文件
├── .gitignore           # Git忽略文件
├── .prettierignore      # Prettier忽略文件
├── .prettierrc.json     # Prettier配置文件
├── LICENSE              # 开源许可证文件
├── README.md            # 项目说明文件
├── action.yml           # GitHub Action 的配置文件
├── jest.config.js       # Jest测试配置文件
├── package-lock.json    # 包依赖锁定文件
├── package.json         # 包依赖和项目元数据文件
└── tsconfig.json        # TypeScript配置文件

2. 项目的启动文件介绍

example.yml 文件是Find Comment的示例启动文件，它展示了如何将此GitHub Action集成到你的工作流程中。以下是一个基本的工作流程示例：

name: Find Comment Example

on: [issue_comment]

jobs:
  find-comment:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Find Comment
        uses: peter-evans/find-comment@v3
        with:
          issue-number: ${{ github.event.issue.number }}
          body-includes: '特定搜索字符串'

这个工作流程将在有新评论添加到问题时触发，然后使用Find Comment Action搜索包含特定字符串的评论。

3. 项目的配置文件介绍

action.yml 是GitHub Action的主要配置文件，它定义了Action的输入、输出和其他元数据。以下是一些重要的配置选项：

• name: Action的名称。
• description: Action的简短描述。
• inputs: Action接受的输入参数。
• outputs: Action执行后输出的数据。

例如，以下是如何定义body-includes输入的配置：

inputs:
  body-includes:
    description: '在评论正文中搜索的字符串'
    required: false

这个输入允许用户指定要在评论正文中搜索的字符串。如果未指定，该输入将默认为false。

以上就是Find Comment GitHub Action的目录结构、启动文件和配置文件的简单介绍。使用此Action可以帮助您自动化在GitHub问题或拉取请求中查找特定评论的过程。

find-comment A GitHub action to find an issue or pull request comment 项目地址: https://gitcode.com/gh_mirrors/fi/find-comment