本地食谱索引库¶
local_recipes_index 仓库是一种实验性特殊类型的仓库,您无法向其中上传软件包或存储二进制文件。此远程仓库的目的是
方便贡献者与社区共享软件包食谱,尤其是那些可能不适合 ConanCenter 的库。
简化从私有 conan-center-index 分支构建二进制文件的过程,允许对食谱进行绝对控制、自定义,并维护稳定的仓库快照。这确保了对 ConanCenter 上游更改的鲁棒性。有关详细设置和使用说明,请参阅 Conan DevOps 指南中专门的 本地食谱索引库 部分。
设置¶
要设置本地食谱索引库以共享您自己的食谱,您需要将食谱组织成模仿 conan-center-index 的文件夹结构。首先,您可以使用 conan new 命令的 local_recipes_index 模板。为了演示目的,让我们为假设的 hello 库(其许可证与 Conan Center 不兼容)创建一个 local-recipes-index 仓库,使用 conan new 命令的 local_recipes_index 模板。
$ mkdir repo && cd repo
$ conan new local_recipes_index -d name=hello -d version=0.1 \
-d url=https://github.com/conan-io/libhello/archive/refs/tags/0.0.1.zip \
-d sha256=1dfb66cfd1e2fb7640c88cc4798fe25853a51b628ed9372ffc0ca285fe5be16b
$ cd ..
conan new local_recipes_index 命令会创建一个模板,该模板假定 CMake 作为构建系统,并包含其他一些重要的假设。实际上,它需要进一步的定制,但对于此演示而言,它可以按原样工作。它将创建一个与 conan-center-index GitHub 仓库相同的文件夹布局。
.
└── repo
└── recipes
└── hello
├── all
│ ├── conandata.yml
│ ├── conanfile.py
│ └── test_package
│ ├── CMakeLists.txt
│ ├── conanfile.py
│ └── src
│ └── example.cpp
└── config.yml
设置好仓库后,我们将其作为本地远程仓库添加到 Conan。
$ conan remote add mylocalrepo ./repo --allowed-packages="hello/*"
请特别注意 --allowed-packages 参数。此参数确保除 hello 之外的所有软件包都将被 Conan 丢弃。这可用于最大程度地减少潜在供应链攻击的受攻击面。
现在,您可以从这个新仓库列出和安装软件包。
$ conan list "*" -r=mylocalrepo
$ conan install --requires=hello/0.1 -r=mylocalrepo --build=missing
此时,您可以将此仓库推送到您的 GitHub 账户并与社区共享。用户只需克隆 GitHub 仓库,然后将克隆的文件夹作为本地仓库添加即可。
注意
请注意,正如我们之前评论的那样,此功能专门针对某些库不适合 ConanCenter 的情况。请记住,“本地食谱索引库”有其局限性:它不可完全复现,因为它只建模版本而不建模修订,并且不提供二进制文件。因此,在这些情况之外,建议使用远程软件包服务器,例如 Artifactory。
另请参阅