GitHub Action 自动删除分支教程

GitHub Action 自动删除分支教程

branch-cleanup-action A GitHub action to automatically delete the branch after a pull request has been merged. 项目地址: https://gitcode.com/gh_mirrors/br/branch-cleanup-action

1. 项目介绍

branch-cleanup-action 是一个 GitHub Action，用于在 Pull Request 被合并后自动删除相应的分支。这个 Action 可以帮助开发者保持仓库的整洁，避免不必要的分支堆积。

项目地址：https://github.com/jessfraz/branch-cleanup-action

2. 项目快速启动

2.1 创建 GitHub Actions Workflow

在你的 GitHub 仓库中，创建一个新的 .github/workflows/branch-cleanup.yml 文件，并添加以下内容：

name: Branch Cleanup

on:
  pull_request:
    types: [closed]

jobs:
  cleanup:
    runs-on: ubuntu-latest
    steps:
      - name: Delete Branch
        uses: jessfraz/branch-cleanup-action@master
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

2.2 配置环境变量（可选）

如果你希望在分支未被删除时不中断工作流，可以配置 NO_BRANCH_DELETED_EXIT_CODE 环境变量：

jobs:
  cleanup:
    runs-on: ubuntu-latest
    steps:
      - name: Delete Branch
        uses: jessfraz/branch-cleanup-action@master
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        env:
          NO_BRANCH_DELETED_EXIT_CODE: "0"

3. 应用案例和最佳实践

3.1 应用案例

假设你在一个团队项目中使用 GitHub，团队成员经常创建分支来开发新功能或修复 bug。每次合并 Pull Request 后，分支仍然保留在仓库中，导致分支数量迅速增加。使用 branch-cleanup-action 可以自动删除已合并的分支，保持仓库的整洁。

3.2 最佳实践

• 定期清理分支：即使不使用自动清理工具，也应定期手动清理不再需要的分支。
• 保护重要分支：确保默认分支和受保护的分支不会被误删。
• 配置通知：在删除分支时，可以通过 GitHub Actions 的通知功能通知相关人员。

4. 典型生态项目

4.1 GitHub Actions

branch-cleanup-action 是 GitHub Actions 生态系统中的一个典型项目。GitHub Actions 允许开发者自动化 CI/CD 流程，而 branch-cleanup-action 则是其中的一个小工具，专注于分支管理。

4.2 其他相关项目

• actions/checkout：用于签出代码的 GitHub Action。
• actions/setup-node：用于设置 Node.js 环境的 GitHub Action。
• actions/cache：用于缓存依赖项的 GitHub Action。

通过这些工具的组合使用，可以构建一个完整的 CI/CD 流水线，自动化代码的构建、测试和部署流程。

branch-cleanup-action A GitHub action to automatically delete the branch after a pull request has been merged. 项目地址: https://gitcode.com/gh_mirrors/br/branch-cleanup-action