Add the possibility to clone to a specific branch (#62)

* Add value to clone to branch

* Fix

* Fix test step

* Add debug

* Update command to clone

* Add a wrong test to validate it actually works

* Restore the good tests

.circleci/test-deploy.yml

@@ -46,6 +46,15 @@ jobs:
       - run:
           command: |-
             [ -f ./test2/README.md ]
+      - run: mkdir test3
+      - github-cli/clone:
+          repo: https://github.com/CircleCI-Public/Orb-Project-Template.git
+          branch: gmemstr-patch-1
+          dir: ./test3
+      - run: |
+          cd test3
+          [ "$(git rev-parse --abbrev-ref HEAD)" = "gmemstr-patch-1" ] 
+          
 workflows:
   test-deploy:
     jobs:

src/commands/clone.yml

@@ -15,6 +15,10 @@ parameters:
     type: string
     default: "."
     description: Select the path to clone into. By default the current path will be selected, which is dictated by the job's "working_directory".
+  branch:
+    type: string
+    default: ""
+    description: Branch to checkout. Value defaults to empty, which will clone the default branch.
   when:
     type: string
     default: "on_success"
@@ -26,5 +30,6 @@ steps:
         PARAM_GH_REPO: <<parameters.repo>>
         PARAM_GH_DIR: <<parameters.dir>>
         PARAM_GH_HOSTNAME: <<parameters.hostname>>
+        PARAM_BRANCH: <<parameters.branch>>
       command: <<include(scripts/clone.sh)>>
       when: <<parameters.when>>

src/examples/create_release.yml

@@ -5,7 +5,7 @@ description: >
 usage:
   version: 2.1
   orbs:
-    gh: circleci/github-cli@2.0
+    gh: circleci/github-cli@2.6
     node: circleci/[email protected]
   workflows:
     test-and-deploy:

src/examples/install.yml

@@ -5,7 +5,7 @@ description: >
 usage:
   version: 2.1
   orbs:
-    gh: circleci/github-cli@2.0
+    gh: circleci/github-cli@2.6
   jobs:
     create-a-deployment:
       docker:

src/examples/pr-merge.yml

@@ -5,7 +5,7 @@ description: >
 usage:
   version: 2.1
   orbs:
-    gh: circleci/github-cli@2.2.0
+    gh: circleci/github-cli@2.6.0
   workflows:
     build_and_test:
       jobs:

src/examples/setup.yml

@@ -5,7 +5,7 @@ description: >
 usage:
   version: 2.1
   orbs:
-    gh: circleci/github-cli@2.0
+    gh: circleci/github-cli@2.6
   jobs:
     create-a-pr:
       docker:

src/scripts/clone.sh

@@ -5,4 +5,10 @@ mkdir -p ~/.ssh
 ssh-keyscan -t rsa "$PARAM_GH_HOSTNAME" >> ~/.ssh/known_hosts
 
 PARAM_GITHUB_REPO_EXPANDED="$(eval echo "$PARAM_GH_REPO")"
-gh repo clone "$PARAM_GITHUB_REPO_EXPANDED" "$PARAM_GH_DIR"
+
+if [ -n "$PARAM_BRANCH" ]; then
+    gh repo clone "$PARAM_GITHUB_REPO_EXPANDED" "$PARAM_GH_DIR" -- "--branch=$PARAM_BRANCH"
+else
+    gh repo clone "$PARAM_GITHUB_REPO_EXPANDED" "$PARAM_GH_DIR"
+fi
+