Skip to content

Commit

Permalink
Document workaround for branch protection settings (#151)
Browse files Browse the repository at this point in the history
Document workaround for branch protection settings
  • Loading branch information
travi authored Oct 18, 2019
2 parents 096331b + b94101c commit aaa6081
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,21 @@ branches:
teams: []
```
Note: each top-level element under branch protection must be filled (eg: `required_pull_request_reviews`, `required_status_checks`, `enforce_admins` and `restrictions`). If you don't want to use one of them you should set it to `null`. Otherwise, none of the settings will be applied. For example:

```yml
branches:
- name: master
protection:
required_pull_request_reviews:
required_approving_review_count: 1
required_status_checks: null
enforce_admins: null
restrictions: null
```



### Inheritance

This app uses [probot-config](https://github.com/probot/probot-config). This means you can inherit settings from another repo, and only override what you want to change.
Expand Down

0 comments on commit aaa6081

Please sign in to comment.