From e4ebe05fbce079973e9619198c9eb14dec74fe5f Mon Sep 17 00:00:00 2001
From: Ryan Scott <rscott@galois.com>
Date: Mon, 5 Aug 2024 11:34:52 -0400
Subject: [PATCH] CI: Document why always() is needed in actions/cache/save

---
 .github/workflows/ci-matrix.yml | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/.github/workflows/ci-matrix.yml b/.github/workflows/ci-matrix.yml
index 294fe4c..dde17f7 100644
--- a/.github/workflows/ci-matrix.yml
+++ b/.github/workflows/ci-matrix.yml
@@ -68,6 +68,10 @@ jobs:
 
     - uses: actions/cache/save@v4
       name: Save cabal store cache
+      # Always save the cache, even if a previous step fails. (By default, the
+      # `cache` action will skip saving the cache, which would require every
+      # subsequent CI job to rebuild the dependencies until there is a
+      # successful job.)
       if: always()
       with:
         path: ${{ steps.setup-haskell-cabal.outputs.cabal-store }}