Merge pull request #24 from aiming/jkasuya-aim-patch-1

branch_name の説明を追記した

Author: takesato

.github/workflows/test.yml

@@ -22,11 +22,11 @@ jobs:
       - name: Test default checkout
         uses: ./
         with:
-          checkout_dir: step1
+          checkout_dir: step.default
 
       - name: Directory exists
         run: |
-          if [ ! -d ./step1 ]; then
+          if [ ! -d ./step.default ]; then
             echo '::error:: Should be able to be checked out'
             exit 1
           fi
@@ -35,11 +35,11 @@ jobs:
         uses: ./
         with:
           branch_name: main
-          checkout_dir: step2
+          checkout_dir: step.branch_name
 
       - name: Directory exists
         run: |
-          if [ ! -d ./step2 ]; then
+          if [ ! -d ./step.branch_name ]; then
             echo '::error:: Should be able to be checked out'
             exit 1
           fi
@@ -48,24 +48,38 @@ jobs:
         uses: ./
         with:
           branch_name: refs/heads/main
-          checkout_dir: step3
+          checkout_dir: step.long_branch_name
 
       - name: Directory exists
         run: |
-          if [ ! -d ./step3 ]; then
+          if [ ! -d ./step.long_branch_name ]; then
             echo '::error:: Should be able to be checked out'
             exit 1
           fi
 
+      - name: Test checkout with branch_name as origin/main
+        continue-on-error: true
+        uses: ./
+        with:
+          branch_name: origin/main
+          checkout_dir: step.branch_name_include_origin
+
+      - name: Directory does not exists
+        run: |
+          if [ -d ./step.branch_name_include_origin ]; then
+            echo '::error:: Should fail checking out'
+            exit 1
+          fi
+
       - name: Test checkout and no depth option
         uses: ./
         with:
           depth: ''
-          checkout_dir: step4
+          checkout_dir: step.no_depth_option
 
       - name: Directory exists
         run: |
-          if [ ! -d ./step4 ]; then
+          if [ ! -d ./step.no_depth_option ]; then
             echo '::error:: Should be able to be checked out'
             exit 1
           fi
@@ -76,11 +90,11 @@ jobs:
           ACT: 1
         with:
           depth: ''
-          checkout_dir: step5
+          checkout_dir: step.act_presented
 
       - name: Directory does not exist
         run: |
-          if [ -d ./step5 ]; then
+          if [ -d ./step.act_presented ]; then
             echo '::error:: Should not be able to be checked out, when ACT environment is exists'
             exit 1
           fi
@@ -89,14 +103,14 @@ jobs:
         uses: ./
         with:
           depth: ''
-          checkout_dir: step6
+          checkout_dir: step.authoer
 
       - name: Have user.name and user.email on .git/config?
         run: |
           set -xe
           pwd
           ls -al
-          pushd step6
+          pushd step.authoer
             if [ "${GITHUB_ACTOR}" != "$(git config --local --get user.name)" ]; then
               echo '::error:: "git config --local --get user.name" Should be equal' "$GITHUB_ACTOR"
               exit 1

README.md

@@ -24,7 +24,7 @@ https://swet.dena.com/entry/2021/07/12/120000 を参照してください。
     # Default: ${{ github.actor }}
     github_actor: ''
 
-    # cloneするブランチ名を指定します。通常は指定なしです
+    # cloneするブランチ名を指定します。通常は指定なしです（※origin/develop ではなく develop を渡してください）
     branch_name: ''
 
     # cloneするcommit shaを指定します。