Typo fixes, better descriptions

tardis-sn · Jan 27, 2025 · 058593b · 058593b
1 parent db421b9
commit 058593b
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 16 deletions.
diff --git a/.github/actions/setup_lfs/action.yml b/.github/actions/setup_lfs/action.yml
@@ -1,14 +1,14 @@
 name: "Setup LFS"
-description: "Pull LFS repositories and caches them"
+description: "Sets up Git LFS, retrieves LFS cache and fails if cache is not available"
 
 
 inputs:
   regression-data-repo:
-    description: "tardis regression data repository"
+    description: "Repository containing regression data (format: owner/repo)"
     required: false
     default: "tardis-sn/tardis-regression-data"
   atom-data-sparse:
-    description: "Only download atom data files"
+    description: "If true, only downloads atom_data/kurucz_cd23_chianti_H_He.h5 instead of full regression data"
     required: false
     default: 'false'
 

diff --git a/.github/workflows/benchmarks.yml b/.github/workflows/benchmarks.yml
@@ -29,7 +29,7 @@ defaults:
     shell: bash -l {0}
 
 jobs:
-  test_cache:
+  test-cache:
     uses: ./.github/workflows/lfs-cache.yml
     with:
       atom-data-sparse: false
@@ -43,7 +43,7 @@ jobs:
       (github.event_name == 'pull_request_target' &&
       contains(github.event.pull_request.labels.*.name, 'benchmarks')))
     runs-on: ubuntu-latest
-    needs: [test_cache]
+    needs: [test-cache]
     steps:
       - uses: actions/checkout@v4
         if: github.event_name != 'pull_request_target'

diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
@@ -36,7 +36,7 @@ defaults:
     shell: bash -l {0}
 
 jobs:
-  test_cache:
+  test-cache:
     uses: ./.github/workflows/lfs-cache.yml
     with:
       atom-data-sparse: true
@@ -83,7 +83,7 @@ jobs:
 
   build-docs:
     runs-on: ubuntu-latest
-    needs: [test_cache, check-for-changes]
+    needs: [test-cache, check-for-changes]
     if: needs.check-for-changes.outputs.trigger-check-outcome == 'success' || needs.check-for-changes.outputs.docs-check-outcome == 'success'
     steps:
       - uses: actions/checkout@v4

diff --git a/.github/workflows/lfs-cache.yml b/.github/workflows/lfs-cache.yml
@@ -4,12 +4,12 @@ on:
   workflow_call:
     inputs:
       atom-data-sparse:
-        description: "Only download atom data files"
+        description: "If true, only downloads atom_data/kurucz_cd23_chianti_H_He.h5"
         required: false
         default: false
         type: boolean
       regression-data-repo:
-        description: "tardis regression data repository"
+        description: "Repository containing regression data (format: owner/repo)"
         required: false
         default: "tardis-sn/tardis-regression-data"
         type: string
@@ -46,11 +46,6 @@ jobs:
           fi
         working-directory: tardis-regression-data
 
-      - name: Print files
-        run: |
-          echo ${{ inputs.atom-data-sparse }}
-          echo ${{ inputs.regression-data-repo }}
-          echo ${{ hashFiles('tardis-regression-data/.lfs-files-list') }}
 
       - name: Test cache availability
         uses: actions/cache/restore@v4

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -38,7 +38,7 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  test_cache:
+  test-cache:
     uses: ./.github/workflows/lfs-cache.yml
     with:
       atom-data-sparse: false
@@ -47,7 +47,7 @@ jobs:
   tests:
     name: ${{ matrix.continuum }} continuum ${{ matrix.os }} ${{ inputs.pip_git && 'pip tests enabled' || '' }}
     if: github.repository_owner == 'tardis-sn'
-    needs: [test_cache]
+    needs: [test-cache]
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false