| ------ |
| Configuring Source Plugin |
| ------ |
| Maria Odea Ching |
| ------ |
| 11 July 2006 |
| ------ |
| |
| ~~ Licensed to the Apache Software Foundation (ASF) under one |
| ~~ or more contributor license agreements. See the NOTICE file |
| ~~ distributed with this work for additional information |
| ~~ regarding copyright ownership. The ASF licenses this file |
| ~~ to you under the Apache License, Version 2.0 (the |
| ~~ "License"); you may not use this file except in compliance |
| ~~ with the License. You may obtain a copy of the License at |
| ~~ |
| ~~ http://www.apache.org/licenses/LICENSE-2.0 |
| ~~ |
| ~~ Unless required by applicable law or agreed to in writing, |
| ~~ software distributed under the License is distributed on an |
| ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| ~~ KIND, either express or implied. See the License for the |
| ~~ specific language governing permissions and limitations |
| ~~ under the License. |
| |
| ~~ NOTE: For help with the syntax of this file, see: |
| ~~ http://maven.apache.org/doxia/references/apt-format.html |
| |
| Configuring Source Plugin |
| |
| To customize the plugin, you can change its configuration parameters in your POM, as shown below: |
| |
| +-----+ |
| <project> |
| ... |
| <build> |
| <plugins> |
| <plugin> |
| <groupId>org.apache.maven.plugins</groupId> |
| <artifactId>maven-source-plugin</artifactId> |
| <version>${project.version}</version> |
| <configuration> |
| <outputDirectory>/absolute/path/to/the/output/directory</outputDirectory> |
| <finalName>filename-of-generated-jar-file</finalName> |
| <attach>false</attach> |
| </configuration> |
| </plugin> |
| </plugins> |
| </build> |
| ... |
| </project> |
| +-----+ |
| |
| The generated jar file will be named by the value of the <<<finalName>>> plus "-sources" if it is the main sources. Otherwise, |
| it would be <<<finalName>>> plus "-test-sources" if it is the test sources. It will be generated in the specified |
| <<<outputDirectory>>>. The <<<attach>>> parameter specifies whether the java sources will be attached to the artifact list of |
| the project. |