@godaddy-wordpress/circleci-coverage-github-reporter

中文文档
1.0.3发布于 2021/10/20MITCommonJS近 30 天下载 2826

Report Jest/Istanbul coverage statistics from CircleCI to GitHub

原始使用文档
文档目录6 节
  1. Setup
  2. GitHub Auth Token
  3. CircleCI Artifact API Token
  4. Run Jest with Coverage reporting
  5. CircleCI configuration
  6. Customization

circleci-coverage-github-reporter

npm version

Report Jest/Istanbul coverage statistics from CircleCI to GitHub.

Project based on coverage-github-reporter.

Setup

GitHub Auth Token

A GitHub auth token is required to post a comment on github. I recommend creating a separate "bot" GitHub account with access to your repos.

  1. Navigate to Personal access tokens on GitHub
  2. Click "Generate new token" and generate a new token (with repo access if your repo is private)
  3. Open the CircleCI project settings
  4. Navigate to Build Settings > Environment variables
  5. Add a new variable called GH_AUTH_TOKEN with the new token

For subsequent projects:

  1. Open the CircleCI project settings
  2. Navigate to Build Settings > Environment variables
  3. Click "Import Variable(s)"
  4. Select a project that you've previous added GH_AUTH_TOKEN to
  5. Click the checkbox next to GH_AUTH_TOKEN and import

CircleCI Artifact API Token

To access artifacts for private repos, a CircleCI API token is required.

  1. Open the CircleCI project settings
  2. Navigate to Permissions > API Permissions
  3. Click "Create Token"
  • Select "Build Artifacts" from scope dropdown
  • Name the token "artifacts" (or whatever you prefer)
  1. Navigate to Build Settings > Environment variables
  2. Add a new variable called CIRCLE_CI_API_TOKEN with the new token

Run Jest with Coverage reporting

Add to your package.json:

npm install --save-dev @godaddy-wordpress/circleci-coverage-github-reporter

If you're using Jest, I suggest adding a test script along these lines:

    "scripts": {
        "test-ci": "jest --ci --silent --coverage"
    }

This will generate a coverage in coverage/

CircleCI configuration

Update your .circleci/config.yml:

general:
  artifacts:
    - "coverage/lcov-report"

jobs:
  build:
    steps:
      # … other steps (npm/yarn install, lint, etc)

      - run:
          name: Test
          command: npm run test-ci

      # Store coverage artifacts so they can be browsed and be diffed by other builds
      - store_artifacts:
          path: coverage
          destination: coverage

      - run:
          name: Post coverage comment to GitHub
          command: npx circleci-coverage-github-reporter

Customization

The circleci-coverage-github-reporter CLI has some options to customize behavior:

  Options:

    -v, --verbose [true, false]  Defaults to true
    -b, --branch [value]         Base branch to use if not PR (defaults to "master")
    -j, --coverage-json [value]  Relative path to istanbul coverage JSON (defaults to "coverage/coverage-final.json")
    -r, --coverage-root [value]  Relative path to coverage html root (for artifact links) (defaults to "coverage/lcov-report")
    -h, --help                   Output usage information
    -v, --version                Output the version number

版本与发布记录

@godaddy-wordpress/circleci-coverage-github-reporter 共发布 4 个版本,首次发布于 2020/12/09;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.3latest2021/10/205 年前
1.0.22021/10/205 年前
1.0.12021/10/205 年前
1.0.02020/12/095 年前

关于 @godaddy-wordpress/circleci-coverage-github-reporter 的常见问题

@godaddy-wordpress/circleci-coverage-github-reporter 是什么?

Report Jest/Istanbul coverage statistics from CircleCI to GitHub

如何安装 @godaddy-wordpress/circleci-coverage-github-reporter?

在项目目录运行 npm install @godaddy-wordpress/circleci-coverage-github-reporter,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 circleci-coverage-github-reporter,可以用 npx circleci-coverage-github-reporter 直接运行。

@godaddy-wordpress/circleci-coverage-github-reporter 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/godaddy-wordpress__circleci-coverage-github-reporter 是否存在。

@godaddy-wordpress/circleci-coverage-github-reporter 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@godaddy-wordpress/circleci-coverage-github-reporter 可以商用吗?

@godaddy-wordpress/circleci-coverage-github-reporter 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@godaddy-wordpress/circleci-coverage-github-reporter 的下载量有多少?

根据 npm 官方下载统计,@godaddy-wordpress/circleci-coverage-github-reporter 在 2026/10/17 – 2026/11/15 这 30 天内被下载 2,826 次,日均约 94 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@godaddy-wordpress/circleci-coverage-github-reporter 还在维护吗?

最新版本 1.0.3 发布于 2021/10/20(5 年前);至今共发布 4 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/12/09。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。