ci: support worktree (#3425)

Co-authored-by: svcAPLBot <174728082+svcAPLBot@users.noreply.github.com>

Author: j-zimnowoda

.github/workflows/svcaplbot-run-dyff.yml

@@ -5,10 +5,10 @@ on:
   pull_request:
     types: [opened, synchronize, reopened, ready_for_review]
     paths:
-      - "charts/**"
-      - "values/**"
-      - "tests/fixtures/**"
-      - "helmfile.d/**"
+      - 'charts/**'
+      - 'values/**'
+      - 'tests/fixtures/**'
+      - 'helmfile.d/**'
 
 permissions:
   contents: read
@@ -64,24 +64,25 @@ jobs:
       - name: Checkout PR branch
         uses: actions/checkout@v6
         with:
-          ref: ${{ github.event.pull_request.head.sha }}
+          ref: ${{ github.event.pull_request.head.sha || github.sha }}
+          fetch-depth: 0
           path: pr
-      - name: Checkout base branch
-        uses: actions/checkout@v6
-        with:
-          ref: ${{ github.event.pull_request.base.ref || 'main' }}
-          path: base
       - name: Set up Node.js
         uses: actions/setup-node@v6
         with:
           node-version-file: 'pr/.nvmrc'
           check-latest: true
       - name: Install npm dependencies
-        run: cd "$GITHUB_WORKSPACE/pr" && npm install --no-save && cd "$GITHUB_WORKSPACE/base" && npm install --no-save
+        run: cd "$GITHUB_WORKSPACE/pr" && npm install --no-save
+      - name: Prepare base branch ref for worktree
+        run: |
+          cd "$GITHUB_WORKSPACE/pr"
+          base_ref="${{ github.event.pull_request.base.ref || 'main' }}"
+          git fetch --no-tags --prune origin "$base_ref:$base_ref"
       - name: Install Helm and Helmfile
         uses: helmfile/helmfile-action@v2.4.6
         with:
-          helmfile-args: version  # In this step, we only want these tools to be installed
+          helmfile-args: version # In this step, we only want these tools to be installed
           helm-plugins: >
             https://github.com/databus23/helm-diff,
             https://github.com/jkroepke/helm-secrets
@@ -96,12 +97,16 @@ jobs:
         id: run_script
         env:
           GH_TOKEN: ${{ secrets.BOT_TOKEN }}
+          HUSKY: '0'
         run: |
+          cd "$GITHUB_WORKSPACE/pr"
           mkdir -p tmp
-          "$GITHUB_WORKSPACE/pr/bin/compare.sh" "$GITHUB_WORKSPACE/base" "$GITHUB_WORKSPACE/pr" --diff-output tmp/diff-output.txt
-          comment_file="$PWD/tmp/pr-comment.txt"
+          ./bin/compare.sh --diff-output tmp/diff-output.txt
+          comment_file="$GITHUB_WORKSPACE/pr/tmp/pr-comment.txt"
           echo "Comparison of Helm chart templating output:" > "$comment_file"
           echo '```diff' >> "$comment_file"
-          cat tmp/diff-output.txt >> "$comment_file"
+          cat "$GITHUB_WORKSPACE/pr/tmp/diff-output.txt" >> "$comment_file"
           echo '```' >> "$comment_file"
-          cd "$GITHUB_WORKSPACE/pr" && gh pr comment ${{ github.event.pull_request.number }} --body-file "$comment_file" --create-if-none --edit-last
+          if [ "${{ github.event_name }}" = "pull_request" ]; then
+            gh pr comment ${{ github.event.pull_request.number }} --body-file "$comment_file" --create-if-none --edit-last
+          fi

bin/compare.sh

@@ -14,6 +14,7 @@ srcDirA=
 srcDirB=
 targetDirA=
 targetDirB=
+tmpWorktreeA=
 # Process arguments
 while [ $# -ne 0 ]; do
   case "$1" in
@@ -42,45 +43,61 @@ done
 
 readonly script_dir=$(dirname "$0")
 
+cleanup() {
+  if [ -n "${tmpWorktreeA}" ] && [ -d "${tmpWorktreeA}" ]; then
+    git -c core.hooksPath=/dev/null worktree remove --force "${tmpWorktreeA}" >/dev/null 2>&1 || true
+    rm -rf "${tmpWorktreeA}" || true
+  fi
+}
+
+trap cleanup EXIT
+
 generate_helm_templates() {
   local target_dir="$1"
+  local source_dir="$2"
+
+  pushd "$source_dir" >/dev/null
   rm -rf "$target_dir"
   node --no-warnings --import tsx src/otomi.ts -- values
   helmfile template "${templateArgs[@]}" --output-dir-template="$target_dir/{{.Release.Namespace}}-{{.Release.Name}}"
   mv tests/fixtures/values-repo.yaml "$target_dir/values-repo.yaml"
+  popd >/dev/null
 }
 
 export NODE_ENV=test
 if [ -z "$srcDirA" ]; then
   branchA='main'
   # branchB current branch
   branchB=$(git rev-parse --abbrev-ref HEAD)
+  if [ "$branchB" = "HEAD" ]; then
+    branchB="detached-$(git rev-parse --short HEAD)"
+  fi
 
   targetDirA="$PWD/tmp/${branchA}"
   targetDirB="$PWD/tmp/${branchB}"
+
   export ENV_DIR="$PWD/tests/fixtures"
-  generate_helm_templates "$targetDirB"
-  git -c core.hooksPath=/dev/null checkout -f $branchA
-  generate_helm_templates "$targetDirA"
-  git -c core.hooksPath=/dev/null checkout -f $branchB
+  generate_helm_templates "$targetDirB" "$PWD"
+
+  tmpWorktreeA="$PWD/tmp/worktree-${branchA}-$$"
+  git -c core.hooksPath=/dev/null worktree add --detach "$tmpWorktreeA" "$branchA" >/dev/null
+  export ENV_DIR="$tmpWorktreeA/tests/fixtures"
+  generate_helm_templates "$targetDirA" "$tmpWorktreeA"
 else
   if [ -z "$srcDirB" ]; then
     echo "Only one directory passed for comparison"
     exit 1
   fi
   startDir=$PWD
-  pushd "$srcDirB"
   export ENV_DIR="$srcDirB/tests/fixtures"
   branchB=$(git rev-parse --abbrev-ref HEAD)
   targetDirB="$startDir/tmp/${branchB}"
-  generate_helm_templates "$targetDirB"
-  popd
-  pushd "$srcDirA"
+  generate_helm_templates "$targetDirB" "$srcDirB"
+
   export ENV_DIR="$srcDirA/tests/fixtures"
   branchA=$(git rev-parse --abbrev-ref HEAD)
   targetDirA="$startDir/tmp/${branchA}"
-  generate_helm_templates "$targetDirA"
-  popd
+  generate_helm_templates "$targetDirA" "$srcDirA"
 fi
 
 # order of arguments matters so new changes are green color

tests/fixtures/env/settings/cluster.yaml

@@ -3,7 +3,7 @@ metadata:
     name: cluster
 spec:
     apiServer: https://1.1.1.1:8443
-    defaultStorageClass: ""
+    defaultStorageClass: 'abc'
     domainSuffix: dev.linode-apl.net
     k8sContext: linode-dev
     linode: