acot-reporter-github

@acot/acot-reporter-github

GitHub reporter for @acot/cli.

Examples

• acot-a11y/example-github-reporter

Installation

Install via npm:

$ npm install --save @acot/acot-reporter-github

Prerequisites

There are a few necessary setups for integrating acot with GitHub.

1. Install the acot-a11y GitHub App in the repository where you want to use GitHub integration.
2. Generate a token for GitHub integration from the token manager application.

Usage

module.exports = {
  reporters: [
    {
      use: '@acot/github',
      with: {
        token: '...',
      },
    },
  ],
};

Pass the token as an environment variable

If you pass a token to the ACOT_GITHUB_APP_TOKEN environment variable, the GitHub reporter will automatically resolve the token for you. It is one technique to avoid writing the token directly into the configuration file.

module.exports = {
  reporters: ['@acot/github'],
};

Enabling debug logging

If you need logging other than errors, enabling the debug option will help.

module.exports = {
  reporters: [
    {
      use: '@acot/github',
      with: {
        debug: true,
      },
    },
  ],
};