@gkalpak/ng-cla-check

ng-cla-check

Description

A simple utility to check if an AngularJS PR has the cla: yes label.

Usage

Using in the command-line

# Show usage instructions
ng-cla-check --usage


# Check a PR
ng-cla-check 12345

You can optionally specify the GitHub repo and/or CLA label to check for (by default angular/angular.js and cla: yes respectively):

# Use non-default repo and CLA label
ng-cla-check 12345 --repo="some-user/some-repo" --claLabel="some text"

Note: To use a GitHub access-token, make it available in an environment variables names GITHUB_ACCESS_TOKEN.

Using in other modules

let Checker = require('ng-cla-check');
let checker = new Checker(/* Use defaults options */);

checker.check(prNo).then(
    () => { /* CLA verified successfully. */ },
    err => {
      /* Unable to verify CLA... */
      if (err) {
        /* ...because an error occurred (e.g. network error, authentication error etc). */
      } else {
        /* ...because it was probably not signed. */
      }
    });

You can also pass custom ghToken, claLabel or repo options:

let checker = new Checker({
  ghToken: '...',   // Pass `false` to force anonymous (rate-limited) requests to the GitHub API.
  claLabel: 'some text',
  repo: 'some-user/some-repo'
});