Wie stelle ich sicher, dass die Copyright-Hinweise für einen Java-Maven-Build all meiner Quelldateien begleiten?
-
10-07-2019 - |
Frage
Gibt es einen Standard, wie Menschen die Aufnahme von Copyright-Vermerke in ihrer Java erzwingen / Maven baut? Ich weiß, dass es nicht notwendig sein sollte, da das Produkt selbst kopier geschrieben ist und wenn jemand meine Quelle hat Ich habe viel größere Probleme, aber ich gebeten, zu prüfen, und frage mich, ob check, PMD oder aber diese automatisch gehandhabt etwas .
Gibt es ein Werkzeug, das für das Urheberrecht Griff überprüfen?
Lösung
Ja , Check (und der Maven-check -plugin ) kann das tun, kann es überprüfen, ob alle Quelldateien eine Lizenz-Header enthalten. Setzen Sie diesen Header in einer Textdatei und verwenden Sie die headerLocation
sie darauf hinweisen, (es ist standardmäßig LICENSE.txt
verwendet).
Angenommen, Sie checkstyle.license
für Ihre Copyright-Hinweise verwenden möchten. Für eine Multi-Module zu bauen, ist der Standardansatz ein spezielles Modul erstellen Check Ressourcen (siehe Multimodul-Konfiguration ):
whizbang
|-- pom.xml
|-- build-tools
| |-- src
| | `-- main
| | `-- resources
| | `-- whizbang
| | |-- checkstyle.xml
| | `-- checkstyle.license
| `-- pom.xml
|-- core
|-- gui
|-- jmx
`-- src
Dann sind die Check Konfiguration die Top-Level-pom.xml
.
<pluginManagement>
<plugins>
<!-- Apply checkstyle rules and fail the build in case of errors. The
checkstyle config files are taken from the build-tools JAR module.-->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<!-- Lock down plugin version for build reproducibility -->
<version>2.4</version>
<dependencies>
<dependency>
<groupId>com.example.whizbang</groupId>
<artifactId>build-tools</artifactId>
<version>1.0</version>
</dependency>
</dependencies>
<configuration>
<consoleOutput>true</consoleOutput>
<configLocation>whizbang/checkstyle.xml</configLocation>
<headerLocation>whizbang/checkstyle.license</headerLocation>
</configuration>
<executions>
<execution>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>
...
</plugins>
</pluginManagement>
Diese Einstellung wird sichergestellt, dass ein Copyright-Header in Quelldateien vorhanden ist (und andere Check Regeln gelten, aber das ist eine andere Geschichte). Passen Sie es an Ihre Bedürfnisse anpassen.
Andere Tipps
ich gerade gefunden http://code.google.com/p/maven-license-plugin/ scheint auch vernünftig