/reg-ci-notify-github-plugin

A plugin for reg-suit to publish visual regression reports to GitHub PRs.

Primary LanguageTypeScript

reg-ci-notify-github-plugin

A reg-suit plugin that comments on your PR with the results of your regression test, and a link to the report if available.

Installation

npm install --save-dev reg-ci-notify-github-plugin

or

yarn add --dev reg-ci-notify-github-plugin

Usage

Add the plugin to your regconfig.json:

{
  "plugins": {
    "@clue/reg-ci-notify-github-plugin": true
  }
}

In your CI configuration, set the following two environment variables:

  • CI_PULL_REQUEST: The full URL to the pull request that the build was triggered by. (This is set automatically by CirleCI per their docs.)
  • GITHUB_TOKEN: A token for a GitHub account that has permission to read the repo and comment on PRs.