Skip to content

Commit 01a7377

Browse files
committed
Updated readme - TOC, maven plugin
1 parent 62038bd commit 01a7377

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

readme.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,15 @@ upgrades to newer micro versions are reported.
1111
It can be also specified which maven repositories should be used to look up new dependency versions. By default
1212
the Maven Central repository is used.
1313

14+
- [Usage - Maven plugin](#usage---maven-plugin)
15+
- [Usage - CLI](#usage---cli)
16+
- [CLI Usage examples](#cli-usage-examples)
17+
- [Configuration](#configuration)
18+
- [Configuration Keys](#configuration-keys)
19+
- [Upgrade Rules Examples](#upgrade-rules-examples)
20+
- [Limitations](#limitations)
21+
22+
1423
## Usage - Maven plugin
1524

1625
Prerequisite: add the JBoss Releases repository as a plugin repository in your Maven project:
@@ -79,8 +88,11 @@ mvn dependency-updater:report
7988
mvn dependency-updater:perform-upgrades
8089
```
8190

82-
If you want to use specific configuration, place `dependency-upgrade-config.json` file into your root project directory.
83-
See "Configuration" section for more information about the configuration file options.
91+
Reports will be saved in `dependency-upgrades-report.txt` files in `target/` directories of maven modules. If no
92+
upgradeable dependencies are found, the report file for given module will not be generated.
93+
94+
If you want to define upgrade rules, place `dependency-upgrade-config.json` file into your root project directory.
95+
See [Configuration](#configuration) section for more information about the configuration file options.
8496

8597
## Usage - CLI
8698

@@ -91,7 +103,7 @@ java -jar <path/to/alignment-cli.jar> <action> -f <path/to/pom.xml> [-c <path/to
91103
- alignment-cli-\<version\>.jar file is generated during build in `$SOURCE_DIR/cli/target/`,
92104
- `<action>` can be "generate-report" or "perform-upgrades".
93105

94-
### Usage Examples
106+
### CLI Usage Examples
95107

96108
Generate text report with possible dependency upgrades to an output file `report.txt`:
97109

@@ -190,7 +202,8 @@ but not "1.3.0.Final" or "1.2.3.Beta1".
190202

191203
## Limitations
192204

193-
* In a multi-module project, only the single POM file specified in the "-c" parameter is processed. Parent or nested POMs are not.
194-
This behaviour is considered "good enough" for now, as most projects have dependency versions managed in a BOM or a parent POM.
205+
* When using CLI tool on a multi-module project, only the single POM file specified in the "-c" parameter is processed.
206+
Parent or nested POMs are not. This behaviour is considered "good enough" for now, as most projects have dependency
207+
versions managed in a BOM or a parent POM.
195208
* Dependencies defined in profiles are not processed.
196209
* Plugins are not processed.

0 commit comments

Comments
 (0)