首页
/ GitHub Action:依赖问题标记最佳实践

GitHub Action:依赖问题标记最佳实践

2025-05-17 21:42:08作者:申梦珏Efrain

1. 项目介绍

dependent-issues 是一个GitHub Action,用于标记依赖于其他问题或拉取请求的问题。它可以处理仓库内或跨仓库的问题依赖关系,支持在问题或拉取请求被打开、编辑、关闭或重新打开时自动执行。

2. 项目快速启动

首先,在你的GitHub仓库中创建一个新的工作流文件。通常这个文件位于 .github/workflows/dependent-issues.yml

name: Dependent Issues

on:
  issues:
    types:
      - opened
      - edited
      - closed
      - reopened
  pull_request_target:
    types:
      - opened
      - edited
      - closed
      - reopened
  schedule:
    - cron: '0 0 * * *'

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: on
          ignore_dependabot: on
          keywords: 'depends on, blocked by'
          comment: |
            这个PR/问题依赖于:
            {{ dependencies }}
            由 [Dependent Issues](https://github.com/z0al/dependent-issues) 自动标记。祝你编码愉快!

确保你已经设置了 GITHUB_TOKENGITHUB_READ_TOKEN 在你的GitHub仓库的Secrets中。

3. 应用案例和最佳实践

应用案例

  • 当一个拉取请求依赖于另一个仓库的问题时,你可以使用此Action来自动标记相关的问题。
  • 在你的项目中,如果有多个问题依赖于一个主要问题的解决,你可以使用此Action来跟踪这些依赖关系。

最佳实践

  • 保持关键字(例如 depends onblocked by)的一致性,以便Action可以正确解析依赖关系。
  • 使用自定义标签(如 dependent)来标记依赖问题,以便于筛选和管理。
  • 通过自定义注释模板,你可以添加额外的信息或链接,以帮助团队成员理解依赖背景。

4. 典型生态项目

dependent-issues Action 可以与许多其他GitHub Action一起使用,以创建一个自动化的工作流生态系统。例如:

  • 结合 github-actions/github-action/issues 来创建问题。
  • 使用 peter-evans/auto-assign Action 自动分配问题给相关的人员。
  • actions/github-action-labeler 一起使用,根据特定的规则自动标记问题。

通过这些Action的组合使用,你可以构建一个高效、自动化的开源项目管理工作流。

登录后查看全文
热门项目推荐