From 07952e1cf03ef3834fe6e4445637c9c2e91c27ad Mon Sep 17 00:00:00 2001 From: Hristo Iliev Date: Thu, 18 Apr 2024 22:04:04 +0300 Subject: [PATCH] Document mode and location configutation properties --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 611d4ca..471afa9 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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: