/create-check

Create a GitHub check + annotation

Primary LanguageTypeScriptMIT LicenseMIT

create-check

Create a GitHub check with annotations on a PR

Highlights

  • Detects PR number and creates check w/annotations
  • Does nothing locally
  • Only runs in CI environment

Install

npm install --save-dev create-check
# or
yarn add -D create-check

Usage

Everything is written in typescript with JSDOC comments so your editor should tell you what each option is and does.

import createCheck from 'create-check';

async function main() {
  await createCheck({
    tool: 'stylelint',
    name: 'Check Styles for Errors',
    annotations: createAnnotations(results),
    errorCount,
    warningCount,
    appId: APP_ID,
    privateKey: PRIVATE_KEY,
  });

  console.log('Created check on PR');
}

main();

Changing GitHub URL (enterprise)

To get this package to work on github enterprise instances you will need to set the GH_API or GITHUB_URL environment variable to a url pointing towards your enterprise GitHub's API.

You may also need custom previews for some apis to work. Set the GH_PREVIEWS variable to a comma separated list of previews you'd like enabled.

Example:

GH_PREVIEWS=eye-scream-preview,machine-man-preview

Env Vars

This library will detect all the data it needs from the env, but sometimes a CI doesn't expose everything. The following env vars can be set:

  • REPO
  • OWNER

Related Libraries