Skip to content

Commit 14fd758

Browse files
committed
doc: add params for add-dep goal
Signed-off-by: Maximillian Arruda <[email protected]>
1 parent 274fc8d commit 14fd758

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

README.adoc

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ mvn pom-editor:<GOAL>
4141
In the documentation, we'll assume that you have done this configuration.
4242
===============================
4343

44-
=== Add a dependency
44+
=== Add/Change a dependency
4545

4646
Let's suppose that you need to add JUnit Jupiter version 5.9.2 into your POM in the test scope, you could perform the following command inside on the target maven project:
4747

@@ -50,6 +50,38 @@ Let's suppose that you need to add JUnit Jupiter version 5.9.2 into your POM in
5050
mvn pom-editor:add-dep -Dgav='org.junit.jupiter:junit-jupiter:5.9.2' -Dscope=test
5151
----
5252

53+
.add-dep supported parameters
54+
[cols="add-dep params"]
55+
|===
56+
|Parameter | Description | Required | Default
57+
58+
| gav
59+
| Dependency coordinates. Supported format: `groupId:artifactId:version`
60+
| Yes
61+
|
62+
63+
| pom
64+
| Target POM file.
65+
| No
66+
| pom.xml
67+
68+
| scope
69+
| The scope of the dependency - compile, runtime, test, system, and provided
70+
| No
71+
|
72+
73+
| type
74+
| The type of dependency, that will be mapped to a file extension, an optional classifier and a few other attributes
75+
| No
76+
|
77+
78+
| classifier
79+
| The classifier of the dependency. It is appended to the filename after the version.
80+
| No
81+
|
82+
83+
|===
84+
5385
=== Confirm the changes
5486

5587
When you perform the goal add-dep with the command below:

0 commit comments

Comments
 (0)