-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Enhance How to use it documentation #27
Enhance How to use it documentation #27
Conversation
Signed-off-by: Gian de Manincor <gianmanincor@gmail.com>
0db73b1
to
73d5581
Compare
Signed-off-by: Gian de Manincor <gianmanincor@gmail.com>
@@ -14,6 +14,8 @@ Facilitate manipulation such as managing POM dependencies through CLI (command l | |||
|
|||
== How to use it | |||
|
|||
==== Add a dependency |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
==== Add a dependency | |
=== Add a dependency |
@@ -41,6 +43,37 @@ Then you'll be able to perform the plugin by its prefix: | |||
mvn pom-editor:add-dep -Dgav='org.junit.jupiter:junit-jupiter:5.9.2' -Dscope=test | |||
---- | |||
|
|||
==== Confirm the changes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
==== Confirm the changes | |
=== Confirm the changes |
[source,sh] | ||
$ mvn pom-editor:commit | ||
|
||
==== Revert the changes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
==== Revert the changes | |
=== Revert the changes |
@@ -14,6 +14,8 @@ Facilitate manipulation such as managing POM dependencies through CLI (command l | |||
|
|||
== How to use it | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[TIP] | |
=============================== | |
In order to make easier the plugin utilization we can register the groupId into the `settings.xml` like the snipped code below: | |
[source,xml] | |
---- | |
<settings > | |
<!-- snipped --> | |
<pluginGroups> | |
<pluginGroup>br.org.soujava</pluginGroup> | |
</pluginGroups> | |
<!-- snipped --> | |
</settings> | |
---- | |
With that, we will be able to perform the plugin by using its prefix. | |
So, instead of to perform the plugin by the following command: | |
[source, sh] | |
---- | |
mvn br.org.soujava:pom-editor-maven-plugin:<GOAL> | |
---- | |
We may perform it just providing its prefix like below: | |
[source, sh] | |
---- | |
mvn pom-editor:<GOAL> | |
---- | |
In the documentation, we'll assume that you have done this configuration. | |
=============================== | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let me know for any doubts!
@GianDeManincor, thanks for the contribution! |
I am improving and organizing the How to use it documentation.
My idea was to create a subtitles for each topic: