Rule-based command-line tool for monitoring GitHub repositories
When you agree on some development guidelines, you need to know when they are not followed.
Most major open-source projects have adopted some automation to validate contribution guidelines. With gh-lint you can validate guidelines in public and private repositories across multiple organisations using pre-defined and custom rules.
See the talk about the development guidelines and gh-lint at FullStack 2017: video and slides.
npm install -g gh-lint
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.
gh-lint can generate output in TAP format (with option --tap) that can be consumed by tap-github-issues to open, close and update issues in the GitHub repositories where the rules are checked.
See gh-lint-demo for the example configuration and the scripts to run gh-lint and tap-github-issues.
By default, these rules analyse the commits for the last 30 days. It can be changed using options --since and --until (see below).
By default, these rules analyse the PRs for the last 30 days. It can be changed using option --since (see below).
-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--team-access - team access level required for repo to be associated with the team (for team-specific rules). The default is "admin". Other values are "write" (includes admin access) and "read" (repo will be associated with the team that has any access level).Rules can be defined in external modules.
The package name must be prefixed with "ghlint-plugin-". In the configuration file a plugin name can be used with or without this prefix.
A plugin package should export an object with a single property "rules" that has a map of rule definitions. Each rule should be valid according to the rule schema.
FAQs
Rule-based command-line tool for auditing GitHub repositories
The npm package gh-lint receives a total of 7 weekly downloads. As such, gh-lint popularity was classified as not popular.
We found that gh-lint demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.