Codecov GitHub Action

轻松从GitHub Actions上传覆盖率报告到Codecov

v4 版本发布

Codecov GitHub Action的v4版本将使用Codecov CLI来上传覆盖率报告到Codecov。

重大变更

• 不支持无token上传。但是，从分支向上游公共仓库提交的PR将支持无token上传（例如，开源项目的贡献者不需要上游仓库的Codecov token）。详情请参阅我们的文档
• 移除了Action的多个参数

Dependabot

• 对于使用Dependabot的仓库，用户需要确保它能访问Codecov token，以便Dependabot的PR能上传覆盖率。为此，请将您的CODECOV_TOKEN添加为Dependabot Secret。更多信息，请参见"为Dependabot配置私有注册表访问权限"

v3及以下版本将无法使用CLI功能（如全局上传token、ATS）。

使用方法

要将Codecov集成到您的Actions流程中，请在workflow.yml文件中将此仓库的名称和标签号（推荐使用@v4）指定为一个step。

此Action还需要您提供来自codecov.io的上传token（提示：为避免暴露您的token，请将其存储为secret）。

目前，此Action可以识别linux、macos和windows运行器。但对于其他架构，Action可能会识别错误。可以指定的操作系统有：

• alpine
• alpine-arm64
• linux
• linux-arm64
• macos
• windows

在您的.github/workflows/workflow.yml文件中：

steps:
- uses: actions/checkout@main
- uses: codecov/codecov-action@v4
  with:
    fail_ci_if_error: true # 可选（默认为false）
    files: ./coverage1.xml,./coverage2.xml # 可选
    flags: unittests # 可选
    name: codecov-umbrella # 可选
    token: ${{ secrets.CODECOV_TOKEN }} # 必需
    verbose: true # 可选（默认为false）

Codecov token也可以通过环境变量传递：

steps:
- uses: actions/checkout@main
- uses: codecov/codecov-action@v4
  with:
    fail_ci_if_error: true # 可选（默认为false）
    files: ./coverage1.xml,./coverage2.xml # 可选
    flags: unittests # 可选
    name: codecov-umbrella # 可选
    verbose: true # 可选（默认为false）
  env:
    CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

[!注意] 这假设您已经在Settings > Secrets中将Codecov token设置为CODECOV_TOKEN。如果没有，您可以在codecov.io上为特定仓库获取上传token。请记住，secrets对仓库的分支是不可用的。

使用OIDC

对于启用了OpenID Connect(OIDC)的用户，不需要Codecov token。您可以使用use_oidc参数来使用OIDC，如下所示：

- uses: codecov/codecov-action@v4
  with:
    use_oidc: true

任何提供的token都将被忽略，因为Codecov将默认使用OIDC token进行验证。

参数

Codecov的Action支持用户输入。这些输入及其描述和使用场景列在下表中：

使用 Codecov Action 的 workflow.yml 示例

name: Codecov 示例工作流
on: [push]
jobs:
  run:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
    env:
      OS: ${{ matrix.os }}
      PYTHON: '3.10'
    steps:
    - uses: actions/checkout@main
    - name: 设置 Python
      uses: actions/setup-python@main
      with:
        python-version: 3.10
    - name: 生成覆盖率报告
      run: |
        pip install pytest
        pip install pytest-cov
        pytest --cov=./ --cov-report=xml
    - name: 上传覆盖率到 Codecov
      uses: codecov/codecov-action@v4
      with:
        directory: ./coverage/reports/
        env_vars: OS,PYTHON
        fail_ci_if_error: true
        files: ./coverage1.xml,./coverage2.xml,!./cache
        flags: unittests
        name: codecov-umbrella
        token: ${{ secrets.CODECOV_TOKEN }}
        verbose: true

贡献

欢迎贡献！请查看贡献指南。

许可证

本项目中的代码根据 MIT 许可证 发布。