git submodules

 git submodules allows to link one or more related git projects, which allows to build and execute commands in the dependent projects in a seamless way both on development machines and CI servers.

This post explains about some basic commands required with git repositories containing git submodules.

Add a new submodule:

git submodule add <git_repo_url> <submodule_path>

git add .

git commit -m "Added Submodule"

git push

Remove an existing submodule:

git submodule deinit <submodule_path>

git rm <submodule_path>

rm -rf .git/modules/<submodule_path>

git add .

git commit -m "Removed Submodule"

git push

Pull changes to submodules in already cloned repository:

git pull --recurse-submodules

git submodule update --init --recursive

Pull changes to submodules in parallel:

The -j parameters specifies the maximum number of parallel jobs to pull the submodules. In the below example -j8 means, up to 8 submodules will be pulled in parallel. The will speed up the pull operation as the submodules will be updated parallely.

git pull --recurse-submodules -j8

git submodule update --init --recursive -j8

Clone a repo with submodules:

git clone --recurse-submodules <git_url>

Clone a repo with submodules in parallel:

The -j parameters specifies the maximum number of parallel jobs to pull the submodules. In the below example -j8 means, up to 8 submodules will be pulled in parallel. This will speed up the cloning time of the parent repo.

git clone --recurse-submodules -j8 <git_url>

Clone a repo with submodules in CI:

The --shallow-submodules makes the clone command to pull the submodules only with the configured commit id and avoids cloning the submodules with entire history. This is a very handy option in CI servers to speed up the clone time and ultimately reduced the CI build time.

git clone --recurse-submodules --depth 1 --shallow-submodules -j8 <git_url>

Update the commit to latest of the submodule from remote server:

All submodules

git submodule update --init --remote

git add .

git commit -m 'Updating all submodules'

git push

Specific submodule

git submodule update --init --remote <submodule_path>

git add .

git commit -m 'Updating submodule'

git push

Update remote branch of the submodule:

Set to a specific branch

git submodule set-branch --branch <branch_name> <submodule_path>

git add .

git commit -m 'Updating branch'

git push

Set to a default branch (HEAD)

git submodule set-branch --default <submodule_path>

git add .

git commit -m 'Updating to default branch and HEAD'

git push

Update the remote url of the submodule:

git submodule set-url <submodule_path> <new_url>

git add .

git commit -m 'Updating remote url'

git push

Print status of the submodule:

All submodules

git submodule status --recursive

Specific submodule

git submodule status --recursive <submodule_path>

Comments

Post a Comment

Popular posts from this blog

JSON with curl and jq

This blog post captures some quick commands to deal with JSON from servers (Http APIs) using curl and jq command line tools About Jq: https://stedolan.github.io/jq/ Install jq: Mac: brew install jq Ubuntu or Debian: sudo apt-get install jq Sample JSON content: Assume the following JSON content will be returned from  URL http://api.example.com/some-json-content {     "user_name": "User 123",     "some_other_field": {         "sub_field": "sub_value"     },     "array_field": [         {             "field1": "value1",             "field2": "value2"         },         {             "field1": "value3",             "field2": "value4"         }     ] } UR...
Read more

Import self signed in Linux for Chrome / Chromium headless testing

Chrome / Chromium browser offers headless mode, which is quite useful to run tests via Selenium WebDriver in CI servers. However under some circumstance your test will hit a server with self signed certificate or invalid certificate or expired certificate. This may happen for developers trying to write tests against a server started on localhost with self signed certificates or testers trying to write tests against non-production servers with expired certificates (invalid certificates). Chrome / Chromium browser ignores the SSL errors when running in non-headless mode. However in CI servers, then it should be running in headless mode and currently we cannot ignore the SSL errors for tests accessing non-localhost websites. This blogs explains the steps for import a certificate into Linux's trust store, which will make the Chrome / Chromium browser to trust the self signed certificate.  Please do not apply these steps in production servers as it will make server vulnerable to ...
Read more

Colima - Drop In replacement for Docker Desktop for Mac and Linux

Colima ( Co ntainer on Li nux Ma chines) is an open source alternative and drop in replacement for Docker Desktop on Mac and Linux. https://github.com/abiosoft/colima It is simple to setup and run containers without the need for sudo or root access. Images can be pulled form both Docker hub ( https://hub.docker.com ) or Amazon's public registry ( https://gallery.ecr.aws ) Amazon's registry is more permissive or friendly with pull rates for both clients and non-clients of AWS. This article show the setup and basics of running containers on mac. Installation command for Linux can vary based on the distribution type, hence please refer to official documentation for up-to-date steps at  https://github.com/abiosoft/colima/blob/main/docs/INSTALL.md Installation on mac: brew install docker  brew install docker-buildx brew install docker-compose brew install jq brew install colima Setup docker compose as docker plugin mkdir -p $HOME/.docker/cli-plugins ln -sfn $(which docker-compose) ...
Read more