如何在新建GIT分支时自动添加文件？

最直接的实现方式是用GitHub Actions，这是GitHub原生的自动化工具，无需额外依赖。具体步骤如下：

1. 创建Workflow配置文件 #

在你的仓库根目录下创建路径 .github/workflows/auto-add-files-on-branch.yml，这个文件用来定义自动化任务的触发条件和执行逻辑。

2. 编写Workflow内容 #

将以下代码粘贴到上述文件中，可根据你的需求调整文件列表和内容：

name: Auto Add Files on Branch Creation

# 触发条件：仅当新建分支时触发
on:
  create:
    types: [branch] # 排除标签创建事件，只响应分支创建

jobs:
  add-required-files:
    runs-on: ubuntu-latest
    steps:
      # 检出新建分支的代码
      - name: Checkout code
        uses: actions/checkout@v4
        with:
          fetch-depth: 1 # 仅拉取最新代码，提升执行速度

      # 配置Git提交身份（必须，否则无法完成提交）
      - name: Configure Git user
        run: |
          git config --global user.name "github-actions[bot]"
          git config --global user.email "github-actions[bot]@users.noreply.github.com"

      # 创建/复制需要添加的文件
      - name: Create required files
        run: |
          # 示例1：创建空文件
          touch README.local.md .env.example
          # 示例2：给文件写入初始内容
          echo "# Local Environment Guide" > README.local.md
          echo "API_KEY=your_api_key_here" > .env.example
          # 示例3：从仓库模板目录复制文件
          # cp .github/templates/* ./

      # 提交并推送到新建分支
      - name: Commit and push files
        run: |
          git add .
          git commit -m "Auto add required files on branch creation"
          git push origin ${{ github.ref_name }}

3. 关键细节说明 #

• 触发逻辑：on: create 会响应所有创建事件，加上 types: [branch] 确保只在新建分支时触发任务，避免标签创建时误执行。
• Git身份：必须配置用户信息，否则GitHub Actions的机器人无法完成代码提交操作。
• 文件自定义：你可以完全替换 Create required files 步骤的命令，适配自己需要添加的文件类型和内容。
• 权限问题：默认的 GITHUB_TOKEN 已拥有仓库的读写权限，无需额外配置；若仓库有特殊权限设置，需确保Workflow具备推送权限。

4. 测试验证 #

将Workflow文件提交到主分支后，新建一个测试分支，即可在仓库的「Actions」标签页查看任务执行状态，完成后检查新建分支是否已自动添加指定文件。

内容的提问来源于stack exchange，提问作者Ab1gor