本地菜谱索引仓库

local_recipes_index 仓库是一种实验性的特殊类型仓库,您不能向其上传包或存储二进制文件。此远程仓库的目的是:

  • 使贡献者能够与社区共享软件包菜谱,特别是对于可能不适合 ConanCenter 的库。

  • 简化从私有 conan-center-index 分支构建二进制文件的过程,允许对菜谱、自定义拥有绝对控制权,并维护稳定的仓库快照。这确保了对 ConanCenter 上游更改的健壮性。有关详细的设置和使用说明,请参阅 Conan DevOps 指南中专门的部分:本地菜谱索引仓库

设置

要设置本地菜谱索引仓库以共享您自己的菜谱,您需要将菜谱组织成模仿 conan-center-index 的文件夹结构。首先,您可以使用 conan new 命令的 local_recipes_index 模板。为了演示目的,让我们为假设的 hello 库创建一个 local-recipes-index 仓库,该库的许可证与 Conan Center 不兼容,使用 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 参数。此参数确保 Conan 丢弃除 hello 之外的所有包。这可以用于最小化潜在供应链攻击的表面区域。

现在您可以从这个新仓库中列出并安装包:

$ conan list "*" -r=mylocalrepo
$ conan install --requires=hello/0.1 -r=mylocalrepo --build=missing

此时,您可以将此仓库推送到您的 GitHub 帐户并与社区共享。然后用户只需克隆 GitHub 仓库并将克隆的文件夹作为本地仓库添加。

注意

请注意,正如我们之前评论的,此功能专门针对某些库不适合 ConanCenter 的场景。请记住,“local-recipes-index” 仓库有局限性:它不能完全重现,因为它只模拟版本而不模拟修订,并且它不提供二进制文件。因此,在这些情况之外,建议使用远程包服务器,例如 Artifactory