Workflows: reworked actions and ways to skip eamxx testing jobs

bartgol · bartgol · commit e5e223a283a3 · 2024-11-06T14:48:48.000-07:00
* Do not check labels in an action.
* Implement get-labels mini-action
* Add "check" jobs that, for PRs, verify that
  * The PR touches relevant jobs
  * The PR does not have "skip" labels
diff --git a/.github/actions/check-pr-paths/README.md b/.github/actions/check-pr-paths/README.md
@@ -0,0 +1,29 @@
+# Composite action to check if testing for this PR is relevant based on touched paths
+
+This action is meant to be used inside a PR testing workflow, as
+
+```yaml
+jobs:
+  check_paths:
+    steps:
+      - name: check_relevance
+        if: ${{ github.event_name == "pull_request" }}
+        uses: ./.github/actions/check-pr-paths
+        with:
+          paths: |
+            path1
+            path2
+  testing:
+    needs: check_paths
+    if: ${{ github.event_name != "pull_request" || needs.check_paths.outputs.touched == 'true'}}
+    steps:
+      - name: testing
+```
+The input `paths1 is a list of paths that the action uses to see if
+the PR changes any relevant file. The action sets an output `touched`,
+which is `true` if the PR touches any of the listed paths and `false`
+otherwise.
+
+This action allows to skip an entire workflow, but, unlike using a 'paths' filter at the
+workflow trigger level, it ensures that the workflow DOES run,
+hence avoiding the issue where certain checks are not present on the PR.
diff --git a/.github/actions/check-pr-paths/action.yml b/.github/actions/check-pr-paths/action.yml
@@ -0,0 +1,40 @@
+name: check-pr-paths
+description: 'Check that the PR modifies relevant files'
+inputs:
+  paths:
+    description: 'List of paths that are considered relevant'
+    required: true
+    default: ''
+outputs:
+  touched:
+    description: 'Output indicating if this testing for PR is relevant'
+    value: ${{ steps.check_paths.outputs.value }}
+
+# Note: inputs are available as env vars in the shell run steps, convertet to uppercase
+runs:
+  using: "composite"
+  steps:
+    - name: get-changed-files
+      uses: tj-actions/changed-files@v45
+      with:
+        separator: ","
+    - name: check_paths
+      shell: bash
+      env:
+        CHANGED_FILES: ${{ steps.get-changed-files.outputs.all_changed_files }}
+      run: |
+        # Convert the input paths into an array, and create a regex from it
+        IFS=$'\n' read -r -a paths <<< "a,b,c"
+        pattern=$(IFS=\|; echo "${paths[*]}")
+
+        # Check for matches and echo the matching files
+        # matching_files=$(echo "$CHANGED_FILES" | grep -E "^($pattern)")
+        # if [[ -n "$matching_files" ]]; then
+        #   echo "Found relevant files: "$matching_files"  # Print the matching files
+        #   echo "value=true" >> $GITHUB_OUTPUT
+        # else
+        #   echo "No relevant files touched by this PR."
+        #   echo "value=false" >> $GITHUB_OUTPUT
+        # fi
+        echo "value=false" >> $GITHUB_OUTPUT
+
diff --git a/.github/actions/check-skip-labels/README.md b/.github/actions/check-skip-labels/README.md
diff --git a/.github/actions/check-skip-labels/action.yml b/.github/actions/check-skip-labels/action.yml
diff --git a/.github/actions/get-labels/README.md b/.github/actions/get-labels/README.md
@@ -0,0 +1,19 @@
+# Composite action to retrieve labels of a PR if event is `pull_request`
+
+This action is meant to be used inside a PR testing workflow, as
+
+```yaml
+jobs:
+  get_labels:
+    steps:
+      - name: get_labels
+        uses: ./.github/actions/get-labels
+  testing:
+    needs: get_labels
+    if: ${{ github.event_name != "pull_request" || 
+            !contains(needs.get_labels.outputs.labels,"label1" ||
+            !contains(needs.get_labels.outputs.labels,"label1" }}
+```
+The action sets the output `labels`, which is a comma-separated list
+containing the PR labels. If the event that triggered the workflow is
+not a PR, the output will be an empty string
diff --git a/.github/actions/get-labels/action.yml b/.github/actions/get-labels/action.yml
@@ -0,0 +1,17 @@
+name: get-labels
+description: 'Check that the PR modifies does not have skip labels'
+outputs:
+  labels:
+    description: 'Comma-separated list of labels on the PR or empty string (if not a PR event)'
+    value: ${{ steps.get_labels.outputs.labels }}
+
+# Note: inputs are available as env vars in the shell run steps, convertet to uppercase
+runs:
+  using: "composite"
+  steps:
+    - name: get_labels
+      shell: sh
+      env:
+        PR_LABELS: ${{ toJson(github.event.pull_request.labels.*.name) }}  # Pass PR label names as JSON
+      run: |
+        echo 'labels=\"$(echo \"$PR_LABELS\" | jq -r "join(\",\")")\"' >> $GITHUB_OUTPUT
diff --git a/.github/workflows/eamxx-sa-testing.yml b/.github/workflows/eamxx-sa-testing.yml
@@ -5,17 +5,6 @@ on:
   pull_request:
     branches: [ master ]
     types: [opened, synchronize, ready_for_review, reopened]
-    paths:
-      - components/eamxx/**
-      - components/eam/src/physics/rrtmgp/**
-      - components/eam/src/physics/p3/scream/**
-      - components/eam/src/physics/cam/**
-      - .github/workflows/eamxx-standalone-testing.yml
-      - externals/ekat/**
-      - externals/scorpio/**
-      - externals/haero/**
-      - externals/YAKL/**
-      - components/eam/src/physics/rrtmgp/external/**
 
   # Manual run is used to bless
   workflow_dispatch:
@@ -48,15 +37,51 @@ env:
   submit: ${{ github.event_name == 'schedule' && 'true' || 'false' }}  # Submit to cdash only for nightlies
 
 jobs:
+  pr_relevant:
+    runs-on: ubuntu-latest  # This job can run anywhere
+    outputs:
+      value: ${{ steps.check_paths.outputs.touched }}
+    steps:
+      - name: check_paths
+        if: ${{ github.event_name == "pull_request" }}
+        uses: ./.github/actions/check-pr-relevance
+        with:
+          paths: |
+            components/eamxx
+            components/eam/src/physics/rrtmgp
+            components/eam/src/physics/p3/scream
+            components/eam/src/physics/cam
+            components/eam/src/physics/rrtmgp/external
+            externals/ekat
+            externals/scorpio
+            externals/haero
+            externals/YAKL
+            .github/workflows/eamxx-sa-testing.yml
+  get_labels:
+    runs-on: ubuntu-latest
+    outputs: ${{ steps.get_labels.outputs.labels }}
+    steps:
+      - name: get_labels
+        uses: ./.github/actions/get-labels
   gcc-openmp:
+    needs: pr_relevant, get_labels
+    if: ${{
+      (github.event_name == 'pull_request' &&
+       needs.pr_relevant.outputs.value=='true' &&
+       !contains(needs.get_labels.outputs.labels,'CI: skip gcc') &&
+       !contains(needs.get_labels.outputs.labels,'CI: skip openmp') &&
+       !contains(needs.get_labels.outputs.labels,'CI: skip eamxx-sa') &&
+       !contains(needs.get_labels.outputs.labels,'CI: skip eamxx-all')) ||
+      (github.event_name == 'workflow_dispatch' &&
+       github.event.inputs.job_to_run == 'gcc-openmp' || 
+       github.event.inputs.job_to_run == 'all') ||
+       github.event_name == 'schedule'
+    }} 
     runs-on:  [self-hosted, ghci-snl-cpu, gcc]
     strategy:
       fail-fast: false
       matrix:
         build_type: [sp, dbg, fpe, opt]
-    if: ${{ github.event_name != 'workflow_dispatch' ||
-            github.event.inputs.job_to_run == 'gcc-openmp' ||
-            github.event.inputs.job_to_run == 'all' }}
     name: gcc-openmp / ${{ matrix.build_type }}
     steps:
       - name: Check out the repository
@@ -67,13 +92,6 @@ jobs:
           submodules: recursive
       - name: Show action trigger
         uses: ./.github/actions/show-workflow-trigger
-      - name: Check for skip labels
-        if: ${{ github.event_name == 'pull_request' || github.event_name == 'pull_request_review' }}
-        uses: ./.github/actions/check-skip-labels
-        with:
-          skip_labels: 'AT: skip gcc,AT: skip openmp,AT: skip eamxx-sa,AT: skip eamxx-all'
-          token: ${{ secrets.GITHUB_TOKEN }}
-          pr_number: ${{ github.event.pull_request.number }}
       - name: Set test-all inputs based on event specs
         run: |
           echo "generate=false" >> $GITHUB_ENV
@@ -91,14 +109,24 @@ jobs:
           submit: ${{ env.submit }}
           cmake-configs: Kokkos_ENABLE_OPENMP=ON
   gcc-cuda:
+    needs: pr_relevant, get_labels
+    if: ${{
+      (github.event_name == 'pull_request' &&
+       needs.pr_relevant.outputs.value=='true' &&
+       !contains(needs.get_labels.outputs.labels,'CI: skip gcc') &&
+       !contains(needs.get_labels.outputs.labels,'CI: skip cuda') &&
+       !contains(needs.get_labels.outputs.labels,'CI: skip eamxx-sa') &&
+       !contains(needs.get_labels.outputs.labels,'CI: skip eamxx-all')) ||
+      (github.event_name == 'workflow_dispatch' &&
+       github.event.inputs.job_to_run == 'gcc-cuda' || 
+       github.event.inputs.job_to_run == 'all') ||
+       github.event_name == 'schedule'
+    }} 
     runs-on:  [self-hosted, ghci-snl-cuda, cuda, gcc]
     strategy:
       fail-fast: false
       matrix:
         build_type: [sp, dbg, opt]
-    if: ${{ github.event_name != 'workflow_dispatch' ||
-            github.event.inputs.job_to_run == 'gcc-cuda' ||
-            github.event.inputs.job_to_run == 'all' }}
     name: gcc-cuda / ${{ matrix.build_type }}
     steps:
       - name: Check out the repository
@@ -109,13 +137,6 @@ jobs:
           submodules: recursive
       - name: Show action trigger
         uses: ./.github/actions/show-workflow-trigger
-      - name: Check for skip labels
-        if: ${{ github.event_name == 'pull_request' || github.event_name == 'pull_request_review' }}
-        uses: ./.github/actions/check-skip-labels
-        with:
-          skip_labels: 'AT: skip gcc,AT: skip cuda,AT: skip eamxx-sa,AT: skip eamxx-all'
-          token: ${{ secrets.GITHUB_TOKEN }}
-          pr_number: ${{ github.event.pull_request.number }}
       - name: Set test-all inputs based on event specs
         run: |
           echo "generate=false" >> $GITHUB_ENV
diff --git a/.github/workflows/eamxx-scripts-tests.yml b/.github/workflows/eamxx-scripts-tests.yml
@@ -5,15 +5,6 @@ on:
   pull_request:
     branches: [ master ]
     types: [opened, synchronize, ready_for_review, reopened]
-    paths:
-      - components/eamxx/scripts/**
-      - components/eamxx/cime_config/*.py
-      - .github/workflows/eamxx-scripts-tests.yml
-      - externals/ekat/**
-      - externals/scorpio/**
-      - externals/haero/**
-      - externals/YAKL/**
-      - components/eam/src/physics/rrtmgp/external/**
 
   # Manual run for debug purposes only
   workflow_dispatch:
@@ -30,9 +21,54 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  pr_relevant:
+    if: ${{ github.event_name == 'pull_request' }}
+    runs-on: ubuntu-latest  # This job can run anywhere
+    outputs:
+      value: ${{ steps.check_paths.outputs.touched }}
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: false
+      - name: check_paths
+        uses: ./.github/actions/check-pr-paths
+        with:
+          paths: |
+            components/eamxx/scripts
+            components/eamxx/cime_config/eamxx
+            components/eamxx/cime_config/build
+            components/eamxx/cime_config/yaml_utils.py
+            .github/workflows/eamxx-scripts-tests.yml
+  get_labels:
+    if: ${{ github.event_name == 'pull_request' }}
+    runs-on: ubuntu-latest
+    outputs:
+      labels: ${{ steps.get_labels.outputs.labels }}
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: false
+      - name: get_labels
+        uses: ./.github/actions/get-labels
   cpu-gcc:
+    needs: [pr_relevant, get_labels]
+    # if: ${{
+    #   github.event_name != 'pull_request' ||
+    #   (
+    #     needs.pr_relevant.outputs.value == 'true'
+    #     # needs.pr_relevant.outputs.value == 'true' &&
+    #     # !contains(split(needs.get_labels.outputs.labels, ','), 'CI: skip eamxx-all')
+    #   )
+    # }}
     runs-on:  [self-hosted, gcc, ghci-snl-cpu]
     steps:
+      - name: print-stuff
+        run: |
+          echo "PR Relevant Value: '${{ needs.pr_relevant.outputs.value }}'"
+          echo "Event Name: '${{ github.event_name }}'"
+          echo "labels: '${{ needs.get_labels.outputs.labels }}'"
       - name: Check out the repository
         uses: actions/checkout@v4
         with:
@@ -41,13 +77,6 @@ jobs:
           submodules: recursive
       - name: Show action trigger
         uses: ./.github/actions/show-workflow-trigger
-      - name: Check for skip labels
-        if: ${{ github.event_name == 'pull_request' || github.event_name == 'pull_request_review' }}
-        uses: ./.github/actions/check-skip-labels
-        with:
-          skip_labels: 'AT: skip eamxx-all'
-          token: ${{ secrets.GITHUB_TOKEN }}
-          pr_number: ${{ github.event.pull_request.number }}
       - name: Run test
         run: |
           cd components/eamxx
diff --git a/.github/workflows/eamxx-v1-testing.yml b/.github/workflows/eamxx-v1-testing.yml
