Skip to content

Commit

Permalink
Update README.md (#98)
Browse files Browse the repository at this point in the history
When using policybot with a custom server, I initially expected the behavior described to be:

* The custom path is checked
* If the custom path does not exist, the default path is checked

In actuality, if a custom path is configured, *only* the custom path is checked. This update attempts to call that out more clearly.
  • Loading branch information
akerl-unpriv authored and asvoboda committed Jul 5, 2019
1 parent 6f4d9b0 commit d1026ed
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,9 @@ UI to view the detailed approval status of any pull request.
## Configuration

By default, the behavior of the bot is configured by a `.policy.yml` file at
the root of the repository. The file name and location are configurable when
running your own instance of the server.
the root of the repository. When running your own instance of the server, a
different file name and location can be configured. The configured name and
location will be used instead of the default location.

- If the file does not exist, the `policy-bot` status check is not posted. This
means it is safe to enable `policy-bot` on all repositories in an organization.
Expand Down

0 comments on commit d1026ed

Please sign in to comment.