GitHub Actions自动添加Submodule遇交互问题求解决方案

核心问题分析 #

你遇到的停滞和报错，本质都是Git在非交互式环境下需要认证/用户配置，但无法获取输入导致的：

• 自托管Windows环境停滞：Git尝试弹出交互式窗口索要认证信息，但Actions环境无桌面交互能力，导致进程卡住。
• GitHub托管环境报错：Git需要提交者用户名/邮箱信息，但默认配置缺失，且无法通过交互补充。

可行解决方案 #

1. 提前配置Git用户信息 #

在执行git submodule add前，先设置全局Git用户信息，避免触发交互式请求：

git config --global user.name "GitHub Actions Bot"
git config --global user.email "github-actions[bot]@users.noreply.github.com"

2. 使用带认证的URL跳过交互 #

不要用普通HTTPS/SSH URL，改用带Personal Access Token（PAT）的HTTPS URL，让Git自动完成认证：

• 先在仓库Secrets中添加一个拥有repo权限的PAT（命名为SUBMODULE_PAT）
• 执行submodule添加命令时，使用构造好的认证URL：

git submodule add https://${{ secrets.SUBMODULE_PAT }}@github.com/[OWNER]/[SUBMODULE_REPO].git ./path/to/submodule

如果用SSH方式，需确保自托管Runner的SSH密钥已配置目标仓库访问权限，且提前执行ssh-keyscan github.com >> ~/.ssh/known_hosts避免SSH首次连接的确认弹窗。

3. 强制非交互式模式（针对Windows自托管Runner） #

Windows环境下Git可能默认尝试交互，可通过全局配置或命令参数强制非交互式：

# 全局配置
git config --global core.interactive false

# 或直接在submodule命令中指定参数
git -c core.interactive=false submodule add [URL] [PATH]

4. 完整Actions示例流程 #

jobs:
  add-submodule:
    runs-on: [self-hosted, Windows] # 也可替换为 ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0 # 需拉取完整仓库历史

      - name: Configure Git Environment
        run: |
          git config --global user.name "GitHub Actions Bot"
          git config --global user.email "github-actions[bot]@users.noreply.github.com"
          git config --global core.interactive false # Windows环境建议添加

      - name: Add Target Submodule
        run: git submodule add https://${{ secrets.SUBMODULE_PAT }}@github.com/OWNER/SUBMODULE_REPO.git ./submodules/my-module

      - name: Commit and Push Changes
        run: |
          git add .gitmodules ./submodules/my-module
          git commit -m "Add submodule: my-module"
          git push

注意事项 #

• PAT权限需匹配需求：至少要有目标submodule仓库的读取权限，若需推送则需写入权限。
• 自托管Runner环境：确保Git版本为最新，避免旧版本交互逻辑bug；Windows环境下注意PowerShell/CMD的命令语法差异（示例使用PowerShell）。

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