Agda项目中的Github Actions缓存问题分析与解决方案

背景介绍

在Agda这个依赖Haskell生态系统的项目中，持续集成(CI)流程对于保证代码质量至关重要。项目使用Github Actions作为CI平台，并采用了Stack作为构建工具。然而，最近在测试工作流(test.yml)中出现了一个棘手的缓存相关问题，导致构建过程出现不可预测的失败。

问题现象

在Github Actions的测试工作流中，出现了模块加载失败的情况。具体表现为Agda.Version模块无法加载，提示包依赖关系不完整。深入分析日志后发现，这是由于缓存系统未能正确维护Stack构建环境的完整性所导致的。

根本原因分析

1. 缓存机制缺陷：当前工作流使用了复杂的缓存键来标识构建环境，包括GHC版本、Stack版本、ICU版本和构建计划哈希值。然而，这种设计仍然无法完全保证缓存内容与当前构建环境的兼容性。

2. 构建过程不一致：主作业恢复了缓存后，Stack开始构建某些依赖项(如ListLike-4.7.8.3)，但由于缓存命中精确匹配，这些新构建的依赖项没有被保存回缓存。

3. 子作业环境不匹配：当子作业恢复缓存时，获取到的~/.stack内容与新构建的~/.stack-work目录内容不兼容，导致最终的Agda库无法正常使用。

技术细节

在Haskell生态系统中，Stack工具管理两个重要目录：

• ~/.stack：全局包数据库和快照
• ~/.stack-work：项目特定的构建产物

当前工作流的问题在于只缓存了前者，而后者通过artifact传递，这种分离导致了环境不一致的风险。

解决方案

经过分析，我们采取了以下改进措施：

1. 双artifact策略：同时保存Stack根目录(~/.stack)和项目构建目录(~/.stack-work)到不同的artifact中，确保构建环境的完整性。

2. 缓存失效处理：在出现问题时，可以通过清除test-*相关缓存并重新运行完整测试CI来恢复。

3. 构建环境隔离：确保主作业和子作业使用完全一致的构建环境，避免因环境差异导致的兼容性问题。

实施效果

通过上述改进，我们成功解决了构建过程中的Heisenbug(难以复现的bug)，提高了CI流程的可靠性。这种解决方案不仅适用于Agda项目，对于其他使用Stack构建工具的Haskell项目也具有参考价值。

经验总结

在配置CI/CD流程时，特别是对于依赖关系复杂的项目：

• 需要全面考虑构建环境的各个组成部分
• 缓存策略应该覆盖所有关键目录
• 构建产物和依赖管理应该保持同步
• 复杂的缓存键不一定能解决所有问题，有时需要更彻底的隔离方案

这次问题的解决过程展示了在持续集成系统中处理依赖管理和缓存一致性的重要性，为类似项目提供了有价值的实践经验。