Tweak github action used to detect changed paths on push/pull request

Author: maxstack

.github/workflows/main.yml

@@ -33,18 +33,18 @@ jobs:
         extra_on_push: ${{ steps.filter_some.outputs.extra_on_push }}
         extra_on_pull_request: ${{ steps.filter_some.outputs.extra_on_pull_request }}
         stackhpc: ${{ toJson(fromJson(steps.filter_some.outputs.stackhpc) || fromJson(steps.filter_every.outputs.stackhpc)) }}
-        stackhpc_some: ${{ steps.filter_some.outputs.stackhpc }}
-        stackhpc_every: ${{ steps.filter_every.outputs.stackhpc }}
         trivvyscan: ${{ steps.filter_some.outputs.trivvyscan }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Paths matching on any filter 
-        # For safety using commit of dorny/paths-filter@v3
+      - name: Paths matching on any filter rule
+        # For safety use the commit of dorny/paths-filter@v3
         uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36
         id: filter_some
         with:
+          # Filter changed files, 'some' means the file is matched if any one of the filter rules match.
+          # Processing is different from 'paths' and 'paths_exclude', see note below.
           predicate-quantifier: 'some'
           list-files: 'json'
           filters: |
@@ -62,54 +62,47 @@ jobs:
               - 'ansible/roles/lustre/**'
               - '.github/workflows/extra.yml'
             stackhpc:
-              #- '**'
-              #- '!dev/**'
-              - 'dev/setup-env.sh___TMP_WILL_NOT_MATCH'
-              #- '!docs/**'
-              #- '!README.md'
-              #- '!.gitignore'
-              #- '!.github/workflows/'
+              - 'dev/setup-env.sh'
               - '.github/workflows/stackhpc'
             trivvyscan:
               - 'environments/.stackhpc/tofu/cluster_image.auto.tfvars.json'
 
-      - name: Paths matching on every filter
-        # For safety using commit of dorny/paths-filter@v3
+      - name: Paths matching on every filter rule
+        # For safety use the commit of dorny/paths-filter@v3
         uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36
         id: filter_every
         with:
+          # Filter changed files, 'every' means the file is matched only if matches all filter rules.
+          # Processing is different from 'paths' and 'paths_exclude', see note below.
           predicate-quantifier: 'every'
           list-files: 'json'
           filters: |
             stackhpc:
-              - '**___TMP_WILL_NOT_MATCH'
+              - '**'
               - '!dev/**'
               - '!**/*.md'
               - '!.gitignore'
               - '!.github/workflows/'
 
-      - name: Paths matching
+      - name: Paths matched output
+        # NOTE: This is a debug step, it prints the paths that matched the filters
+        #       It's useful because dorny/paths-filter doesn't work like the conventional 'paths' and 'paths_exclude'
+        #       We can't do the following: 
+        # paths:
+        #   - '**'
+        #   - '!dev/**'
+        #   - 'dev/setup-env.sh'
+        #
+        #      Which would include all files whilst removing all "dev/" files except "dev/setup-env.sh".
+        #      Instead the 'some' stackhpc filter ensures we include "dev/setup-env.sh" - if changed,
+        #      the 'every' stackhpc filter ensures we don't include any other "dev/**" files.
         run: >
           echo '{ "extra_on_push_files": ${{ steps.filter_some.outputs.extra_on_push_files }} }' | jq -r '.';
           echo '{ "extra_on_pull_request_files": ${{ steps.filter_some.outputs.extra_on_pull_request_files }} }' | jq -r '.';
           echo '{ "stackhpc_some_files": ${{ steps.filter_some.outputs.stackhpc_files }} }' | jq -r '.';
           echo '{ "stackhpc_every_files": ${{ steps.filter_every.outputs.stackhpc_files }} }' | jq -r '.';
           echo '{ "trivvyscan_files": ${{ steps.filter_some.outputs.trivvyscan_files }} }' | jq -r '.'
 
-  debug:
-    name: Debug paths matching
-    needs: files_changed
-    steps:
-      - name: Debug paths matching
-        run: >
-          echo 'extra_on_push: ${{ needs.files_changed.outputs.extra_on_push }}';
-          echo 'extra_on_pull_request: ${{ needs.files_changed.outputs.extra_on_pull_request }}';
-          echo 'stackhpc: ${{ needs.files_changed.outputs.stackhpc }}';
-          echo 'stackhpc_some: ${{ needs.files_changed.outputs.stackhpc_some }}';
-          echo 'stackhpc_every: ${{ needs.files_changed.outputs.stackhpc_every }}';
-          echo 'trivvyscan: ${{ needs.files_changed.outputs.trivvyscan }}'
-    runs-on: ubuntu-latest # TEST
-
   extra:
     name: Test extra build
     needs: files_changed
@@ -129,8 +122,7 @@ jobs:
     name: Test deployment and reimage on OpenStack
     needs: files_changed
     if: |
-      needs.files_changed.outputs.stackhpc_some == 'true' ||
-      needs.files_changed.outputs.stackhpc_every == 'true'
+      needs.files_changed.outputs.stackhpc == 'true'
     #uses: ./.github/workflows/stackhpc.yml
     steps: # TEST
       - name: Test deployment and reimage on OpenStack...