From 08ab26ef89ca13edb987769d77fd62e4c0aef2d0 Mon Sep 17 00:00:00 2001
From: Nicholas Clark <nick@ccl4.org>
Date: Wed, 22 Sep 2021 14:12:51 +0000
Subject: Leave the checkout `fetch-depth` at its default (1) for most jobs

The default is a shallow checkout.

Keep the full checkout for the "sanity test" job so that it runs all the
tests in t/porting. Add a comment explaining the reasoning.
---
 .github/workflows/testsuite.yml | 24 ++++++++----------------
 1 file changed, 8 insertions(+), 16 deletions(-)

(limited to '.github')

diff --git a/.github/workflows/testsuite.yml b/.github/workflows/testsuite.yml
index d5c4795e57..724b81a754 100644
--- a/.github/workflows/testsuite.yml
+++ b/.github/workflows/testsuite.yml
@@ -62,6 +62,14 @@ jobs:
   # "sanity_check" tests -Dusethreads without -DDEBUGGING
   # "linux-i386" tests -Uusethreads without -DDEBUGGING
   # All builds in the "linux" matrix test with -DDEBUGGING
+  #
+  # "sanity_check" sets `fetch-depth: 0` so that it does a git clone with full
+  # history, and hence can run t/porting/cmp_version.t etc
+  # The git-related tests require full history, but we only need to run them
+  # once (they aren't platform specific).
+  # Hence leave the others with the default setting (1), which performs a
+  # shallow clone. In these shallow checkouts, the git related porting tests
+  # skip (or rapidly pass), but they won't fail spuriously.
 
   sanity_check:
     name: "Sanity: Linux -Dusethreads"
@@ -140,8 +148,6 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
       - name: git cfg + fetch tags
         run: |
           git config diff.renameLimit 999999
@@ -234,8 +240,6 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
       - name: git cfg + fetch tags
         run: |
           git config diff.renameLimit 999999
@@ -289,8 +293,6 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-        with:
-          fetch-depth: 10
       - name: Configure
         run: |
           export SDK=/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.15.sdk
@@ -321,8 +323,6 @@ jobs:
     steps:
       - run: git config --global core.autocrlf false
       - uses: actions/checkout@v2
-        with:
-          fetch-depth: 10
       #- name: Install clcache
       #  shell: cmd
       #  run: |
@@ -379,8 +379,6 @@ jobs:
     steps:
       - run: git config --global core.autocrlf false
       - uses: actions/checkout@v2
-        with:
-          fetch-depth: 10
       - name: Set up Perl build environment
         run: |
           # skip installing perl if it is already installed.
@@ -499,8 +497,6 @@ jobs:
           GITHUB_CONTEXT: ${{ toJson(github) }}
         run: echo "$GITHUB_CONTEXT"
       - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
       - name: git cfg + fetch tags
         run: |
           git config diff.renameLimit 999999
@@ -549,8 +545,6 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
       - name: git cfg + fetch tags
         run: |
           git config diff.renameLimit 999999
@@ -595,8 +589,6 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
       - name: git cfg + fetch tags
         run: |
           git config diff.renameLimit 999999
-- 
cgit v1.2.1