解决Nix缓存动作在CI失败时不保存缓存的问题

解决Nix缓存动作在CI失败时不保存缓存的问题

cache-nix-action Cache Nix store in GitHub Actions to speed up workflows [maintainer=@deemp] 项目地址: https://gitcode.com/gh_mirrors/ca/cache-nix-action

在使用nix-community/cache-nix-action项目时，开发者可能会遇到一个常见问题：当持续集成(CI)流程失败时，Nix存储缓存无法正确保存。这种情况会导致每次失败的构建都需要从头开始，显著增加了后续构建的时间成本。

问题现象分析

在典型的GitHub Actions工作流配置中，开发者可能会这样设置缓存动作：

- name: Restore and cache Nix store
  uses: nix-community/cache-nix-action@v5
  continue-on-error: true
  with:
    primary-key: nix-${{ runner.os }}-${{ hashFiles('flake.nix', 'flake.lock', 'nix/ci-shell.nix') }}
    restore-prefixes-first-match: nix-${{ runner.os }}-
    gc-max-store-size-linux: 1073741824
    purge: true
    purge-prefixes: cache-${{ runner.os }}-
    purge-created: 0
    purge-primary-key: never

尽管设置了continue-on-error: true参数，但当后续的CI步骤失败时，缓存保存操作仍然会被跳过。这是因为GitHub Actions的"Post job"阶段在整体工作流失败时不会执行保存操作。

根本原因

这个问题源于GitHub Actions的工作机制设计。当工作流中的某个步骤失败时，系统会跳过后续所有常规步骤的执行，包括缓存保存这样的后置操作。即使单独为缓存步骤设置了continue-on-error，也无法改变这一行为。

解决方案

要解决这个问题，需要采取以下两种措施的组合：

1. 添加save-always参数：明确告诉动作无论构建状态如何都要尝试保存缓存

with:
  save-always: true

2. 配置正确的权限：确保工作流具有足够的权限来执行缓存操作

permissions:
  actions: write
  contents: read

完整的解决方案配置示例如下：

permissions:
  actions: write
  contents: read

jobs:
  build:
    steps:
      - name: Restore and cache Nix store
        uses: nix-community/cache-nix-action@v5
        continue-on-error: true
        with:
          primary-key: nix-${{ runner.os }}-${{ hashFiles('flake.nix', 'flake.lock', 'nix/ci-shell.nix') }}
          restore-prefixes-first-match: nix-${{ runner.os }}-
          gc-max-store-size-linux: 1073741824
          purge: true
          purge-prefixes: cache-${{ runner.os }}-
          purge-created: 0
          purge-primary-key: never
          save-always: true

技术原理

save-always参数强制动作在无论构建状态如何的情况下都尝试保存缓存。而权限配置则解决了"Resource not accessible by integration"错误，该错误通常发生在GitHub Actions尝试执行需要特定权限的操作时。

最佳实践建议

1. 对于关键构建步骤，始终设置continue-on-error: true和save-always: true的组合
2. 在工作流文件顶部明确定义所需的权限级别
3. 定期检查缓存命中率，确保缓存机制正常工作
4. 设置合理的缓存大小限制，避免存储空间被过度占用

通过实施这些解决方案，开发者可以确保即使在CI流程失败的情况下，Nix存储的构建结果也能被正确缓存，从而显著提高后续构建的效率。

cache-nix-action Cache Nix store in GitHub Actions to speed up workflows [maintainer=@deemp] 项目地址: https://gitcode.com/gh_mirrors/ca/cache-nix-action