捕获 Git SCM 信息

在 recipe 中处理源码主要有两种策略

  • 第三方代码：当 conanfile.py recipe 打包第三方代码（例如一个开源库）时，通常最好使用 source() 方法来下载或克隆该库的源码。ConanCenter 的 conan-center-index 仓库就遵循这种方法。

  • 自己的代码：当 conanfile.py recipe 打包你自己的代码时，通常最好将 conanfile.py 放在与源码相同的仓库中。然后，有两种实现可重现性的方法

    • 使用 exports_sources（或 export_source() 方法）将源码的副本与 recipe 一起捕获到 Conan 包中。这非常简单实用，推荐用于大多数情况。

    • 对于无法将源码与 Conan recipe 存储在一起的情况，例如当包要供不应拥有源码访问权限的人使用时，当前的 scm 捕获 方法将是可行之道。

在 scm 捕获 方法中，不是捕获代码本身的副本，而是捕获该代码的“坐标”。对于 Git，捕获的是仓库的 url 和 commit。如果 recipe 需要从源码构建，它将使用这些信息进行克隆；如果尝试此操作的用户未获得授权，该过程将失败。他们仍然可以使用我们分发的预编译二进制文件，但不能从源码构建或访问代码。

我们通过一个示例来看看它是如何工作的。请首先克隆源码以重现此项目。你可以在 GitHub 的 examples2 仓库中找到它们。

$ git clone https://github.com/conan-io/examples2.git
$ cd examples2/examples/tools/scm/git/capture_scm

在该仓库中，我们将找到一个小型的“hello”项目，其中包含以下 conanfile.py

from conan import ConanFile
from conan.tools.cmake import CMake, cmake_layout
from conan.tools.scm import Git


class helloRecipe(ConanFile):
    name = "hello"
    version = "0.1"

    # Binary configuration
    settings = "os", "compiler", "build_type", "arch"
    options = {"shared": [True, False], "fPIC": [True, False]}
    default_options = {"shared": False, "fPIC": True}
    generators = "CMakeDeps", "CMakeToolchain"

    def export(self):
        git = Git(self, self.recipe_folder)
        # save the url and commit in conandata.yml
        git.coordinates_to_conandata()

    def source(self):
        # we recover the saved url and commit from conandata.yml and use them to get sources
        git = Git(self)
        git.checkout_from_conandata_coordinates()

    ...

我们需要将此代码放在自己的 Git 仓库中，以便在实际案例中查看它是如何工作的，因此请在 examples2 仓库之外创建一个文件夹，并将当前文件夹的内容复制到那里，然后

$ mkdir /home/myuser/myfolder # or equivalent in other OS
$ cp -R . /home/myuser/myfolder # or equivalent in other OS
$ cd /home/myuser/myfolder # or equivalent in other OS

# Initialize the git repo
$ git init .
$ git add .
$ git commit . -m wip
# Finally create the package
$ conan create .
...
======== Exporting recipe to the cache ========
hello/0.1: Exporting package recipe: /myfolder/conanfile.py
hello/0.1: Calling export()
hello/0.1: RUN: git status . --short --no-branch --untracked-files
hello/0.1: RUN: git rev-list HEAD -n 1 --full-history -- "."
hello/0.1: RUN: git remote -v
hello/0.1: RUN: git branch -r --contains cb7815a58529130b49da952362ce8b28117dee53
hello/0.1: RUN: git fetch origin --dry-run --depth=1 cb7815a58529130b49da952362ce8b28117dee53
hello/0.1: WARN: Current commit cb7815a58529130b49da952362ce8b28117dee53 doesn't exist in remote origin
This revision will not be buildable in other computer
hello/0.1: RUN: git rev-parse --show-toplevel
hello/0.1: Copied 1 '.py' file: conanfile.py
hello/0.1: Copied 1 '.yml' file: conandata.yml
hello/0.1: Exported to cache folder: /.conan2/p/hello237d6f9f65bba/e
...
======== Installing packages ========
hello/0.1: Calling source() in /.conan2/p/hello237d6f9f65bba/s
hello/0.1: Cloning git repo
hello/0.1: RUN: git clone "<hidden>"  "."
hello/0.1: Checkout: cb7815a58529130b49da952362ce8b28117dee53
hello/0.1: RUN: git checkout cb7815a58529130b49da952362ce8b28117dee53

