Branch Cleanup Action 使用教程

1、项目介绍

Branch Cleanup Action 是一个由 Jess Frazelle 开发的 GitHub Action，旨在自动化删除已合并的拉取请求分支，以保持 Git 仓库的整洁和有序。该 Action 遵循安全策略，不会删除默认分支或受保护的分支，并且在没有合并的拉取请求关闭时也不会进行任何操作。

2、项目快速启动

配置 GitHub Actions

1. 创建 GitHub Actions 工作流文件：在你的 GitHub 仓库中，创建一个 .github/workflows 目录（如果该目录不存在），然后在该目录下创建一个 YAML 文件，例如 branch-cleanup.yml。

2. 编写工作流配置：在 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 }}
             delete_branch_on_merge: 'true'
   

3. 提交并推送配置文件：将 branch-cleanup.yml 文件提交到你的 GitHub 仓库，并推送到远程仓库。

验证配置

• 创建一个新的拉取请求并合并它，观察分支是否自动删除。
• 如果分支没有自动删除，检查 GitHub Actions 日志以排查问题。

3、应用案例和最佳实践

应用案例

• 协作开发：在一个多人参与的开源项目中，每个人可能会创建多个分支。Branch Cleanup Action 可以确保每次合并后，无关的分支都能得到及时清理。
• 企业内部项目管理：对于有严格代码审查和版本控制的企业来说，此工具可帮助维护者规范代码库，减少混乱，提高效率。
• 个人项目：即使对于单个开发者，该 Action 也能节省手动删除分支的时间，让你更专注于编写和优化代码。

最佳实践

• 定期检查配置：确保 GitHub Actions 配置文件是最新的，并定期检查日志以确保 Action 正常运行。
• 安全策略：确保不会误删默认分支或受保护的分支，特别是在配置文件中明确指定这些分支。

4、典型生态项目

Branch Cleanup Action 可以与其他 GitHub Actions 结合使用，以构建更完整的 CI/CD 流程。以下是一些典型的生态项目：

• CodeQL Action：用于代码安全分析，确保代码库的安全性。
• Super-Linter Action：用于代码风格检查和格式化，确保代码质量。
• Release Drafter Action：用于自动生成发布草稿，简化版本发布流程。

通过结合这些生态项目，可以构建一个高效、安全的开发和部署流程。