Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Document mode and location configutation properties #119

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document mode and location configutation properties #119

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,6 @@ plugins {
For legacy versions of Gradle, see instructions in the
[Gradle plugin directory](https://plugins.gradle.org/plugin/com.bisnode.opa).

**Prerequisites**: OPA installed on same machine as the tasks are run, either on `$PATH` or pointed out by the
`location` configuration attribute (see Configuration below).

## Configuration

The following configuration properties are made available by the plugin:
Expand All @@ -32,9 +29,16 @@ opa {
location = 'path/opa/executable' // default: use opa on $PATH
srcDir = 'path/to/rego/src' // default: src/main/rego
testDir = 'path/to/rego/tests/' // default: src/test/rego
mode = 'DOWNLOAD' // default: LOCAL
version = '0.63.0'
}
```

In LOCAL mode OPA should be installed on same machine as the tasks are run, either on `$PATH` or pointed out by the
`location` configuration attribute.

In DOWNLOAD mode OPA is fetched from https://openpolicyagent.org/downloads

## Tasks

The plugin adds the following tasks:
Expand Down