Skip to content

Commit

Permalink
Fixed #474- Improve doc on how to pass parameter to MavenOption when …
Browse files Browse the repository at this point in the history
…using MavenCLIOptions (#475)

* Describe how to pass parameter to MavenOption annotation
* Add entry to release notes
  • Loading branch information
Bukama authored Jul 22, 2024
1 parent fce4f34 commit d1addd9
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
:issue-468: https://github.com/khmarbaise/maven-it-extension/issues/468[Fixed #468]
:pr-460: https://github.com/khmarbaise/maven-it-extension/pull/460[Pull request #460]
:pr-462: https://github.com/khmarbaise/maven-it-extension/pull/462[Pull request #462]
:issue-474: https://github.com/khmarbaise/maven-it-extension/issues/474[Fixed #474]

:release_0_14_0: https://github.com/khmarbaise/maven-it-extension/milestone/14

Expand Down
14 changes: 13 additions & 1 deletion itf-documentation/src/main/asciidoc/usersguide/usersguide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -783,7 +783,7 @@ void first( MavenExecutionResult result )
----

[[structuring.default.goals.options]]
=== Default Goals,Options
=== Default Goals, Options

[[structuring.goals]]
==== Goals
Expand Down Expand Up @@ -970,6 +970,18 @@ class BasicIT {
}
}
----
If you want to pass a parameter to a `@MavenOption` you have to name the parameters explicit like this:
[source,java]
----
@MavenJupiterExtension
class BasicIT {
@MavenTest
@MavenOption(value = MavenCLIOptions.FILE, parameter = 'path/to/pom.xml')
void first(MavenExecutionResult result) {
}
}
----
Now let us summarize the information for options. As long as no explicit `@MavenOption` is defined the
default will be used which are the following:

Expand Down

0 comments on commit d1addd9

Please sign in to comment.