Skip to content
Branch: master
Find file History
Pull request Compare This branch is 2 commits ahead, 63 commits behind new-pipeline.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
README.md
plugin.yaml

README.md

Update git submodules

Plugin to update git submodules of an already cloned repo.

Dockerhub repo: https://hub.docker.com/r/codefresh/cfstep-gitsubmodules/tags

Options

ENVIRONMENT VARIABLE DEFAULT TYPE REQUIRED DESCRIPTION
GITHUB_TOKEN null string Yes GitHub Personal Token
CF_SUBMODULE_SYNC null boolean No If set to 'true', the step will perform 'git submodule sync' command
CF_SUBMODULE_UPDATE_RECURSIVE null boolean No If set to 'true', the step will perform 'git submodule update --init' command with '--recursive' option

Usage Example:

This example updates submodule of a cloned repo.

The step assumes that the working directory is the cloned repo (which is the default working directory for any free style step)

version: '1.0'
steps:
  updateSubmodules:
    image: codefresh/cfstep-gitsubmodules
    environment:
      - GITHUB_TOKEN=<github_token>
      - CF_SUBMODULE_SYNC=<boolean to determine if modules should be synced>
      - CF_SUBMODULE_UPDATE_RECURSIVE=<boolean to determine if modules should be recursively updated>
You can’t perform that action at this time.