GitHub

警告

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

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

该项目可以在其 GitHub Marketplace 页面上找到，或者直接在其 GitHub 源码页面上找到。

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

您可以自定义以下参数：

• Conan 版本：指定要安装的 Conan 版本（例如 2.15.1）。默认值：最新稳定版。

• 配置 URL：要下载并安装到 Conan 主目录的配置 URL 列表。默认情况下，不安装任何配置。

• Conan Audit Token：用于 audit 命令扫描包中漏洞的 audit 令牌。默认情况下，不使用任何令牌。

• Conan 主目录路径：为 Conan 主文件夹设置自定义位置。默认情况下，不使用自定义路径。

• 缓存 Conan 包：自动将所有包缓存到 Conan 缓存中，并在下次构建时重新使用它们。默认情况下，不使用缓存。

• Python 版本：您可以指定要与 Conan 一起安装的 Python 版本，该版本也将在环境中可用。默认情况下，安装 Python 3.10。

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

示例

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

夜间构建中扫描包的漏洞

警告

请勿分享您的 Conan audit token 或在代码中暴露它。始终为敏感数据使用 GitHub Secrets。

首先，您需要在您的 GitHub Secrets 中设置 Conan audit token。然后，使用以下示例扫描包及其依赖项中的漏洞：

.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 完成，这是一种安全存储敏感信息的方式。