本地配方索引仓库¶
local_recipes_index 仓库是一种**实验性**的特殊仓库类型,您无法上传包或存储二进制文件。此远程仓库的目的是
使贡献者能够与社区分享包配方,特别是对于可能不适合 ConanCenter 的库。
简化从私有 conan-center-index 分支构建二进制文件的过程,从而实现对配方的绝对控制、自定义以及维护稳定的仓库快照。这确保了对抗 ConanCenter 上游变化的健壮性。有关详细设置和使用说明,请参阅 Conan DevOps 指南中的专用部分 本地配方索引仓库。
设置¶
要设置本地配方索引仓库来分享您自己的配方,您需要以模仿 conan-center-index 的文件夹结构来组织您的配方。首先,您可以使用 conan new 命令的 local_recipes_index 模板。为了演示目的,让我们使用 conan new 命令的 local_recipes_index 模板,为一个假设的 hello 库创建一个与 Conan Center 许可证不兼容的 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 的场景。请记住,“local-recipes-index”仓库有局限性:它不完全可重现,因为它只建模版本而不建模修订版,并且不提供二进制文件。因此,在这些情况之外,建议使用远程包服务器,例如 Artifactory。
另请参阅