GitHub¶
警告
此功能是实验性的，可能会有重大更改。有关更多信息，请参阅Conan 稳定性部分。
Conan GitHub Actions 集成允许您以简单有效的方式在 GitHub Actions 工作流中设置 Conan 客户端。
该项目可在其GitHub marketplace 页面或直接在其GitHub 源代码页面找到。
要使用此集成，请在您的工作流 YAML 文件中添加一个步骤。此集成将安装 Conan 客户端并为您设置环境。
您可以自定义以下参数
Conan 版本：指定要安装的 Conan 版本（例如，2.15.1）。默认值：最新稳定版。
配置 URL：一个配置 URL 列表，用于下载并安装到 Conan 主目录。默认情况下，不安装任何配置。
Conan 审计令牌：用于审计命令扫描包中漏洞的审计令牌。默认情况下，不使用令牌。
Conan 主目录路径：为 Conan 主文件夹设置自定义位置。默认情况下，不使用自定义路径。
缓存 Conan 包：自动缓存 Conan 缓存中的所有包，并在下次构建时重用。默认情况下，不使用缓存。
Python 版本：您可以指定随 Conan 安装的 Python 版本，该版本将在环境中可用。默认情况下，安装 Python 3.10。
此集成适用于 GitHub Actions 支持的所有平台，包括 Linux、Windows 和 macOS。
示例¶
本节提供了一些关于如何在 GitHub Actions 工作流中使用此集成的示例。
在每夜构建中扫描包漏洞¶
警告
请勿共享您的 Conan 审计令牌或在代码中暴露它。始终使用 GitHub secrets 来存储敏感数据。
首先，您需要在您的GitHub secrets中设置 Conan 审计令牌。然后，使用以下示例扫描包及其依赖项中的漏洞
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 服务器。
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
在此示例中，action 的选项 cache_packages 设置为 true，因此 Conan 缓存中的所有包都将被缓存以供下一次构建。远程信息预计来自由选项 config_urls 指向的 URL 安装的配置。远程身份验证使用 GitHub secrets 以确保安全。远程身份验证通过 GitHub secrets 完成，这是一种存储敏感信息的安全方式。