PR-Stats 项目使用教程

PR-Stats 项目使用教程

pr-stats PR에 대한 유용한 통계를 산출하는 GitHub Actions 项目地址: https://gitcode.com/gh_mirrors/pr/pr-stats

1. 项目目录结构及介绍

PR-Stats 是一个用于生成 PR 统计数据的 GitHub Actions。项目目录结构如下：

pr-stats/
├── dist/
│   └── ... (编译后的文件)
├── src/
│   └── ... (源代码文件)
├── .eslintrc
├── .gitignore
├── .prettierignore
├── .prettierrc
├── LICENSE
├── NOTICE
├── README.en.md
├── README.md
├── action.yml
├── package-lock.json
├── package.json
└── tsconfig.json

• dist/: 存放编译后的文件。
• src/: 源代码目录，包含项目的主要逻辑。
• .eslintrc: ESLint 配置文件，用于定义代码风格规则。
• .gitignore: Git 忽略文件列表，用于指定不需要提交到版本控制系统的文件。
• .prettierignore: Prettier 忽略文件列表，用于指定不需要格式化的文件。
• .prettierrc: Prettier 配置文件，用于定义代码格式化规则。
• LICENSE: 项目许可证文件，本项目采用 Apache-2.0 许可。
• NOTICE: 通知文件，包含项目的一些法律声明。
• README.en.md: 英文项目说明文件。
• README.md: 项目说明文件。
• action.yml: GitHub Action 配置文件，定义了 Action 的行为。
• package-lock.json: npm 依赖锁定文件，确保在不同环境中安装相同的依赖版本。
• package.json: npm 包配置文件，定义了项目的依赖和脚本。
• tsconfig.json: TypeScript 配置文件，用于定义 TypeScript 编译选项。

2. 项目的启动文件介绍

项目的启动主要通过 GitHub Actions 进行。在 .github/workflows/pr-stats.yml 文件中定义了 Action 的触发事件和执行步骤。

name: PR Stats

on:
  workflow_dispatch:

jobs:
  pr-stats:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
      - name: PR Stats
        uses: naver/pr-stats@v1.0.0
        with:
          token: ${{ secrets.GITHUB_TOKEN }}

• name: 工作流的名称。
• on: 定义触发工作流的事件，这里使用 workflow_dispatch，允许手动触发工作流。
• jobs: 定义要执行的工作，这里有一个名为 pr-stats 的工作。
• runs-on: 指定运行工作的虚拟机环境，这里使用 ubuntu-latest。
• steps: 定义工作中的步骤，包括检出代码库、执行 PR Stats Action。

3. 项目的配置文件介绍

项目的配置主要通过 stats.config.js 文件进行。该文件用于定义输出统计数据的字段。

以下是一个示例配置文件：

module.exports = {
  pr: [
    "number",
    "title",
    "fileCount"
  ],
  prList: [
  ],
  user: [
    "id"
  ],
};

在这个配置中，我们定义了在 PR 统计中要包含的字段为 number、title 和 fileCount。prList 和 user 的统计字段被留空，表示不输出这些统计信息。

可以根据需要自定义这些字段，以输出不同的统计数据。

pr-stats PR에 대한 유용한 통계를 산출하는 GitHub Actions 项目地址: https://gitcode.com/gh_mirrors/pr/pr-stats