Skip to content

Commit a6ea86a

Browse files
author
Jan Diederich
committed
README.md for the pull-request
1 parent c9cfeff commit a6ea86a

File tree

1 file changed

+0
-137
lines changed

1 file changed

+0
-137
lines changed

‎README.md

Lines changed: 0 additions & 137 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
# license-maven-plugin
22

33
This is the [license-maven-plugin](http://www.mojohaus.org/license-maven-plugin/).
4-
It has been forked and extended with the option to extract more license information from the dependencies.
5-
It can also write a report to an Excel file.
6-
7-
Information about the source project (the license stays of course the same):
84

95
[![GitHub CI](https://github.com/mojohaus/license-maven-plugin/actions/workflows/maven.yml/badge.svg)](https://github.com/mojohaus/license-maven-plugin/actions/workflows/maven.yml)
106
[![Maven Central](https://img.shields.io/maven-central/v/org.codehaus.mojo/license-maven-plugin.svg?label=Maven%20Central)](https://search.maven.org/artifact/org.codehaus.mojo/license-maven-plugin)
@@ -23,136 +19,3 @@ cd target/checkout
2319
mvn verify site -DperformRelease scm-publish:publish-scm
2420
```
2521

26-
## Run integration tests
27-
28-
```bash
29-
mvn clean integration-test -Prun-its
30-
```
31-
32-
Run only some tests (separated by comma (",")):
33-
34-
```bash
35-
mvn integration-test -Prun-its -Dinvoker.test=aggregate-download-licenses-sort-by-*
36-
```
37-
38-
## List dependencies
39-
40-
```bash
41-
mvn dependency:tree -l dependencies.txt
42-
```
43-
44-
Show with Windows:
45-
46-
```bash
47-
start dependencies.txt
48-
```
49-
50-
Show with Linux:
51-
52-
```bash
53-
gopen dependencies.txt
54-
```
55-
56-
## How to configure the extended Excel report
57-
58-
The projects `pom.xml` must have the lines marked with "`<!-- New -->`" to use the new options (`extendedInfo`
59-
and `writeExcelFile`):
60-
61-
```xml
62-
<build>
63-
<pluginManagement>
64-
<plugins>
65-
<plugin>
66-
<groupId>org.codehaus.mojo</groupId>
67-
<artifactId>license-maven-plugin</artifactId>
68-
<version>2.4.0-SNAPSHOT</version>
69-
<configuration>
70-
<!-- New -->
71-
<extendedInfo>true</extendedInfo>
72-
<!-- New -->
73-
<writeExcelFile>true</writeExcelFile>
74-
<!-- New -->
75-
<writeCalcFile>true</writeCalcFile>
76-
77-
<!-- Not needed, but a suggestion -->
78-
<!-- Makes it more readable, licenses are the same with different names -->
79-
<licenseMerges>
80-
<licenseMerge>Apache License, Version 2.0
81-
|Apache 2.0
82-
|Apache 2
83-
|Apache License 2.0
84-
|The Apache Software License, Version 2.0
85-
|Apache License, version 2.0|AL 2.0
86-
|ASF 2.0
87-
</licenseMerge>
88-
<licenseMerge>MIT License|The MIT License|The MIT License (MIT)</licenseMerge>
89-
<licenseMerge>GNU Lesser General Public License
90-
|GNU Lesser General Public Licence
91-
|GNU LESSER GENERAL PUBLIC LICENSE
92-
|GNU Lesser Public License
93-
|Lesser General Public License (LGPL)
94-
</licenseMerge>
95-
<licenseMerge>GNU General Lesser Public License (LGPL) version 3.0
96-
|GNU LESSER GENERAL PUBLIC LICENSE, version 3 (LGPL-3.0)
97-
|The GNU Lesser General Public License, Version 3.0
98-
|Lesser General Public License (LGPL) v 3.0
99-
</licenseMerge>
100-
<!-- Problematic: While the maven plugins may have a simple declaration of "BSD" for their license, they may mean "New BSD" license, at least that's what they state on their websites. -->
101-
<licenseMerge>The BSD License|BSD License|BSD</licenseMerge>
102-
<licenseMerge>The BSD 3-Clause License|The New BSD License|New BSD License</licenseMerge>
103-
</licenseMerges>
104-
```
105-
106-
Since this hasn't been published to the official Maven repository yet, you must compile it yourself and install it to
107-
your local repository.
108-
109-
If you want to include it in your project and make sure all dependencies are packed together and
110-
solved, install it by adding:
111-
112-
```xml
113-
<properties>
114-
<third.party.dir> <Your-Dir-Where-The-JAR-Is-Located> </third.party.dir>
115-
</properties>
116-
117-
<build>
118-
<pluginManagement>
119-
<plugins>
120-
<plugin>
121-
<artifactId>maven-install-plugin</artifactId>
122-
<version>3.1.1</version>
123-
<configuration>
124-
<updateReleaseInfo>true</updateReleaseInfo>
125-
</configuration>
126-
</plugin>
127-
...
128-
</pluginManagement>
129-
130-
<plugins>
131-
<plugin>
132-
<artifactId>maven-install-plugin</artifactId>
133-
<inherited>false</inherited>
134-
<executions>
135-
<execution>
136-
<id>install-own-maven-license-plugin</id>
137-
<phase>validate</phase>
138-
<goals>
139-
<goal>install-file</goal>
140-
</goals>
141-
<configuration>
142-
<file>${third.party.dir}/license-maven-plugin-2.3.1-SNAPSHOT.jar</file>
143-
<groupId>org.codehaus.mojo</groupId>
144-
<artifactId>license-maven-plugin</artifactId>
145-
<version>2.3.1-SNAPSHOT</version>
146-
<packaging>jar</packaging>
147-
</configuration>
148-
</execution>
149-
</executions>
150-
</plugin>
151-
...
152-
```
153-
154-
Then, to install the plugin a `mvn validate` is enough.
155-
156-
After that, generate the report with `mvn license:aggregate-download-licenses`.
157-
158-
Under `./target/generated-resources/licenses.xlsx` is then the generated Excel-Report with the extended information.

0 commit comments

Comments
 (0)