git-checkout-submodule-action icon indicating copy to clipboard operation
git-checkout-submodule-action copied to clipboard

GitHub Action for checking out submodules

Note I am no longer maintaining this repository, please use one of the alternatives below

Checkout Submodule Action

Recursively checks out any submodules in your repository.

steps:
- name: Checkout repository
  uses: actions/checkout@master
- name: Checkout submodules
  uses: textbook/git-checkout-submodule-action@master

New in version 2.1.0. You can optionally set the --remote flag:

steps:
- name: Checkout repository
  uses: actions/checkout@v2
- name: Checkout submodules
  uses: textbook/git-checkout-submodule-action@master
  with:
    remote: true

Alternatives

  • You can use the submodules input to the checkout action:

    steps:
    - name: Checkout repository and submodules
      uses: actions/checkout@v2
      with:
        submodules: recursive
    
  • just run the command directly:

    steps:
    - name: Checkout repository
      uses: actions/checkout@v2
    - name: Checkout submodules
      run: git submodule update --init --recursive
    
  • or use git Actions instead:

    steps:
    - name: Checkout repository
      uses: actions/checkout@v2
    - name: Checkout submodules
      uses: srt32/[email protected]
      with:
        args: git submodule update --init --recursive