Skip to content

Checkout submodules

Actions
Recursively checks out any submodules in your repository
2.1.1
Latest
Star (55)

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

Checkout submodules is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Recursively checks out any submodules in your repository
2.1.1
Latest

Checkout submodules is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.