Skip to main content

Submodules in GitHub

This page explains how you can keep using submodules in GitHub while deploying apps with ShamanOps.

Pre-requisites​

  1. Add the following secret as a variable in your CI platform:

Create a token in your CI platform and grant it read permissions on the repositories that you will use as submodules.

shamanops_submodules_token *
The is value refers to the token with read permissions on the repositories that you will use as submodules.

Usage​

1. In the main branch you will edit the YAML file named .github/workflows/github-ci.yaml

2. In the github-ci.yaml file search for the Features section, you will find it like this:


## Features  -------------------------------------------------------------------------------------#

3. Bellow the section title, add the following configuration and change the values as you need: 

    # Submodules in GitHub
      git_submodules_enabled: 'true'

4. In the github-ci.yaml file search for the secrets: section, you will find it like this:

#-------------------------------------------------------------------------------------------------#
    secrets:

5. Bellow the section title, add the following configuration: 

      shamanops_submodules_token: ${{ secrets.shamanops_submodules_token }}

6. Commit and enjoy! ✨