conan lock merge

$ conan lock merge -h
usage: conan lock merge [-h] [--out-file OUT_FILE]
                        [-v [{quiet,error,warning,notice,status,verbose,debug,v,trace,vv}]]
                        [-cc CORE_CONF] [--lockfile LOCKFILE]
                        [--lockfile-out LOCKFILE_OUT]

Merge 2 or more lockfiles.

options:
  -h, --help            show this help message and exit
  --out-file OUT_FILE   Write the output of the command to the specified file
                        instead of stdout.
  -v [{quiet,error,warning,notice,status,verbose,debug,v,trace,vv}]
                        Level of detail of the output. Valid options from less
                        verbose to more verbose: -vquiet, -verror, -vwarning,
                        -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
                        -vvv or -vtrace
  -cc CORE_CONF, --core-conf CORE_CONF
                        Define core configuration, overwriting global.conf
                        values. E.g.: -cc core:non_interactive=True
  --lockfile LOCKFILE   Path to lockfile to be merged
  --lockfile-out LOCKFILE_OUT
                        Filename of the created lockfile

conan lock merge 命令接收 2 个或更多 lockfile 并将它们聚合,生成一个最终的 lockfile。例如,如果我们有 2 个 lockfile lock1.locklock2.lock,我们可以将两者合并到一个最终的 conan.lock 文件中

# we have 2 lockfiles lock1.lock and lock2.lock
$ conan lock add --requires=pkg/1.1 --lockfile-out=lock1.lock
$ cat lock1.lock
{
    "version": "0.5",
    "requires": [
        "pkg/1.1",
    ],
    "build_requires": [],
    "python_requires": []
}

$ conan lock add --requires=other/2.1 --build-requires=tool/3.2 --lockfile-out=lock2.lock
$ cat lock2.lock
{
    "version": "0.5",
    "requires": [
        "other/2.1"
    ],
    "build_requires": [
        "tool/3.2"
    ],
    "python_requires": []
}

# we can merge both
$ conan lock merge --lockfile=lock1.lock --lockfile=lock2.lock
$ cat conan.lock
{
    "version": "0.5",
    "requires": [
        "pkg/1.1",
        "other/2.1"
    ],
    "build_requires": [
        "tool/3.2"
    ],
    "python_requires": []
}

conan lock add 命令类似,conan lock merge

  • 会保持版本列表的严格排序

  • 它不会执行任何验证,以检查包或版本是否存在,或者它们是否属于给定的依赖关系图

  • 它只是对 json 文件进行基本处理,并将它们聚合在一起。

  • 它不能保证 lockfile 会是完整的,可能需要 --lockfile-partial 参数才能完成

  • 如果定义了 recipe 修订版,则必须包含时间戳才能正确排序。

警告

  • 禁止手动操作 Conan lockfile,更改引用的严格排序,这可能会导致任何任意未定义行为。

  • 请记住,无法 conan lock add 版本范围。版本可能不完全完整(例如,未提供修订版),但必须是确切的版本。

另请参阅

为了更好地理解 conan lock merge,建议先了解 lockfile 的一般概念,请访问 lockfiles 教程,以获得 lockfile 的实践介绍。

conan lock merge 命令可用于在某些原因导致多个 lockfile 发生分歧时,将它们合并到一个 lockfile 中。一个用例是创建一个多配置 lockfile,其中包含所有操作系统(Linux、Windows 等)所需的锁定版本,即使不同操作系统之间存在条件依赖项。例如,在测试新的依赖项版本 pkg/3.4 时,而之前 pkg/3.3 已经存在于图中,我们可能希望拥有这样一个清理了之前 pkg/3.3 的新 lockfile。如果应用 --lockfile-clean 参数,它将删除 lockfile 中未使用的版本,但也会删除操作系统相关的依赖项。因此,可以这样做:假设我们有这个 lockfile(简化,为了简单起见删除了修订版)作为测试新版本 pkgb/0.2 的结果,用于我们的主产品 app1/0.1

app.lock
{
  "version": "0.5",
  "requires": [
      "pkgb/0.2",
      "pkgb/0.1",
      "pkgawin/0.1",
      "pkganix/0.1",
      "app1/0.1"
  ]
}

pkgawinpkganix 是仅在 Windows 和 Linux 中存在的依赖项。一切看起来都很好,pkgb/0.2 新版本与我们的应用程序配合良好,我们希望清理 lockfile 中未使用的内容

$ conan lock create --requires=app1/0.1 --lockfile=app.lock --lockfile-out=win.lock -s os=Windows --lockfile-clean
# Note how both pkgb/0.1 and pkganix are gone
$ cat win.lock
{
  "version": "0.5",
  "requires": [
      "pkgb/0.2",
      "pkgawin/0.1",
      "app1/0.1"
  ]
}
$ conan lock create --requires=app1/0.1 --lockfile=app.lock --lockfile-out=nix.lock -s os=Linux --lockfile-clean
# Note how both pkgb/0.1 and pkgawin are gone
$ cat win.lock
{
  "version": "0.5",
  "requires": [
      "pkgb/0.2",
      "pkganix/0.1",
      "app1/0.1"
  ]
}
  # Finally, merge the 2 clean lockfiles, for keeping just 1 for next iteration
$ conan lock merge --lockfile=win.lock --lockfile=nix.lock --lockfile-out=final.lock
$ cat final.lock
{
  "version": "0.5",
  "requires": [
      "pkgb/0.2",
      "pkgawin/0.1",
      "pkganix/0.1",
      "app1/0.1"
  ]
}