Skip to content

Commit

Permalink
Add note about private repositories to README (#62)
Browse files Browse the repository at this point in the history
This is a change in behavior introduced by the fix for
invalidate_on_push with PRs from public forks.
  • Loading branch information
bluekeyes authored Apr 12, 2019
1 parent 68453a3 commit df2e5c7
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ UI to view the detailed approval status of any pull request.
- [`or`, `and`, and `if` (Rule Predicates)](#or-and-and-if-rule-predicates)
- [Cross-organization Membership Tests](#cross-organization-membership-tests)
- [Update Merges](#update-merges)
- [Private Repositories](#private-repositories)
* [Deployment](#deployment)
* [Development](#development)
* [Contributing](#contributing)
Expand Down Expand Up @@ -325,6 +326,12 @@ Note that `policy-bot` cannot detect if an update merge contains any merge
conflict resolutions. If you enable this option, users _may_ be able to merge
unapproved code by exploiting the conflict editor.

#### Private Repositories

`policy-bot` works with private repositories, but currently does not support
pull requests from private _forks_ of private repositories due to GitHub API
limitations. Please file an issue if this functionality is important to you.

## Deployment

`policy-bot` is easy to deploy in your own environment as it has no dependencies
Expand Down Expand Up @@ -404,6 +411,7 @@ To develop `policy-bot`, you will need a [Go installation](https://golang.org/do
- The server is available at `http://localhost:8080/`

### Example Policy Files

Example policy files can be found in [`config/policy-examples`](https://github.com/palantir/policy-bot/tree/develop/config/policy-examples)

## Contributing
Expand Down

0 comments on commit df2e5c7

Please sign in to comment.