Merge pull request #41 from codefresh-io/gitsubmodules

Gitsubmodules

Author: francisco-cocozza

dynamic-catalog.md

@@ -1,5 +1,5 @@
 # **Catalog**
-Created at ** Wed Dec 26 2018 12:59:29 GMT+0000 (Coordinated Universal Time)**
+Created at ** Thu Dec 27 2018 22:37:47 GMT+0000 (Coordinated Universal Time)**
 
 
 | Plugin Name   | Image     | Description           | source | Tags  |
@@ -11,6 +11,7 @@ Created at ** Wed Dec 26 2018 12:59:29 GMT+0000 (Coordinated Universal Time)**
  | docker-service | codefresh/docker-service | Codefresh docker-service plugin | https://github.com/codefresh-io/docker-service |  **`docker`**  **`docker-machine`**  **`docker-compose`** |
  | ecs-deploy | codefresh/ecs | Release a Helm chart (update or install) | https://github.com/codefresh-io/cf-deploy-ecs.git |  **`ecs`**  **`deploy`**  **`containers`** |
  | github-pr | codefresh/github-pr-plugin | Operates on GitHub pull requests | https://github.com/codefresh-io/github-pr-plugin |  **`docker`**  **`github`**  **`pull-request`** |
+ | gitsubmodules | codefresh/cfstep-gitsubmodules | Update git submodules | https://github.com/codefresh-io/cfstep-gitsubmodules |  **`git`**  **`submodules`** |
  | gke | codefresh/plugin-gke | Codefresh gke plugin | https://github.com/codefresh-io/plugin-gke |  **`kubernetes`**  **`gke`**  **`gcloud`** |
  | helm | codefresh/cfstep-helm | Release a Helm chart (update or install) | https://github.com/codefresh-contrib/cfplugin-step |  **`helm`**  **`kubernetes`** |
  | helm-legacy | codefresh/plugin-helm | Release a Helm chart (update or install). There is a new Helm plugin with added capabilities, we are keeping this plugin as is for backward-compatibility. The new plugin is at /incubator/helm (https://github.com/codefresh-io/plugins/tree/master/incubator/helm) | https://github.com/codefresh-io/cf-plugin-helm |  **`helm`**  **`kubernetes`** |

plugins/gitsubmodules/README.md

@@ -0,0 +1,28 @@
+# 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)
+
+```yaml
+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>
+```

plugins/gitsubmodules/plugin.yaml

@@ -0,0 +1,24 @@
+image: codefresh/cfstep-gitsubmodules
+tag: latest
+version: 0.1.0
+description: Update git submodules
+keywords:
+  - git
+  - submodules
+home: https://github.com/codefresh-io/cfstep-gitsubmodules
+sources:
+  - https://github.com/codefresh-io/cfstep-gitsubmodules
+maintainers:
+  - name: Francisco Cocozza
+    email: francisco@codefresh.io
+icon: https://git-scm.com/images/logos/downloads/Git-Icon-1788C.png
+  envs:
+    - name: GITHUB_TOKEN
+      type: required
+      description: GitHub Token required to access the repository
+    - name: CF_SUBMODULE_SYNC
+      type: optional
+      description: if var is set to 'true', the step will perform 'git submodule sync' command
+    - name: CF_SUBMODULE_UPDATE_RECURSIVE
+      type: optional
+      description: if set to 'true', the step will perform 'git submodule update --init' command with '--recursive' option