Find problems in your GitHub settings.
git clone [email protected]:Kyash/ghlint.git
cd ghlint
install -m 755 ./bin/ghlint /usr/local/bin
- Docker
Displayed by executing the following command:
ghlint -h
ghlint orgs/Kyash > results.tsv
0
: There was no rule violation1
: One or more rule violations found- other: An unexpected error has occurred
Describe the rule settings in .ghlintrc.json
.
- For example, describe
rules::repo::manage_team_access
settings in.rules.repo.manage_team_access.patterns
element - Multiple settings can be described in
patterns
element - Use
filter
element to specify targets- To exclude all targets from the rule, describe the pattern element as follows:
{ "filter": { "name": "^$" } }
- To exclude all targets from the rule, describe the pattern element as follows:
- Other rule-specific settings can also be described.
If Kyash
organization expects all repositories to have write permission from engineer
team, then describe:
{
"rules": {
"repo": {
"manage_team_access": {
"patterns": [
{
"filter": {
"full_name": "^Kyash/"
},
"allowlist": [
{
"slug": "engineer",
"permission": "push",
"strict": true
}
]
}
]
}
}
}
}
Launch the development environment
bash -i ./launch_dev_env.sh
Use Bats-core to run the test.
bats -r test
- GitHub REST API
- cURL v7.75.0+
- Bash v5.0+
- Node.js v10.24.0+
- jq v1.6+
Bug reports and pull requests are welcome on GitHub at https://github.com/Kyash/ghlint