dependent-issues 的安装和配置教程

项目基础介绍

dependent-issues 是一个 GitHub Action，用于标记一个 Issue 或 Pull Request 依赖于另一个 Issue 或 Pull Request。这个工具支持跨仓库的依赖关系，使得跨项目协作更加容易。项目主要使用 TypeScript 编程语言。

项目使用的关键技术和框架

• GitHub Actions: 用于自动化您的软件开发工作流程。
• TypeScript: 项目的开发语言，提供了类型系统和编译时类型检查，使得代码更加健壮。
• Node.js: 运行时环境，用于执行 GitHub Action。

准备工作

在开始安装和配置 dependent-issues 前，请确保您已经满足以下条件：

1. 您有一个 GitHub 账户并且已经创建了一个仓库。
2. 您熟悉基本的 Git 操作。
3. 您安装了 Node.js 和 npm（Node.js 包管理器）。

安装步骤

以下是在您的 GitHub 仓库中安装和配置 dependent-issues 的详细步骤：

步骤 1: 创建 GitHub 仓库

首先，确保您已经在 GitHub 上创建了一个新的仓库，并且已经克隆到本地。

git clone https://github.com/your-username/your-repository.git
cd your-repository

步骤 2: 添加 GitHub Action 文件

在您的仓库中创建一个新的 .github/workflows/dependent-issues.yml 文件。

touch .github/workflows/dependent-issues.yml

步骤 3: 配置 GitHub Action

编辑 .github/workflows/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: z0al/dependent-issues@v1
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        GITHUB_READ_TOKEN: ${{ secrets.GITHUB_READ_TOKEN }}
      with:
        label: dependent
        check_issues: off
        ignore_dependabot: off
        keywords: 'depends on, blocked by'
        comment: >
          This PR/issue depends on:
          {{ dependencies }}
          By **[Dependent Issues](https://github.com/z0al/dependent-issues)** (🤖). Happy coding!

根据您的需求，您可以自定义 label、check_issues、ignore_dependabot、keywords 和 comment 字段。

步骤 4: 提交和推送更改

将更改保存到 .github/workflows/dependent-issues.yml 文件中，并提交到您的仓库。

git add .github/workflows/dependent-issues.yml
git commit -m "Add Dependent Issues GitHub Action"
git push origin main

完成以上步骤后，您的 GitHub 仓库就已经配置好了 dependent-issues Action，它将自动在您指定的条件下运行。

请注意，您可能需要根据您的具体需求调整上述步骤中的配置细节。在配置过程中遇到问题，可以查阅项目的 README 文档或 FAQ。