开源项目启动与配置教程

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

开源项目 dependent-issues 的目录结构如下：

dependent-issues/
├── .github/
│   └── workflows/
│       └── dependent-issues.yml
├── .husky/
├── dist/
├── src/
│   ├── index.js
│   └── jest.config.js
├── .editorconfig
├── .eslintignore
├── .eslintrc.json
├── .gitattributes
├── .gitignore
├── .prettierignore
├── FAQ.md
├── LICENSE
├── README.md
├── action.yaml
├── demo.png
├── package.json
├── tsconfig.json
└── yarn.lock

• .github/workflows/: 存放 GitHub Actions 工作流文件，用于自动化处理项目事件。
• .husky/: 存放 husky 配置文件，用于 Git 提交钩子。
• dist/: 通常用于存放编译后的文件。
• src/: 源代码目录，包含 JavaScript 文件和测试配置文件。
• .editorconfig: 用于定义代码编辑器的配置。
• .eslintignore: 用于指定 ESLint 忽略的文件。
• .eslintrc.json: ESLint 的配置文件。
• .gitattributes: 用于设置 Git 仓库的特定行为。
• .gitignore: 用于指定 Git 忽略的文件。
• .prettierignore: 用于指定 Prettier 忽略的文件。
• FAQ.md: 常见问题解答文档。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• action.yaml: GitHub Action 的配置文件。
• demo.png: 项目演示图片。
• package.json: Node.js 项目配置文件。
• tsconfig.json: TypeScript 配置文件。
• yarn.lock: Yarn 锁文件，用于锁定依赖版本。

2. 项目的启动文件介绍

项目的启动文件主要是 GitHub Actions 工作流文件，位于 .github/workflows/dependent-issues.yml。该文件定义了项目在特定事件发生时的自动化行为，例如在新建、编辑或关闭 issues 和 pull requests 时自动添加标签和评论。

以下是一个简化版的 dependent-issues.yml 文件内容：

name: Dependent Issues

on:
  issues:
    types:
      - opened
      - edited
      - closed
      - reopened
  pull_request_target:
    types:
      - opened
      - edited
      - closed
      - reopened

jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: z0al/dependent-issues@v1
        with:
          # 省略配置参数...

此文件定义了一个名为 Dependent Issues 的工作流，它会在 issues 或 pull requests 开启、编辑、关闭或重新开启时触发。它运行在 ubuntu-latest 虚拟环境上，并使用 z0al/dependent-issues@v1 Action。

3. 项目的配置文件介绍

项目的配置文件包括 action.yaml 和 package.json。

• action.yaml 文件定义了 GitHub Action 的输入和配置参数，它告诉 GitHub Action 如何执行任务。

name: 'dependent-issues'
description: 'A GitHub Action for marking issues as dependent on another'
inputs:
  label:
    description: 'The label to use to mark dependent issues'
    default: 'dependent'
  check_issues:
    description: 'Enable checking for dependencies in issues'
    default: 'off'
  # 更多输入配置...

• package.json 文件包含了项目的依赖、脚本和元数据。以下是 package.json 的一部分示例：

{
  "name": "dependent-issues",
  "version": "1.0.0",
  "description": "A GitHub Action for marking issues as dependent on another",
  "main": "index.js",
  "scripts": {
    "test": "jest"
  },
  "dependencies": {
    // 项目的依赖列表
  },
  "devDependencies": {
    // 开发依赖列表
  }
}

这个文件中的 scripts 部分，定义了可以运行的脚本，例如 test 脚本用于执行测试。dependencies 和 devDependencies 部分分别定义了项目的生产依赖和开发依赖。