Merge pull request #24 from guitarrapc/feat/tests

guitarrapc · web-flow · commit 53ffc697cbf0 · 2021-10-30T17:41:06.000+09:00
feat: add no_tags to git-shallow-clone/checkout, add test and examples.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -27,23 +27,50 @@ jobs:
     steps:
       - git-shallow-clone/checkout
   integration-test-checkout_advanced:
+    docker:
+      - image: cimg/base:stable
+    steps:
+      - git-shallow-clone/checkout_advanced
+  integration-test-checkout_advanced_fetchoptions:
     docker:
       - image: cimg/base:stable
     steps:
       - git-shallow-clone/checkout_advanced:
           clone_options: '--shallow-since "5 days ago"'
           fetch_options: '--shallow-since "5 days ago"'
+  integration-test-checkout_advanced_notags:
+    docker:
+      - image: cimg/base:stable
+    steps:
+      - git-shallow-clone/checkout_advanced:
+          clone_options: "--depth 1"
+          fetch_options: "--depth 1000 --no-tags"
+          tag_fetch_options: "--no-tags"
+      # should be no tags
+      - run: |
+          set -e
+          git tag --list
+          count=$(git tag --list | wc -l)
+          if [ $count -ne 0 ]; then exit 1; fi
+  integration-test-checkout_advanced_tags:
+    docker:
+      - image: cimg/base:stable
+    steps:
+      - git-shallow-clone/checkout_advanced:
+          clone_options: "--depth 1"
+          fetch_options: "--depth 1000"
+      # should be all tags in fetch depth
+      - run: |
+          set -e
+          git tag --list
+          count=$(git tag --list | wc -l)
+          if [ $count -eq 0 ]; then exit 1; fi
   integration-test-checkout_alpine:
     docker:
       - image: circleci/redis:alpine3.13
     steps:
       - run: apk update && apk add openssh git # openssh is required
       - git-shallow-clone/checkout
-  integration-test-checkout_macos:
-    macos:
-      xcode: 13.0.0
-    steps:
-      - git-shallow-clone/checkout
   integration-test-checkout_depth:
     docker:
       - image: cimg/base:stable
@@ -69,12 +96,42 @@ jobs:
     steps:
       - git-shallow-clone/checkout:
           keyscan_github: true
+  integration-test-checkout_macos:
+    macos:
+      xcode: 13.0.0
+    steps:
+      - git-shallow-clone/checkout
+  integration-test-checkout_notags:
+    docker:
+      - image: cimg/base:stable
+    steps:
+      - git-shallow-clone/checkout:
+          fetch_depth: 1000
+          no_tags: true
+      # should be no tags
+      - run: |
+          set -e
+          git tag --list
+          count=$(git tag --list | wc -l)
+          if [ $count -ne 0 ]; then exit 1; fi
   integration-test-checkout_path:
     docker:
       - image: cimg/base:stable
     steps:
       - git-shallow-clone/checkout:
           path: src
+  integration-test-checkout_tags:
+    docker:
+      - image: cimg/base:stable
+    steps:
+      - git-shallow-clone/checkout:
+          fetch_depth: 1000
+      # should be all tags in fetch depth
+      - run: |
+          set -e
+          git tag --list
+          count=$(git tag --list | wc -l)
+          if [ $count -eq 0 ]; then exit 1; fi
 
 workflows:
   # Prior to producing a development orb (which requires credentials) basic validation, linting, and even unit testing can be performed.
@@ -107,13 +164,18 @@ workflows:
       # Run any integration tests defined within the `jobs` key.
       - integration-test-checkout
       - integration-test-checkout_advanced
+      - integration-test-checkout_advanced_fetchoptions
+      - integration-test-checkout_advanced_notags
+      - integration-test-checkout_advanced_tags
       - integration-test-checkout_alpine
-      - integration-test-checkout_macos
       - integration-test-checkout_depth
       - integration-test-checkout_fetchdepth
       - integration-test-checkout_keyscan_bitbucket
       - integration-test-checkout_keyscan_github
+      - integration-test-checkout_macos
+      - integration-test-checkout_notags
       - integration-test-checkout_path
+      - integration-test-checkout_tags
 
       # Publish a semver version of the orb. relies on
       # the commit subject containing the text "[semver:patch|minor|major|skip]"
@@ -129,13 +191,18 @@ workflows:
           requires:
             - integration-test-checkout
             - integration-test-checkout_advanced
+            - integration-test-checkout_advanced_fetchoptions
+            - integration-test-checkout_advanced_notags
+            - integration-test-checkout_advanced_tags
             - integration-test-checkout_alpine
-            - integration-test-checkout_macos
             - integration-test-checkout_depth
             - integration-test-checkout_fetchdepth
             - integration-test-checkout_keyscan_bitbucket
             - integration-test-checkout_keyscan_github
+            - integration-test-checkout_macos
+            - integration-test-checkout_notags
             - integration-test-checkout_path
+            - integration-test-checkout_tags
           filters:
             branches:
               only:
diff --git a/src/commands/checkout.yml b/src/commands/checkout.yml
@@ -8,7 +8,7 @@ parameters:
     default: 1
   fetch_depth:
     description: >
