phpdockerio/github-actions-delete-abandoned-branches

删除废弃分支

GitHub Action，用于自动识别并删除仓库中的废弃分支，帮助维护仓库整洁，减少冗余分支。

警告

此Action 会 从您的仓库中删除分支，因此在选择使用以及配置设置时，您需要自行尽职调查。对于可能发生的任何意外，我不承担责任。

废弃分支定义

一个分支必须满足以下所有条件才会被视为废弃且可安全删除：

• 不是默认分支（例如 master 或 main，取决于您的仓库设置）
• 不是保护分支
• 没有任何开放的拉取请求（PR）
• 不是其他开放PR的基础分支（PR的基础分支是您告诉GitHub要将PR合并到的分支）
• 不在可选的忽略分支列表中
• 分支最后提交时间早于指定的天数

核心功能与特性

• 自动识别符合条件的废弃分支
• 可配置分支忽略列表，灵活排除重要分支
• 支持设置分支最后提交的最小过期天数
• 提供模拟运行（dry run）模式，安全验证配置
• 与GitHub Actions无缝集成，支持定时或手动触发

使用场景

适用于需要定期清理冗余分支的GitHub仓库，特别是：

• 长期维护的项目，积累了大量过时开发分支
• 多人协作项目，需要自动管理分支生命周期
• 追求仓库整洁度，减少无效分支干扰的团队

输入参数

* 为必填项

注意：dry run（模拟运行）

默认情况下，该Action仅执行模拟运行。它会收集所有符合删除条件的分支，并在Action输出中列出，但不会实际删除任何内容。在将dry_run设置为no之前，请确保正确配置所有设置。

使用示例

以下工作流将按计划（每天00:00）运行，并删除所有最后提交时间早于100天的废弃分支：

yaml
name: 删除废弃分支

on:
  # 每天午夜运行
  schedule:
    - cron: "0 0 * * *"

  # 允许从GitHub界面手动运行工作流
  workflow_dispatch:

jobs:
  cleanup_old_branches:
    runs-on: ubuntu-latest
    name: 清理仓库分支
    steps:
      - name: 删除那些烦人的废弃分支
        uses: phpdocker-io/github-actions-delete-abandoned-branches@v1
        id: delete_stuff
        with:
          github_token: ${{ github.token }}
          last_commit_age_days: 100
          ignore_branches: next-version,dont-deleteme

          # 禁用 dry run 并实际删除分支
          dry_run: no

      - name: 获取输出
        run: "echo '已删除分支: ${{ steps.delete_stuff.outputs.deleted_branches }}'"