如何使用GitHub动作来获得总的综合覆盖率

这是一个关于如何使用GitHub动作来获得总的综合覆盖率，并为你的README创建一个徽章的草图。也有其他方法，但这是用一些常用的工具来完成工作。

我们将使用 tox 来运行测试，并使用 GitHub 动作来运行 tox。 一个GitHub gist将被用作scratch文件来存储徽章的参数，徽章将由shields.io呈现。

从 tox.ini 开始，它运行你的测试套件，还包括一个 "覆盖率 "环境，它结合、报告并产生一个 JSON 数据文件。

tox.ini

[tox]
envlist = py37,py38,py39,py310,coverage

[testenv]
commands =
    python -m coverage run -p -m pytest

[testenv:coverage]
basepython = python3.10
commands =
    python -m coverage combine
    python -m coverage report -m --skip-covered
    python -m coverage json

[gh-actions]
python =
    3.7: py37
    3.8: py38
    3.9: py39
    3.10: py310

我们将使用GitHub动作来运行tox，但在这之前，我们需要两个比特的基础设施。 去gist.github.com，做一个空的秘密gist。 复制该gist的id。 这里我们称之为123abc456def789。

接下来，我们将创建一个个人访问令牌，用于更新该gist。 去你的GitHub个人访问令牌页面，点击 "生成新令牌"。 选择 "gist "范围，点击 "生成令牌"。 复制显示的值，它看起来像 "ghp_FSfkCeFblahblah"。你不能再得到这个值了，所以要小心对待它。

在 GitHub 上的 repo 中，进入设置 - 秘密 - 操作，点击 "新建仓库秘密"。 使用 "GIST_TOKEN "作为名称，并粘贴 ghp_etc 标记作为秘密，然后 "添加秘密"。

现在我们准备创建GitHub动作。 它将在许多版本的Python上运行测试套件，然后运行覆盖步骤来合并所有的数据文件。 它使用JSON报告来提取可显示的百分比，然后使用第三方GitHub动作在Gist中创建JSON数据，以便shields.io可以显示徽章。

徽章是自动着色的。50%或更低是红色，90%或更高是绿色，两者之间有一个梯度，像这样:

作为奖励，还有一个带有覆盖率的行动工作总结。这里是工作流程文件。

.github/workflows/tests.yaml

# Run tests

name: "Test Suite"

on:
  push:
  pull_request:

defaults:
  run:
    shell: bash

jobs:
  tests:
    name: "Python ${{ matrix.python-version }} on ${{ matrix.os }}"
    runs-on: "${{ matrix.os }}"

    strategy:
      fail-fast: false
      matrix:
        os:
          - ubuntu-latest
          - macos-latest
          - windows-latest
        python-version:
          - "3.7"
          - "3.8"
          - "3.9"
          - "3.10"

    steps:
      - name: "Check out the repo"
        uses: "actions/checkout@v2"

      - name: "Set up Python"
        uses: "actions/setup-python@v2"
        with:
          python-version: "${{ matrix.python-version }}"

      - name: "Install dependencies"
        run: |
          python -m pip install tox tox-gh-actions

      - name: "Run tox for ${{ matrix.python-version }}"
        run: |
          python -m tox

      - name: "Upload coverage data"
        uses: actions/upload-artifact@v3
        with:
          name: covdata
          path: .coverage.*

  coverage:
    name: Coverage
    needs: tests
    runs-on: ubuntu-latest
    steps:
      - name: "Check out the repo"
        uses: "actions/checkout@v2"

      - name: "Set up Python"
        uses: "actions/setup-python@v2"
        with:
          python-version: "3.10"

      - name: "Install dependencies"
        run: |
          python -m pip install tox tox-gh-actions

      - name: "Download coverage data"
        uses: actions/download-artifact@v3
        with:
          name: covdata

      - name: "Combine"
        run: |
          python -m tox -e coverage
          export TOTAL=$(python -c "import json;print(json.load(open('coverage.json'))['totals']['percent_covered_display'])")
          echo "total=$TOTAL" >> $GITHUB_ENV
          echo "### Total coverage: ${TOTAL}%" >> $GITHUB_STEP_SUMMARY

      - name: "Make badge"
        uses: schneegans/dynamic-badges-action@v1.4.0
        with:
          # GIST_TOKEN is a GitHub personal access token with scope "gist".
          auth: ${{ secrets.GIST_TOKEN }}
          gistID: 123abc456def789   # replace with your real Gist id.
          filename: covbadge.json
          label: Coverage
          message: ${{ env.total }}%
          minColorRange: 50
          maxColorRange: 90
          valColorRange: ${{ env.total }}

现在，徽章可以用这样的URL显示，但要用你的GitHub名称替换YOUR_GITHUB_NAME，用你真正的Gist ID替换123abc456def789。

https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/YOUR_GITHUB_NAME/123abc456def789/raw/covbadge.json

关于如何使用图片URL来显示徽章，请参考你选择的标记语言的文档。