> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# ayte/mvnw

A simple orb that runs mvnw comamnds, expects maven settings to be
under .circleci/settings.xml and uses .circleci/m2 as maven repo,
so it can be cached


## Commands

### mvnw

Simply runs maven wrapper with defaults, no magic in here.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `settings` | string | ~/.m2/settings.xml | Path to maven settings |
| `repository` | string | ~/.m2 | Path that will be used as local repository |
| `directory` | string | . | Directory to operate in. Use it if your pom.xml is not placed
in current directory.
 |
| `file` | string | pom.xml | Name for POM file in case it's something different rather than
standard pom.xml
 |
| `executable` | string | ./mvnw | Executable to pass command to, defaults to `./mvnw` |
| `command` | string |  | Command to run |
| `when` | string | on_success | `always`, `on_success` or `on_fail` |

### circle

Runs Maven Wrapper with assumption of settings.xml being located
in .circleci and local repository being managed under .circleci/m2


| Parameter | Type | Default | Description |
|---|---|---|---|
| `settings` | string | .circleci/settings.xml | Path to maven settings |
| `repository` | string | .circleci/m2 | Path that will be used as local repository |
| `directory` | string | . | Directory to operate in. Use it if your pom.xml is not placed
in current directory.
 |
| `file` | string | pom.xml | Name for POM file in case it's something different rather than
standard pom.xml
 |
| `executable` | string | ./mvnw | Executable to pass command to, defaults to `./mvnw` |
| `command` | string |  | Command to run |
| `when` | string | on_success | `always`, `on_success` or `on_fail` |

### install

| Parameter | Type | Default | Description |
|---|---|---|---|
| `when` | string | on_success | `always`, `on_success` or `on_fail` |