Document that can checkout from forks in test scripts (#2928)

Author: charles-lunarg

ci/cloneSuites.bat

@@ -32,7 +32,7 @@ if not defined TEST_SUITE_BRANCH (
 git init ci-gfxr-suites
 cd ci-gfxr-suites
 git remote add origin %TEST_SUITE_REPO%
-git config --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*"
+git config --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*" & :: Allows git to pull from hashes in forks of the repo that are submitted as PRs
 
 git config remote.origin.promisor true
 git config remote.origin.partialclonefilter "blob:none"

ci/cloneSuites.sh

@@ -33,7 +33,7 @@ fi
 git init ci-gfxr-suites
 cd ci-gfxr-suites
 git remote add origin $TEST_SUITE_REPO
-git config --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*"
+git config --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*" # Allows git to pull from hashes in forks of the repo that are submitted as PRs
 
 git config remote.origin.promisor true
 git config remote.origin.partialclonefilter "blob:none"

ci/cloneTests.bat

@@ -41,7 +41,7 @@ waitfor forever /t 60 2>nul
 goto :clone_tests
 :clone_tests_done
 cd VulkanTests
-git config --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*"
+git config --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*" & :: Allows git to pull from hashes in forks of the repo that are submitted as PRs
 git fetch origin
 git checkout %TEST_BRANCH% || exit /b
 git submodule update --init --recursive

ci/cloneTests.sh

@@ -30,7 +30,7 @@ fi
 
 git clone --verbose $TEST_REPO VulkanTests
 cd VulkanTests
-git config --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*"
+git config --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*" # Allows git to pull from hashes in forks of the repo that are submitted as PRs
 git fetch origin
 git checkout $TEST_BRANCH
 git submodule update --init --recursive

ci/runJob.bat

@@ -43,7 +43,7 @@ if %clonetestloop% gtr 3 (
 waitfor forever /t 60 2>nul
 goto :clone_suites
 :clone_suites_done
-git -C ci-gfxr-suites config --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*"
+git -C ci-gfxr-suites config --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*" & :: Allows git to pull from hashes in forks of the repo that are submitted as PRs
 git -C ci-gfxr-suites fetch origin
 git -C ci-gfxr-suites checkout %TEST_SUITE_BRANCH% || exit /b
 git -C ci-gfxr-suites submodule update --init --recursive
@@ -70,7 +70,7 @@ if %clonetestloop% gtr 3 (
 waitfor forever /t 60 2>nul
 goto :clone_tests
 :clone_tests_done
-git -C VulkanTests config --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*"
+git -C VulkanTests config --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*" & :: Allows git to pull from hashes in forks of the repo that are submitted as PRs
 git -C VulkanTests fetch origin
 git -C VulkanTests checkout %TEST_BRANCH% || exit /b
 git -C VulkanTests submodule update --init --recursive

ci/runJob.sh

@@ -32,7 +32,7 @@ if [ -z "${TEST_SUITE_BRANCH:-}" ]; then
 fi
 
 git clone --verbose $TEST_SUITE_REPO ci-gfxr-suites
-git -C ci-gfxr-suites config --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*"
+git -C ci-gfxr-suites config --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*" # Allows git to pull from hashes in forks of the repo that are submitted as PRs
 git -C ci-gfxr-suites fetch origin
 git -C ci-gfxr-suites checkout $TEST_SUITE_BRANCH
 git -C ci-gfxr-suites submodule update --init --recursive
@@ -48,7 +48,7 @@ if [ -z "${TEST_BRANCH:-}" ]; then
 fi
 
 git clone --verbose $TEST_REPO VulkanTests
-git -C VulkanTests config --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*"
+git -C VulkanTests config --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*" # Allows git to pull from hashes in forks of the repo that are submitted as PRs
 git -C VulkanTests fetch origin
 git -C VulkanTests checkout $TEST_BRANCH
 git -C VulkanTests submodule update --init --recursive

ci/runJobAndroid.sh

@@ -32,7 +32,7 @@ if [ -z "${TEST_SUITE_BRANCH:-}" ]; then
 fi
 
 git clone --verbose $TEST_SUITE_REPO ci-gfxr-suites
-git -C ci-gfxr-suites config --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*"
+git -C ci-gfxr-suites config --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*" # Allows git to pull from hashes in forks of the repo that are submitted as PRs
 git -C ci-gfxr-suites fetch origin
 git -C ci-gfxr-suites checkout $TEST_SUITE_BRANCH
 git -C ci-gfxr-suites submodule update --init --recursive
@@ -48,7 +48,7 @@ if [ -z "${TEST_BRANCH:-}" ]; then
 fi
 
 git clone --verbose $TEST_REPO VulkanTests
-git -C VulkanTests config --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*"
+git -C VulkanTests config --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*" # Allows git to pull from hashes in forks of the repo that are submitted as PRs
 git -C VulkanTests fetch origin
 git -C VulkanTests checkout $TEST_BRANCH
 git -C VulkanTests submodule update --init --recursive