乐趣区

关于travis-ci:Count自动化为你的项目添加证明可靠性的-badge

jiezi

前言

开源社区里，开源我的项目个别会将一排花花绿绿的 badge（徽章）摆在 README 最显眼的地位，它们个别能够起到一些阐明和证实的作用。
比方上面的这个我的项目（传送门）：

  • 第一个 badge 证实其能失常构建，点击跳转至构建过程报告；
  • 第二个 badge 证实其测试覆盖率达到 100%，点击跳转至单元测试报告；
  • 第三个 badge 阐明其是 MIT 受权协定；
  • 第四个 badge 阐明其最小化后包的大小；

别以为他们只是图片，正规的我的项目是随我的项目更新而更新的，点击不了或者点击进入的不是对应我的项目的报告都能够算作伪造，请远离这些我的项目。
下面提到的 badge 中前两个能够算是我的项目可靠性的证实，是比拟有份量的 badge，接下来咱们将指引大家如何自动化增加这两 badge。

留神：本文以 Github 为代码仓库，第三方帐号受权都以 Github 帐号进行，请确保本身网络环境能失常拜访；不波及我的项目自身的构建和测试。

筹备

  • 编写一个我的项目，在 package.json 中以“build”为构建命令，dist 为打包后输入的目录；
  • 编写好该项目标单元测试，在 package.json 中以“test:prod”为测试命令，并且会主动在 coverage 目录下生成覆盖率报告；

  • 为我的项目装置 devDependencies（开发依赖）：

    • coveralls
  • 注册一个 Github 帐号，提交我的项目到一个仓库。

Travis 配置

Travis CI 提供的是继续集成服务（Continuous Integration，简称 CI）。它绑定 Github 下面的我的项目，只有有新的代码，就会主动抓取。而后，提供一个运行环境（容器），执行测试，实现构建，还能主动部署到服务器。
本次的自动化就是依附这个服务实现的，这里只展现相干的配置，更多的用法请自行查看文档。

新建配置文件

在我的项目根目录下新建 .travis.yml 文件，输出上面配置并保留。

language: node_js
cache: npm
notifications:
  email: false
node_js:
  - '10'
script:
  - npm run test:prod && npm run build
after_success:
  - npm run report-coverage
branches:
  except:
    - /^v\d+\.\d+\.\d+$/

配置阐明：

  • language：Travis 能够反对多种语言，这里是 node 我的项目，填“node_js”即可；
  • cache：缓存，可放慢构建。配置为 npm 会缓存 $HOME/.npm 和 node_modules 目录；
  • notifications：默认状况下会邮件告诉提交者和作者，如果不须要则设置为 false，还反对设置钩子、接口告诉等形式，具体见文档；
  • node_js：运行容器装置的 node 版本，这里是指构建和测试的环境，与理论运行环境是不同的，个别与本机雷同即可，设置多个的话每次每一个都会运行一次，会减少构建工夫；
  • script：要运行的命令，这里咱们进行的就是单元测试和构建两步操作；
  • after_success：script 运行完结，且无谬误的状况下运行的命令，这里咱们进行单测覆盖率报告提交；
  • branches：须要运行的 git 分支，默认是只运行主分支，这里咱们减少了对“vXX.XX.XX”分支的反对。

开启 Travis 监听

  1. 进入 Travis 官网：https://travis-ci.com/；
  2. 用 Github 帐号受权登录；
  3. 点击左上角的加号，或者点击指引里的按钮，进入对 Github 仓库进行受权；
  4. 能够抉择受权以后 Github 帐号的局部仓库，也能够抉择全副。

获取构建 badge 代码

待仓库导入后，进入我的项目主页，右上角就能看到 badge，点击它会弹出一个抉择代码类型的弹框，抉择须要的类型复制粘贴到 README 就行了（个别抉择 Markdown）。

Coveralls 配置

Coveralls 是一个展现单元测试覆盖率报告的网站，它自身不会运行单测或生成报告，它只是提供用于提交规范单元测试覆盖率报告的包（也就是下面筹备阶段装置的 coveralls），能够配合测试套件应用。

编写提交命令

以 Jest 为例，默认运行 jest --coverage 后会在 coverage 目录下生成规范的单测报告。但咱们不须要在本地跑，Travis 会帮咱们实现，只须要确保能够目录正确即可。
下面 .travis.yml 中咱们应用了“report-coverage”命令，这个是自定义的 scripts，在 package.json 里的 scripts 块中写入该命令，

"scripts": {"report-coverage": "cat ./coverage/lcov.info | coveralls",}

开启 Coveralls 监听

  1. 进入 Coveralls 官网：https://coveralls.io/；
  2. 用 Github 帐号受权登录；
  3. 点击右侧加号（ADD REPO）；
  4. 把须要的我的项目的开关关上；

获取覆盖率 badge 代码

点击 DETAILS 进入详情页，这时候你还未有报告，所以看到的是指引页，咱们能够先在底部找到获取 badge 代码的入口，抉择须要的类型复制粘贴到 README 就行了（个别抉择 Markdown）。

实现，启动 Travis

将 .travis.yml、package.json 和 README 提交，Travis 监听到提交就会启动运行。偶然第一次未胜利，能够点击 Travis 的我的项目详情页右侧，点击“Trigger build”手动开启。

额定配置（可选）

因为 Coveralls 自身就曾经能与 Travis 无缝配合，默认状况下它们会辨认雷同的仓库，并更新。
但如果你应用的是 Travis Pro（Travis 的付费版，个别收费的曾经够用）和其余 CI 零碎，或者须要非 git 主分支的后果时，须要进行写入环境变量告知零碎。
Coveralls 提供三个必填项：

  • COVERALLS_SERVICE_NAME：CI 零碎名，比方 travis-pro；
  • COVERALLS_REPO_TOKEN：Coveralls 给每个我的项目的惟一标识，也是提交单测覆盖率报告的根据；
  • COVERALLS_GIT_BRANCH：提交报告是哪个 git 分支。

全局的环境变量

如果是全局的变量，能够间接写到 .travis.yml 文件的 env 块。比方：

env:
  - DB=postgres
  - SH=bash
  - PACKAGE_VERSION="1.0.*"

部分的环境变量

如果是每个命令独立应用的变量，能够间接写到 .travis.yml 文件的 script 块里的命令里。

script:
  - COVERALLS_GIT_BRANCH=test npm run test:prod && npm run build

当然同理写到 package.json 文件的 script 也是能够的。

一些不能公开的变量

无论写到 .travis.yml 或 package.json 文件都须要提交的 git，这些内容都会公开（公共仓库），但相似 COVERALLS_REPO_TOKEN 这类数据是不能公开的。
因而咱们能够将他们写到 Travis 上我的项目的设置里（这不是加密，如果要更加严格的加密，能够应用加密文件，详情看 Travis 文档）。

  1. 进入我的项目对应的 Travis 主页；
  2. 点击右上角的“More options”里“Settings”；
  3. 在“Environment Variables”块进行“ADD”操作。

完结

教程到此曾经实现，整体流程就是：通过 Travis 配置监听 Github 上对应仓库的提交，Travis 发现提交就拉取代码，在 Travis 提供的容器里实现构建和单元测试，实现后再主动提交单测覆盖率报告到 Coveralls，最终后果反映到 README 的 badge 上。
一劳永逸，还不连忙试试。

退出移动版