-      Addtional fetch depth fetch depth to the specified number of commit from a remote branch history.
+      Addtional fetch depth to the specified number of commit from a remote branch history.
       Pass more number then depth when you want to check futher commit history.
     type: integer
     default: 10
@@ -27,6 +27,14 @@ parameters:
       Checkout directory (default: job’s working_directory)
     type: string
     default: .
+  no_tags:
+    description: >
+      true to add '--no-tags' when fetching.
+      As git not offer tag depth, we only able to control fetch all tags or not.
+      This enable you to stop fetch tags when you have vast numbers of tags during specified fetch depth.
+      In other word, if you need tag then fetch specified tags manually when use 'without_tag: true'.
+    type: boolean
+    default: false
 steps:
   - run:
       name: Checkout code shallow
@@ -76,18 +84,29 @@ steps:
         git clone --depth << parameters.depth >> $CIRCLE_REPOSITORY_URL "<< parameters.path >>"
         cd "<< parameters.path >>"
 
+        # Define Tag Fetch args
+        if [ -n "$CIRCLE_TAG" ]
+        then
+          # only tags operation have default --tags. others will no tag options
+          tag_args="--tags"
+        fi
+        if [ '<< parameters.no_tags >>' == 'true' ]
+        then
+          tag_args="--no-tags"
+        fi
+
         # Fetch remote and check the commit ID of the checked out code
         if [ -n "$CIRCLE_TAG" ]
         then
           # tag
-          git fetch --tags --depth << parameters.fetch_depth >> --force origin "refs/tags/${CIRCLE_TAG}"
+          git fetch ${tag_args} --depth << parameters.fetch_depth >> --force origin "+refs/tags/${CIRCLE_TAG}:refs/tags/${CIRCLE_TAG}"
         elif [[ $(echo $CIRCLE_BRANCH | grep -E ^pull\/[0-9]+$) ]] # sh version of bash `elif [[ "$CIRCLE_BRANCH" =~ ^pull\/[0-9]+$  ]]`
         then
           # pull request
-          git fetch --depth << parameters.fetch_depth >> --force origin "${CIRCLE_BRANCH}/head:remotes/origin/${CIRCLE_BRANCH}"
+          git fetch ${tag_args} --depth << parameters.fetch_depth >> --force origin "${CIRCLE_BRANCH}/head:remotes/origin/${CIRCLE_BRANCH}"
         else
           # others
-          git fetch --depth=<< parameters.fetch_depth >> --force origin "$CIRCLE_BRANCH:remotes/origin/$CIRCLE_BRANCH"
+          git fetch ${tag_args} --depth=<< parameters.fetch_depth >> --force origin "$CIRCLE_BRANCH:remotes/origin/$CIRCLE_BRANCH"
         fi
 
         # Check the commit ID of the checked out code
diff --git a/src/commands/checkout_advanced.yml b/src/commands/checkout_advanced.yml
@@ -1,6 +1,6 @@
 description: |
-    checkout by git shallow clone with git options. Support Alpine, Ubuntu, Debian and others.
-    eval is used in step, Fish shell is not supported.
+  checkout by git shallow clone with git options. Support Alpine, Ubuntu, Debian and others.
+  eval is used in step, Fish shell is not supported.
 parameters:
   clone_options:
     type: string
@@ -12,14 +12,15 @@ parameters:
     default: "--depth 10"
     description: >
       git fetch options you want to add such as '--depth 1 --verbose' and '--depth 1 --shallow-since "5 days ago"'
-      you donot beed set '--force' option as it already set by default.
-      in case of tag, '-t' sat by default in tag_fetch_options
+      you don't need set '--force' option as it already set by default.
+      in case of tag, add '--no-tags' on this option and tag_fetch_options.
   tag_fetch_options:
     type: string
     default: "--tags"
     description: >
+      This option apply when git operation is tag. Use 'fetch_options' instead if pr and other git operation.
       Additional git fetch options you want to add specifically for tags such as '--tags' or '--no-tags'.
-      Default value is --tags
+      Default value is '--tags'
   keyscan_github:
     description: >
       Pass `true` to dynamically get ssh-rsa from `github.com`.
diff --git a/src/examples/checkout.yml b/src/examples/checkout.yml
@@ -21,6 +21,9 @@ description: |
   # clone the repository to src
   - git-shallow-clone/checkout:
       path: src
+  # skip tag fetch on `PR`, `PUSH` and fetch only single tag on `TAG`
+  - git-shallow-clone/checkout:
+      no_tags: true
 
 usage:
   version: 2.1
diff --git a/src/examples/checkout_advanced.yml b/src/examples/checkout_advanced.yml
@@ -12,6 +12,13 @@ description: |
   # use --shallow-since for fetch timing, but not for clone timing.
   - git-shallow-clone/checkout_advanced
       fetch_options: '--shallow-since "5 days ago"'
+  # use --no-tags to skip tag fetch on `PR` and `PUSH`.
+  - git-shallow-clone/checkout_advanced
+      fetch_options: '--depth 10 --no-tags'
+  # use --no-tags to fetch single tag on git `TAG`.
+  - git-shallow-clone/checkout_advanced
+      fetch_options: '--depth 10 --no-tags' # you can omit this.
+      tag_fetch_options: '--no-tags'
 
 usage:
   version: 2.1
