使用包列表

警告

此功能处于实验阶段,可能存在重大更改。有关更多信息,请参阅 Conan 稳定性 部分。

包列表是 Conan 的一项强大且便捷的功能,允许自动化和连接不同的 Conan 命令。让我们看看一些常见的用例。

列出包并下载它们

第一个简单的用例可能是列出服务器中的一些食谱和/或二进制文件,然后下载它们。

我们可以执行任何 conan list 命令,例如,列出所有版本高于 1.2.11zlib,最新的食谱版本,所有该最新食谱版本的 Windows 二进制文件,以及每个二进制文件的最新包版本。请注意,如果我们稍后要实际下载某些内容,则必须指定 latest 包版本,否则只会下载食谱。

$ conan list "zlib/[>1.2.11]#latest:*#latest" -p os=Windows --format=json -r=conancenter > pkglist.json

命令的输出以 json 格式发送到 pkglist.json 文件,其格式如下所示:

pkglist.json(简化)
"conancenter": {
    "zlib/1.2.12": {
        "revisions": {
            "b1fd071d8a2234a488b3ff74a3526f81": {
                "timestamp": 1667396813.987,
                "packages": {
                    "ae9eaf478e918e6470fe64a4d8d4d9552b0b3606": {
                        "revisions": {
                            "19808a47de859c2408ffcf8e5df1fdaf": {
                            }
                        },
                        "info": {
                            "settings": {
                                "arch": "x86_64",
                                "os": "Windows"
                            }
                        }
                    }
                }
            }
        },
    "zlib/1.2.13": {
    }
}

pkglist.json 中的第一级是“源”远程或“本地缓存”(如果列表位于缓存中)。在本例中,因为我们在 conancenter 远程中列出了包,所以该远程将是源。

我们现在可以使用单个 conan download 调用下载这些食谱和二进制文件。

$ conan download --list=pkglist.json -r=conancenter
# Download the recipes and binaries in pkglist.json
# And displays a report of the downloaded things

从一个远程下载并上传到另一个远程

假设我们从上一步下载的包创建一个新的包列表。

$ conan download --list=pkglist.json -r=conancenter --format=json > downloaded.json
# Download the recipes and binaries in pkglist.json
# And stores the result in "downloaded.json"

生成的 downloaded.json 将与 pkglist.json 文件几乎相同,但在此情况下,这些包的“源”是 "Local Cache"(因为下载的包将位于缓存中)。

downloaded.json(简化)
"Local Cache": {
        "zlib/1.2.12": {
            "revisions": {
            }
        }
    }

这意味着我们现在可以将这同一组食谱和二进制文件上传到另一个远程。

$ conan upload --list=downloaded.json -r=myremote -c
# Upload those artifacts to the same remote

注意

最佳实践

这将是运行不同服务器存储库之间升级的缓慢机制。像 Artifactory 这样的服务器提供了一种方法,可以直接将包从一个存储库复制到另一个存储库,而无需使用客户端,这由于文件重复数据删除而快得多,因此这将是推荐的方法。本节中介绍的方法可用于隔离环境和其他无法进行服务器到服务器复制的情况。

构建和上传包

最有趣的流程之一是使用 conan createconan install --build=xxx 命令在本地缓存中构建一些包的流程。通常,我们希望将本地构建的包上传到服务器,以便其他人无需再次构建它们。但我们可能只想上传构建的二进制文件,而不是所有其他传递依赖项或我们之前在本地缓存中的其他包。

可以根据 conan installconan createconan graph info 命令的输出计算包列表。然后,该包列表可用于上传。分步操作如下:

首先假设我们有自己的包 mypkg/0.1 并创建它。

$ conan new cmake_lib -d name=mypkg -d version=0.1
$ conan create . --format=json > create.json

这将创建一个图形的 JSON 表示形式,其中包含已构建包的信息 "binary": "Build"

create.json(简化)
{
"graph": {
    "nodes": {
        "0": {
            "ref": "conanfile",
            "id": "0",
            "recipe": "Cli",
            "context": "host",
            "test": false
        },
        "1": {
            "ref": "mypkg/0.1#f57cc9a1824f47af2f52df0dbdd440f6",
            "id": "1",
            "recipe": "Cache",
            "package_id": "2401fa1d188d289bb25c37cfa3317e13e377a351",
            "prev": "75f44d989175c05bc4be2399edc63091",
            "build_id": null,
            "binary": "Build"
        }
    }
}

我们可以从此文件中计算出包列表,然后使用以下命令将这些工件上传到服务器:

$ conan list --graph=create.json --graph-binaries=build --format=json > pkglist.json
# Create a pkglist.json with the known list of recipes and binaries built from sources
$ conan upload --list=pkglist.json -r=myremote -c

删除包列表

也可以先 conan list 并创建要删除的内容列表,然后删除它们。

# Removes everything from the cache
$ conan list "*#*" --format=json > pkglist.json
$ conan remove --list=pkglist.json  -c

请注意,在本例中,listremove 中的默认模式不同,因为 conan remove 的性质具有破坏性。

  • 当将食谱传递给 remove(如 conan remove zlib/1.2.13)时,它将删除 zlib/1.2.13 的食谱及其所有二进制文件,因为二进制文件无法在没有食谱的情况下存在。

  • 当传递 package_id(如 conan remove zlib/1.2.13:package_id)时,则将删除该特定的 package_id,但不会删除食谱。

然后,如果我们直接调用 conan remove 或如果我们先调用 conan list,则删除所有内容的模式将不同,例如:

# Removes everything from the cache
$ conan remove "*"
# OR via list, we need to explicitly include all revisions
$ conan list "*#*" --format=json > pkglist.json
$ conan remove --list=pkglist.json  -c

# Removes only the binaries from the cache (leave recipes)
$ conan remove "*:*"
# OR via list, we need to explicitly include all revisions
$ conan list "*#*:*" --format=json > pkglist.json
$ conan remove --list=pkglist.json  -c

有关更多信息,请参阅 参考命令部分