GitHub¶

警告

此功能是实验性的，可能会发生破坏性更改。有关更多信息，请参阅Conan 稳定性部分。

Conan GitHub Actions 集成允许您以简单有效的方式在 GitHub Actions 工作流程中设置 Conan 客户端。

该项目可以在其GitHub marketplace 页面或直接在其GitHub 源代码页面上找到。

要使用此集成，请在您的工作流程 YAML 文件中添加一个步骤。该集成将为您安装 Conan 客户端并设置环境。

您可以自定义以下参数

Conan 版本：指定要安装的 Conan 版本（例如，2.15.1）。默认值：最新的稳定版本。
配置 URLs：要在 Conan home 中下载和安装的配置 URL 列表。默认情况下，不安装任何配置。
Conan Audit Token：用于审计命令以扫描软件包中漏洞的审计令牌。默认情况下不使用令牌。
Conan home 路径：设置 Conan home 文件夹的自定义位置。默认情况下不使用自定义路径。
缓存 Conan 软件包：自动缓存 Conan 缓存中的所有软件包，并在下次构建中重复使用它们。默认情况下不使用缓存。
Python 版本：您可以指定随 Conan 一起安装的 Python 版本，该版本将在环境中可用。默认情况下安装 Python 3.10。

此集成适用于 GitHub Actions 支持的所有平台，包括 Linux、Windows 和 macOS。

示例¶

本节提供了一些如何在 GitHub Actions 工作流程中使用此集成的示例。

在夜间构建中扫描软件包漏洞¶

警告

请勿共享您的 Conan 审计令牌或在您的代码中暴露它。始终使用 GitHub secrets 来处理敏感数据。

首先，您需要在您的GitHub secrets中设置 Conan 审计令牌。然后，使用以下示例扫描软件包及其依赖项中的漏洞

.github/workflows/ci.yml¶

name: Nightly security scan
on:
  schedule:
    - cron: "0 0 * * *"

jobs:
  scan-vulnerabilities:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Install and setup Conan
        uses: conan-io/setup-conan@v1
        with:
          audit_token: ${{ secrets.MY_CONAN_AUDIT_TOKEN }}

      - name: Scan for vulnerabilities with Conan Audit
        run: |
          conan audit scan .

此示例扫描当前目录中 conanfile.py 的所有依赖项。请注意，它使用 GitHub schedule 在每天午夜运行扫描，这是在使用免费服务令牌的情况下，以避免达到每日限制，但仍然每天进行安全检查。

安装 Conan 配置和构建软件包¶

此示例从 URL 安装自定义 Conan 配置，恢复先前构建中的缓存软件包，构建 conanfile.py 中定义的软件包，并将其上传到 Conan 服务器。

.github/workflows/ci.yml¶

name: Build and upload Conan package
on:
  push:
    branches:
      - 'main'

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Install and setup Conan
        uses: conan-io/setup-conan@v1
        with:
          config_urls: https://mycompany.com/conan/configs.git
          cache_packages: true

      - name: Build and upload package
        run: |
          conan create . -pr:a myprofile --build=missing
          conan remote login artifactory developer -p ${{ secrets.MY_CONAN_PASSWORD }}
          conan upload "*" --confirm --remote artifactory

在此示例中，操作的选项 cache_packages 设置为 true，因此 Conan 缓存中的所有软件包都会被缓存以用于下次构建。远程信息预计来自选项 config_urls 指向的 URL 安装的配置。远程身份验证使用 GitHub secrets 进行安全存储。远程身份验证是通过使用 GitHub secrets 完成的，这是一种存储敏感信息的安全方式。