feat: Add LFS caching with composite action

Signed-off-by: Mohamed L. Karaoui <[email protected]>

Author: moharaka

.github/actions/lfs-cache/action.yml

@@ -0,0 +1,41 @@
+name: 'LFS Cache Handler'
+description: 'Caches and restores LFS objects to reduce bandwidth usage'
+inputs:
+  lfs_enabled:
+    description: 'Whether LFS is used in this repository'
+    required: false
+    default: 'true'
+  ref:  # Add this new input
+    description: 'Git ref to checkout'
+    required: false
+runs:
+  using: "composite"
+  steps:
+    - name: Checkout (LFS disabled)
+      if: ${{ inputs.lfs_enabled == 'true' }}
+      uses: actions/checkout@v4
+      with:
+        lfs: false
+        ref: ${{ inputs.ref }}
+
+    - name: Generate LFS hash list
+      if: ${{ inputs.lfs_enabled == 'true' }}
+      shell: bash
+      run: git lfs ls-files -l | cut -d' ' -f1 | sort > .git/lfs-hashes.txt
+
+    - name: Restore LFS cache
+      if: ${{ inputs.lfs_enabled == 'true' }}
+      id: lfs-cache
+      uses: actions/cache@v4
+      with:
+        path: .git/lfs
+        key: ${{ runner.os }}-lfs-${{ hashFiles('.git/lfs-hashes.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-lfs-
+
+    - name: Fetch LFS objects
+      if: ${{ inputs.lfs_enabled == 'true' }}
+      shell: bash
+      run: |
+        git lfs fetch --prune
+        git lfs checkout

.github/workflows/build_docker_images.yml

@@ -36,11 +36,11 @@ jobs:
         image: [github_runner, github_runner_cri, cri_dev_env]
     steps:
     - uses: actions/checkout@v4
+    - name: Handle LFS Caching
+      uses: ./.github/actions/lfs-cache
       with:
+        lfs_enabled: 'true'
         ref: main
-    - name: pull binaries
-      run: |
-        git lfs pull
     - name: docker build images
       run: |
-        DOCKER_BUILDKIT=1 docker build --file ./scripts/github_runner/Dockerfile.${{ matrix.image }} .
+        DOCKER_BUILDKIT=1 docker build --file ./scripts/github_runner/Dockerfile.${{ matrix.image }} .

.github/workflows/integration_tests.yml

@@ -30,11 +30,11 @@ jobs:
       matrix:
         test-name: [test, test-man-bench]
     steps:
-  
-    - name: Check out code into the Go module directory
-      uses: actions/checkout@v4
+    - uses: actions/checkout@v4
+    - name: Handle LFS Caching
+      uses: ./.github/actions/lfs-cache
       with:
-        lfs: true
+        lfs_enabled: 'true'
 
     - name: Set up Go version in go.mod file
       uses: actions/setup-go@v5
@@ -78,4 +78,4 @@ jobs:
           
     - name: Cleaning
       if: ${{ always() }}
-      run: ./scripts/setup_tool clean_fcctr
+      run: ./scripts/setup_tool clean_fcctr

.github/workflows/nightly_tests.yml

@@ -20,10 +20,11 @@ jobs:
     - name: Setup TMPDIR
       run: mkdir -p $TMPDIR
 
-    - name: Check out code into the Go module directory
-      uses: actions/checkout@v4
+    - uses: actions/checkout@v4
+    - name: Handle LFS Caching
+      uses: ./.github/actions/lfs-cache
       with:
-        lfs: true
+        lfs_enabled: 'true'
 
     - name: Set up Go version in go.mod file
       uses: actions/setup-go@v5
@@ -109,4 +110,4 @@ jobs:
 
     - name: Cleaning
       if: ${{ always() }}
-      run: ./scripts/github_runner/clean_cri_runner.sh
+      run: ./scripts/github_runner/clean_cri_runner.sh

.github/workflows/stargz_tests.yml

@@ -37,10 +37,10 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+      - name: Handle LFS Caching
+        uses: ./.github/actions/lfs-cache
         with:
-          lfs: "true"
-      - name: Checkout LFS objects
-        run: git lfs checkout
+          lfs_enabled: 'true'
 
       - name: Set up Go version in go.mod file
         uses: actions/setup-go@v5
@@ -82,4 +82,4 @@ jobs:
         run: kn service apply stargz-test -f ./configs/knative_workloads/stargz-node.yaml --concurrency-target 1 
 
       - name: Curl container
-        run: curl http://stargz-test.default.127.0.0.1.sslip.io | grep "Hello World"
+        run: curl http://stargz-test.default.127.0.0.1.sslip.io | grep "Hello World"

.github/workflows/unit_tests.yml

@@ -125,10 +125,11 @@ jobs:
       matrix:
         module: [ ctriface, ctriface/image, devmapper ]
     steps:
-    - name: Check out code into the Go module directory
-      uses: actions/checkout@v4
+    - uses: actions/checkout@v4
+    - name: Handle LFS Caching (Check out code into the Go module directory)
+      uses: ./.github/actions/lfs-cache
       with:
-        lfs: true
+        lfs_enabled: 'true'
 
     - name: Set up Go version in go.mod file
       uses: actions/setup-go@v5