让我们一步步解释正在发生的事情

  • 当 recipe 被导出到 Conan 缓存时，export() 方法执行 git.coordinates_to_conandata()，它通过内部调用 git.get_url_and_commit() 将 Git URL 和 commit 存储在 conandata.yml 文件中。有关这些方法的更多信息，请参阅Git 参考。

  • 这获取了指向本地 <local-path>/capture_scm 的仓库 URL 和 commit 8e8764c40bebabbe3ec57f9a0816a2c8e691f559

  • 它警告说，一旦包上传到服务器并在另一台不包含 <local-path>/capture_scm 所指向路径的计算机上尝试从源码构建时，这些信息将不足以重新构建此 recipe。这是预期的，因为我们创建的仓库没有定义任何 remote。如果我们的本地克隆定义了一个 remote，并且该 remote 包含了我们正在构建的 commit，那么 scm_url 将指向 remote 仓库，从而使从源码构建完全可重现。

  • export() 方法将 url 和 commit 信息存储在 conandata.yml 中，以备将来重现。

  • 当需要从源码构建包并调用 source() 方法时，它会在 git.checkout_from_conandata_coordinates() 方法内部从 conandata.yml 文件中恢复信息，该方法内部调用 git.clone() 以检索源码。在这种情况下，它将从 <local-path>/capture_scm 中的本地 checkout 进行克隆，但如果定义了 remote，它将从 remote 进行克隆。

警告

为了实现可重现性，对于这种 scm 捕获 技术来说，当前 checkout 必须不是脏的。如果它是脏的，将无法保证构建的未来可重现性，因此 git.get_url_and_commit() 可能会引发错误，并要求提交更改。如果需要多个 commit，建议在将更改推送到上游仓库之前进行 squash。

如果现在执行第二次 conan create .，由于仓库是脏的，我们会得到

$ conan create .
hello/0.1: Calling export()
ERROR: hello/0.1: Error in export() method, line 19
    scm_url, scm_commit = git.get_url_and_commit()
    ConanException: Repo is dirty, cannot capture url and commit: .../capture_scm

这可以通过使用 git clean -xdf 清理仓库来解决，或者通过在仓库中添加一个包含以下内容的 .gitignore 文件（无论如何这可能是一种良好的源码控制实践）

.gitignore
test_package/build
test_package/CMakeUserPresets.json

坐标捕获使用 Git.get_url_and_commit() 方法，默认情况下会

  • 如果仓库是脏的，它将引发异常

  • 如果仓库不是脏的，但 commit 在 remote 中不存在，它将发出警告，但将返回本地文件夹作为仓库 url。这样，可以在不需要将本地 commit 推送到服务器的情况下进行测试。core.scm:local_url=allow 可以静默警告，而 core.scm:local_url=block 将立即引发错误：后一个值对于 CI 场景非常有用，可以快速失败，并避免稍后在 conan upload 中被阻止的构建。

  • 如果尝试使用 conan upload 将使用本地 commit 构建的包上传到服务器，将失败，因为这些本地 commit 不在服务器上，因此包可能不可重现。可以通过设置 core.scm:local_url=allow 来避免此上传错误。

  • 如果仓库不是脏的，并且 commit 在服务器中存在，它将返回 remote URL 和 commit。

凭据管理

在上面的示例中，不需要凭据，因为我们的本地仓库不需要它们。但在实际场景中，可能需要凭据。

首先重要的一点是，git.get_url_and_commit() 将捕获 origin remote 的 url。此 url 不应编码令牌、用户或密码，原因有很多。首先，这将导致过程不可重复，不同的构建、不同的用户将获得不同的 url，从而导致不同的 recipe 修订版本。url 应始终相同。推荐的方法是采用正交方式管理凭据，例如使用 ssh 密钥。提供的示例包含一个执行此操作的 Github action

.github/workflows/hello-demo.yml
name: Build "hello" package capturing SCM in Github actions
run-name: ${{ github.actor }} checking hello-ci Git scm capture
on: [push]
jobs:
Build:
    runs-on: ubuntu-latest
    steps:
    - name: Check out repository code
        uses: actions/checkout@v3
        with:
        ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
    - uses: actions/setup-python@v4
        with:
        python-version: '3.10'
    - uses: webfactory/ssh-agent@v0.7.0
        with:
        ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}
    - run: pip install conan
    - run: conan profile detect
    - run: conan create .

此 hello-demo.yml 处理以下事项

  • checkout actions/checkout@v3 action 接收 ssh-key 以 git@ 而不是 https 方式 checkout

  • webfactory/ssh-agent@v0.7.0 action 确保 ssh key 在后续任务执行期间也处于激活状态，而不仅仅是在 checkout 期间。

  • 需要在 Github 界面中设置 SSH_PRIVATE_KEY secret，以及为仓库设置 deploy key（包含 ssh-key 的私钥和公钥部分）

通过这种方式，可以将身份验证和凭据与 recipe 功能完全分开，没有任何泄露凭据的风险。

注意

最佳实践

  • 不要使用在 url 中编码信息的身份验证机制。这有风险，很容易在日志中泄露凭据。建议使用系统机制，如 ssh 密钥。

  • 对于本地开发，不建议执行 conan create，而是运行 conan install 并在本地构建，以避免过多不必要的 commit。只有当一切都在本地正常工作后，才开始检查 conan create 流程。