cirrusactions/rebase

GitHub Action自动Rebase PR工具

![Build Status]([] ![]([] ![]([***]

安装后，只需在PR评论中输入 /rebase 即可触发操作：

!rebase-action

镜像概述

本镜像提供的GitHub Action可自动对拉取请求（PR）执行rebase操作，帮助开发者快速同步PR分支与主分支代码，减少手动操作的繁琐，提升团队协作效率。

核心功能

1. 自动Rebase：通过评论 /rebase 触发PR的rebase操作；
2. 灵活配置：支持指定PR编号（当工作流未直接关联特定PR时）；
3. 权限控制：可通过 author_association 限制能触发操作的用户（如仅团队成员）；
4. 工作流联动：配合个人访问令牌（PAT）确保rebase后工作流自动重新运行。

使用场景

• 团队协作的代码仓库中，需要频繁更新PR以保持与主分支同步；
• 减少手动rebase的时间成本，避免因代码冲突导致的合并延迟；
• 自动化CI/CD流程中，确保PR始终基于最新主分支代码运行测试。

配置说明

基础配置

在仓库的 .github/workflows 目录下创建 rebase.yml 文件，添加以下内容：

yaml
name: 自动Rebase
on:
  issue_comment:
    types: [created]
jobs:
  rebase:
    name: Rebase操作
    if: github.event.issue.pull_request != '' && contains(github.event.comment.body, '/rebase')
    runs-on: ubuntu-latest
    steps:
      - name: 检出最新代码
        uses: actions/checkout@v2
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          fetch-depth: 0 # 否则无法推送引用到目标仓库
      - name: 自动Rebase
        uses: cirrus-actions/rebase@1.4
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

进阶配置（使用PAT确保工作流重新运行）

若需在rebase后自动重新运行工作流，需使用个人访问令牌（PAT）替代默认的 GITHUB_TOKEN：

yaml
...
    - name: 检出最新代码
      uses: actions/checkout@v2
      with:
        token: ${{ secrets.PAT_TOKEN }} # 替换为你的PAT
        fetch-depth: 0
    - name: 自动Rebase
      uses: cirrus-actions/rebase@1.4
      env:
        GITHUB_TOKEN: ${{ secrets.PAT_TOKEN }}

指定PR编号

当工作流未直接关联特定PR时，可手动指定PR编号：

yaml
    - name: 自动Rebase
      uses: cirrus-actions/rebase@1.4
      env:
        GITHUB_TOKEN: ${{ secrets.PAT_TOKEN }}
        PR_NUMBER: 1245 # 替换为目标PR编号

限制操作权限

通过 author_association 限制仅特定用户可触发操作（如团队成员）：

yaml
jobs:
  rebase:
    name: Rebase操作
    if: github.event.issue.pull_request != '' && contains(github.event.comment.body, '/rebase') && github.event.comment.author_association == 'MEMBER'
    ...

（author_association 的可选值参考：https://developer.github.com/v4/enum/commentauthorassociation/%EF%BC%89

自动驳回 stale 审批

若需在rebase后自动驳回旧的PR审批（需重新审核），可在仓库设置中开启：
Settings > Branches > Branch protection rules > Require pull request reviews before merging > Dismiss stale pull request approvals when new commits are pushed。