blob: 809bc1040766e7559563f7061e5fda9b76a1daa1 [file] [log] [blame]
# Apache Maven Scripting Plugin
<!--
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.
-->
Usage
-----
This plugin contains generic code to evaluate any script that supports JSR223.
It is a matter of adding the right dependency and configure the script to evaluate.
<h3>Inline script</h3>
Use the script-tag to specify your script. Make sure you also define the engineName.
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-scripting-plugin</artifactId>
<version>${project.version}</version>
<configuration>
<engineName>groovy</engineName>
<script>
<![CDATA[
// your groovy script
]]>
</script>
</configuration>
<dependencies>
<!-- ScriptEngines -->
<dependency>
<groupId>org.codehaus.groovy</groupId>
<artifactId>groovy-jsr223</artifactId>
<version>2.4.7</version>
</dependency>
</dependencies>
</plugin>
<h3>Script from File</h3>
Use the scriptFile-tag to refer to your script. The engine is based on the file-extension, but can be specified using the engineName-tag.
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-scripting-plugin</artifactId>
<version>${project.version}</version>
<configuration>
<scriptFile>path/to/script.groovy</scriptFile>
</configuration>
<dependencies>
<!-- ScriptEngines -->
<dependency>
<groupId>org.codehaus.groovy</groupId>
<artifactId>groovy-jsr223</artifactId>
<version>2.4.7</version>
</dependency>
</dependencies>
</plugin>