开源项目 `first-interaction` 使用教程

汤力赛Frederica

于 2024-08-27 09:17:07 发布

阅读量468

点赞数 21

本文链接：https://blog.csdn.net/gitblog_00836/article/details/141590029

版权

开源项目 `first-interaction` 使用教程

first-interactionAn action for filtering pull requests and issues from first-time contributors项目地址:https://gitcode.com/gh_mirrors/fi/first-interaction

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

first-interaction 项目的目录结构相对简单，主要包含以下几个部分：

first-interaction/
├── .github/
│   └── workflows/
│       └── first-interaction.yml
├── README.md
└── package.json

.github/workflows/first-interaction.yml: 这是项目的主要配置文件，定义了 GitHub Actions 的工作流程。
README.md: 项目的说明文档，提供了项目的基本信息和使用指南。
package.json: 包含了项目的依赖信息和其他元数据。

2. 项目的启动文件介绍

项目的启动文件是 .github/workflows/first-interaction.yml。这个文件定义了当有新的 issue 或 pull request 被打开时，GitHub Actions 将执行的操作。

以下是 first-interaction.yml 文件的主要内容：

name: first-interaction
on:
  issues:
    types: [opened]
  pull_request:
    branches: [main]
    types: [opened]
jobs:
  check_for_first_interaction:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/first-interaction@main
        with:
          repo-token: $[[ secrets.GITHUB_TOKEN ]]
          issue-message: |
            Hello! Thank you for filing an issue. If this is a bug report, please include relevant logs to help us debug the problem.
          pr-message: |
            Hello! Thank you for your contribution. If you are fixing a bug, please reference the issue number in the description. If you are implementing a feature request, please check with the maintainers that the feature will be accepted.

name: 工作流程的名称。
on: 定义触发工作流程的事件，包括新打开的 issue 和 pull request。
jobs: 定义要执行的任务。
check_for_first_interaction: 任务的名称。
runs-on: 指定运行任务的虚拟环境。
steps: 定义任务的具体步骤，包括检出代码和执行 first-interaction 操作。

3. 项目的配置文件介绍

项目的配置文件是 .github/workflows/first-interaction.yml。这个文件主要用于配置 GitHub Actions 的工作流程，具体包括以下几个部分：

name: 工作流程的名称。
on: 定义触发工作流程的事件，包括新打开的 issue 和 pull request。
jobs: 定义要执行的任务。
check_for_first_interaction: 任务的名称。
runs-on: 指定运行任务的虚拟环境。
steps: 定义任务的具体步骤，包括检出代码和执行 first-interaction 操作。
with: 定义传递给 first-interaction 操作的参数，包括 repo-token、issue-message 和 pr-message。