从/到缓存保存和恢复包¶
警告
此功能为实验性功能,可能会有重大更改。更多信息请参阅 Conan 稳定性 部分。
通过 conan cache save
和 conan cache restore
命令,可以从一个或多个 Conan 缓存中的包创建 .tgz 文件,然后将这些包恢复到另一个 Conan 缓存中。在某些场景下这会很有用:
在持续集成中,特别是进行分布式构建时,能够移动最近构建的临时包可能会非常方便。大多数 CI 系统都具备为此目的在作业之间传输文件的能力。Conan 缓存不是并发的,有时并行作业必须使用不同的缓存。
对于离线设置,其中包只能通过客户端传输。
开发者直接与其他开发者共享一些包以进行测试或检查。
保存包的过程使用 conan cache save
命令。它可以使用像 conan list
命令一样的模式,但它也可以接受包列表,就像 remove, upload, download
等其他命令一样。例如:
$ conan cache save "pkg/*:*"
Saving pkg/1.0: p/pkg1df6df1a3b33c
Saving pkg/1.0:9a4eb3c8701508aa9458b1a73d0633783ecc2270: p/b/pkgd573962ec2c90/p
Saving pkg/1.0:9a4eb3c8701508aa9458b1a73d0633783ecc2270 metadata: p/b/pkgd573962ec2c90/p
...
# creates conan_cache_save.tgz
conan_cache_save.tgz
文件包含名为 pkg
(任何版本)的包、最新的食谱修订版以及所有包二进制文件的最新包修订版。文件名称可以通过可选的 --file=xxxx
参数更改。一些重要注意事项:
该命令保存缓存“食谱”文件夹的内容,包括子文件夹“export”、“export_sources”、“source”和食谱“metadata”。
缓存中的“source”文件夹可以使用
conan cache save --no-source
参数跳过。这意味着如果恢复的食谱需要在恢复的缓存中构建新的二进制文件,它将没有源文件,如果食谱的source()
方法指示,它将尝试下载它们。该命令保存“package”和包“metadata”文件夹的内容,但不保存二进制文件的“build”或“download”文件夹,因为它们被认为是临时文件夹。
如果用户不希望保存这些文件夹中的任何一个,可以在保存之前使用
conan cache clean
命令清理它们。该命令保存缓存文件和工件以及元数据(修订版、package_id),以便能够将这些包恢复到另一个缓存中。但它不保存任何其他缓存状态,如
settings.yml
、global.conf
、remotes
等。如果保存的包需要任何其他特定配置,应使用conan config install
进行管理。
我们可以将此 conan_cache_save.tgz
文件移动到另一个 Conan 缓存并按以下方式恢复:
$ conan cache restore conan_cache_save.tgz
Restore: pkg/1.0 in p/pkg1df6df1a3b33c
Restore: pkg/1.0:9a4eb3c8701508aa9458b1a73d0633783ecc2270 in p/b/pkg773791b8c97aa/p
Restore: pkg/1.0:9a4eb3c8701508aa9458b1a73d0633783ecc2270 metadata in p/b/pkg773791b8c97aa/d/metadata
...
如果包在缓存中已存在,恢复过程将覆盖现有包。
注意
最佳实践
保存和恢复包不能替代将包正确存储(上传)到 Conan 服务器仓库中。它仅旨在作为一种临时机制,例如在 CI 系统中,用于离线保存等,而不是作为长期存储和检索的手段。
保存和恢复包不能替代服务器仓库的正确备份。推荐的实现 Conan 包长期备份的方法是使用某种服务器端备份策略。
目前,存储格式和序列化不保证是面向未来且稳定的。它预计在同一 Conan 版本中可以正常工作,但未来的 Conan 版本可能会破坏用先前版本创建的存储格式。(这与上面不将其用作备份策略的建议相符)