Skip to content
package

GitHub Action

Checkout submodules

2.1.1 Latest version

Checkout submodules

package

Checkout submodules

Recursively checks out any submodules in your repository

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Checkout submodules

uses: textbook/git-checkout-submodule-action@2.1.1

Learn more about this action in textbook/git-checkout-submodule-action

Choose a version

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/git-actions@v0.0.3
      with:
        args: git submodule update --init --recursive