gh-lint

gh-lint

Rule-based command-line tool for monitoring GitHub repositories

Install

npm install -g gh-lint

Usage

ghlint -c config.json -u $GITHUB_USERNAME -p $GITHUB_TOKEN

where config.json is a configuration file described by this schema.

You can define rules for organisations, teams and specific repos.

Rules

Repo rules

• repo-description: check that repo has description specified in GitHub UI
• repo-homepage: check that repo has homepage specified in GitHub UI
• repo-readme: check that repo has README file
• repo-team: check that repo is assigned to one of specified teams

Branch rules

• branch-default: check that default branch is master
• branch-protection: check that master branch is protected

Commit rules

By default, these rules analyse the commits for the last 30 days. It can be changed using options --since and --until (see below).

• commit-name: check that commit names satisfy semantic commit conventions

PR rules

By default, these rules analyse the PRs for the last 30 days. It can be changed using option --since (see below).

• pr-review: check that all PRs have at least one review that approved them

Options

• -c (or --config) - configuration file location
• -u (or --user) - GitHub username
• -p (or --pass) - GitHub password
• -a (or --after) / -b (or --before) - only validate repositories in organizations and in teams that were changed after/before this date (also can be date-time or the integer number of days). These options have no effect on repositories that are explicitely specified.
• --since / --until - validate commits since/until this date (also can be date-time or the integer number of days)
• --tap - output results in TAP format

License

MIT