Cache key documentation

docs/contributing/development/continuous_integration.rst

@@ -27,6 +27,30 @@ TARDIS Pipelines
 
 Brief description of pipelines already implemented on TARDIS
 
+Cache Keys in TARDIS CI
+-----------------------
+
+TARDIS uses specific cache key formats to efficiently store and retrieve data during CI runs:
+
+1. **Regression Data Cache Keys**
+   - Format: ``tardis-regression-<data-type>-<hash>-v1``
+   - Examples:
+     - ``tardis-regression-atom-data-sparse-<hash>-v1`` - For atomic data cache
+     - ``tardis-regression-full-data-<hash>-v1`` - For full TARDIS regression data cache
+   - Used in: ``setup_lfs`` action
+
+2. **Environment Cache Keys**
+   - Format: ``tardis-conda-env-<os-label>-<hash>-v1``
+   - Examples:
+     - ``tardis-conda-env-linux-<hash>-v1`` - For Linux conda environment
+     - ``tardis-conda-env-macos-<hash>-v1`` - For macOS conda environment
+   - Used in: ``setup_env`` action
+
+.. warning::
+   - The version suffix (-v1) allows for future cache invalidation if needed.
+   - Sometimes the cache might not be saved due to race conditions between parallel jobs. Please check workflow runs when testing new regression data for cache misses to avoid consuming LFS quota.
+
+
 Streamlined Steps for TARDIS Pipelines
 ========================================
 

docs/contributing/development/running_tests.rst

@@ -62,7 +62,7 @@ Or, to run tests for a particular file or directory
     To prevent leaking LFS quota, tests have been disabled on forks.
     If, by any chance, you need to run tests on your fork, make sure to run the tests workflow on master branch first.
     The LFS cache generated in the master branch should be available in all child branches. 
-    You can check if cache was generated by looking in the ``Restore LFS Cache`` step of the workflow run. 
+    You can check if cache was generated by looking in the ``Setup LFS`` step of the workflow run. 
     Cache can also be found under the "Management" Section under "Actions" tab.
 
 Generating Plasma Reference