GitHub ActionsのWindowsランナーで複数のPrivateサブモジュールを含んだリポジトリをクローンする方法

GitHub ActionsでPrivateサブモジュールを含むリポジトリをクローンしようとすると、通常のチェックアウト方法では認証エラーが発生します。特に、Windowsランナーでは追加の設定が必要になります。

まず、一般的にActionsでリポジトリをチェックアウトする際は以下のようにします：

    jobs:
      build-on-win:
        runs-on: windows-2022
        steps:
          - name: Checkout
            uses: actions/checkout@v4
            with:
              submodules: recursive

しかし、この方法ではPrivateリポジトリはクローンできません。

1. SSH鍵の生成

        ssh-keygen -t ed25519 -C "<リポジトリのssh url>" -f ~/.ssh/temp

2. Deploy Keyの登録

3. Secretsに秘密鍵を登録

以下が、WindowsとmacOS/Linux両方で動作する完全なワークフローです：

    name: Build with Private Submodules

    on:
      push:
        branches: [ main ]
      pull_request:
        branches: [ main ]

    jobs:
      build:
        runs-on: ${{ matrix.os }}
        strategy:
          matrix:
            os: [ubuntu-latest, macos-latest, windows-2022]

        steps:
          # Windowsランナー用のSSH設定（重要!）
          - name: Set GIT_SSH_COMMAND on Windows
            if: runner.os == 'Windows'
            shell: bash
            run: |
              echo "GIT_SSH_COMMAND=ssh -F /c/Users/runneradmin/.ssh/config -o \"UserKnownHostsFile /c/Users/runneradmin/.ssh/known_hosts\"" >> "${GITHUB_ENV:?}"

          # SSH認証の設定（バージョン固定が重要!）
          - name: Setup SSH for private submodules
            uses: webfactory/ssh-agent@v0.7.0
            with:
              ssh-private-key: |
                ${{ secrets.DEPLOY_KEY_YOUR_REPOSITORY_NAME_1 }}
                ${{ secrets.DEPLOY_KEY_YOUR_REPOSITORY_NAME_2 }}
                ${{ secrets.DEPLOY_KEY_YOUR_REPOSITORY_NAME_3 }}

          # リポジトリとサブモジュールのチェックアウト
          - name: Checkout repository with submodules
            uses: actions/checkout@v4
            with:
              submodules: recursive

          # 以降、ビルド処理など...
          - name: Build project
            run: |
              # ビルドコマンド

詳細解説

            Error: Command failed: git submodule update --init --recursive
            Cloning into 'path/to/submodule'...
            git@github.com: Permission denied (publickey).
            fatal: Could not read from remote repository.

                - name: Set GIT_SSH_COMMAND on Windows
                    if: runner.os == 'Windows'
                    shell: bash
                    run: |
                        echo "GIT_SSH_COMMAND=ssh -F /c/Users/MY_USERNAME/.ssh/config -o \"UserKnownHostsFile /c/Users/MY_USERNAME/.ssh/known_hosts\"" >> "${GITHUB_ENV:?}"

                echo "GIT_SSH_COMMAND=ssh -F /c/Users/runneradmin/.ssh/config -o \"UserKnownHostsFile /c/Users/runneradmin/.ssh/known_hosts\"" >> "${GITHUB_ENV:?}"

WindowsランナーでPrivateサブモジュールを含むリポジトリをクローンする際のポイントは以下の通りです。

1. webfactory/ssh-agent@v0.7.0 を使用する
2. Windows環境では事前にGIT_SSH_COMMANDを設定する
3. 複数のDeploy keyを適切に設定する

これらのポイントを押さえることで、Windowsランナーでも安全にPrivateサブモジュールにアクセスできます。