PR Compliance Action 项目启动与配置教程

1. 项目目录结构及介绍

PR Compliance Action 是一个GitHub Action，用于检查拉取请求（PR）的合规性，如标题格式、是否引用了问题、是否来自保护分支以及是否修改了指定的文件。

项目的主要目录结构如下：

• .github/：存放GitHub工作流文件和相关的配置文件。
• src/：包含项目的TypeScript源代码。
• dist/：编译后的JavaScript文件存放目录。
• __tests__/：单元测试文件存放目录。
• .eslintrc.json：ESLint配置文件。
• .gitattributes：Git属性配置文件。
• .gitignore：Git忽略文件配置。
• .prettierrc.json：Prettier配置文件。
• CODEOWNERS：代码所有者配置文件。
• CODE_OF_CONDUCT.md：项目行为准则文件。
• CONTRIBUTING.md：贡献指南文件。
• LICENSE：项目许可证文件。
• README.md：项目自述文件。
• action.yml：GitHub Action配置文件。
• jest.config.js：Jest测试配置文件。
• package.json：Node.js项目配置文件。
• package-lock.json：Node.js项目依赖锁定文件。
• tsconfig.json：TypeScript项目配置文件。

2. 项目的启动文件介绍

项目的启动主要是通过GitHub工作流文件来触发的。工作流文件通常位于项目根目录下的 .github/workflows/ 目录中。

以下是一个示例工作流文件的内容，该文件定义了如何触发 PR Compliance Action：

name: PR Compliance

on:
  pull_request_target:
    types: [opened, edited, reopened]

permissions:
  pull-requests: write

jobs:
  pr-compliance:
    runs-on: ubuntu-latest
    steps:
      - uses: mtfoley/pr-compliance-action@main

这个工作流文件会在拉取请求打开、编辑或重新打开时触发 PR Compliance Action。

3. 项目的配置文件介绍

PR Compliance Action 的配置主要通过 action.yml 文件进行。以下是 action.yml 文件中的一些主要配置项：

• repo-token：GitHub令牌，用于验证操作。
• ignore-authors：忽略特定作者的检查。
• base-comment：基础评论内容。
• ignore-team-members：是否忽略团队成员的检查。
• body-regex：用于检测PR正文的正则表达式。
• body-fail：正文正则表达式不匹配时是否触发失败检查。
• body-auto-close：正文检查失败时是否自动关闭PR。
• body-comment：正文检查失败时留在PR上的评论。
• issue-labels：所有关联问题必须包含的标签列表。
• protected-branch：需要确保PR不使用作为其头的保护分支。
• title-check-enable：是否启用PR标题的格式检查。

以上配置项可以根据项目的具体需求进行调整，以确保PR符合项目规范。