本地 Recipes 索引仓库

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

  • 允许贡献者与社区共享软件包 recipe,特别是对于可能不适合 ConanCenter 的库。

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

设置

要设置本地 recipes 索引仓库以共享您自己的 recipe,您需要以模仿 conan-center-index 的方式组织您的 recipe 的文件夹结构。 首先,您可以将 local_recipes_index 模板用于 conan new 命令。 为了演示目的,让我们使用 conan new 命令的 local_recipes_index 模板,为假设的 hello 库创建一个 local-recipes-index 仓库,该库的许可证与 Conan Center 不兼容

$ 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