chinthakagodawita/autoupdate-action

autoupdate-action 镜像文档

概述

autoupdate-action 是一个 GitHub Action，核心功能是自动将拉取请求（Pull Request）的基础分支（base branch）更改同步到该拉取请求的分支，减少手动合并基础分支到PR分支的操作，确保PR分支始终与基础分支保持同步。

核心功能

• 自动同步更新：自动检测基础分支的变更并合并到PR分支
• 减少手动操作：无需开发者手动执行分支合并命令
• 降低冲突风险：及时同步基础分支更改，减少后期合并冲突可能性

使用场景

• 多人协作开发的 GitHub 项目
• 需要频繁保持 PR 分支与基础分支同步的场景
• 希望自动化 PR 维护流程、提高开发效率的团队

使用方法

详细使用说明请参考 https://github.com/chinthakagodawita/autoupdate-action%EF%BC%8C%E5%8C%85%E6%8B%AC%E5%B7%A5%E4%BD%9C%E6%B5%81%E9%85%8D%E7%BD%AE%E7%A4%BA%E4%BE%8B%E3%80%81%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E%E5%8F%8A%E9%AB%98%E7%BA%A7%E7%94%A8%E6%B3%95%E3%80%82

基本工作流配置示例

在 .github/workflows/ 目录下创建工作流文件（如 autoupdate.yml），示例配置如下：

yaml
name: Auto Update PR

on:
  push:
    branches: [ main ]  # 基础分支，当该分支有推送时触发
  pull_request_target:
    types: [ opened, synchronize ]  # PR创建或同步时触发

jobs:
  autoupdate:
    runs-on: ubuntu-latest
    steps:
      - uses: chinthakagodawita/autoupdate-action@v1
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}
          # 可选参数，如合并策略、目标分支过滤等

主要参数说明

• repo-token：必填，GitHub 访问令牌，通常使用 ${{ secrets.GITHUB_TOKEN }}
• 其他可选参数（如合并策略、分支过滤等）可参考 GitHub 仓库文档进行配置