This is an automated email from the ASF dual-hosted git repository. rfscholte pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/maven-scripting-plugin.git
The following commit(s) were added to refs/heads/master by this push: new a76fdb4 Add documentation a76fdb4 is described below commit a76fdb41c8d6b186abbc46143e8fca0af7345035 Author: rfscholte <rfscho...@apache.org> AuthorDate: Sun Feb 7 15:08:19 2021 +0100 Add documentation --- .../markdown/configure-the-script-engine.md.vm | 50 +++++++++++++++++++++ src/site/markdown/index.md.vm | 51 ++++++++++++++++++++++ src/site/markdown/jsr223-script-engines.md.vm | 23 ++++++++++ src/site/markdown/script-context.md | 24 ++++++++++ src/site/site.xml | 41 +++++++++++++++++ 5 files changed, 189 insertions(+) diff --git a/src/site/markdown/configure-the-script-engine.md.vm b/src/site/markdown/configure-the-script-engine.md.vm new file mode 100644 index 0000000..1e6f322 --- /dev/null +++ b/src/site/markdown/configure-the-script-engine.md.vm @@ -0,0 +1,50 @@ +# Configure the Script Engine +<!-- +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. +--> + +The plugin isn't bundled with any script engine, instead it should be added as dependency to the plugin. + +```xml + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-scripting-plugin</artifactId> + <version>@project.version@</version> + <executions> + <execution> + <id>groovy</id> + <configuration> + <engineName>groovy</engineName> + <script> + <![CDATA[ + (1..10).sum() + ' ' + project.artifactId + ]]> + </script> + </configuration> + </execution> + </executions> + <dependencies> + <!-- ScriptEngines --> + <dependency> + <groupId>org.codehaus.groovy</groupId> + <artifactId>groovy-jsr223</artifactId> + <version>3.0.7</version> <!-- look for latest --> + </dependency> + </dependencies> + </plugin> +``` \ No newline at end of file diff --git a/src/site/markdown/index.md.vm b/src/site/markdown/index.md.vm new file mode 100644 index 0000000..705ae37 --- /dev/null +++ b/src/site/markdown/index.md.vm @@ -0,0 +1,51 @@ +# 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. +--> + +The Maven Scripting Plugin is a plugin that wrapped the Scripting API according to JSR223. + Add the scripting engines as dependencies of this plugin on its use. + +Goals Overview +-------------- + + + * [scripting:eval](./eval-mojo.html) goal to evaaluate the script + +Usage +----- + + General instructions on how to use the Scripting Plugin can be found on the + [usage page](./usage.html). + + In case you still have questions regarding the plugin's usage, please have a look at the + [FAQ](./faq.html) and feel free to contact the [user mailing list](./mail-lists.html). + The posts to the mailing list are archived and could already contain the answer to your + question as part of an older thread. Hence, it is also worth browsing/searching + the [mail archive](./mail-lists.html). + + If you feel like the plugin is missing a feature or has a defect, you can fill a + feature request or bug report in our [issue tracker](./issue-tracking.html). + When creating a new issue, please provide a comprehensive description of your + concern. Especially for fixing bugs it is crucial that the developers can + reproduce your problem. For this reason, entire debug logs, POMs or most + preferably little demo projects attached to the issue are very much appreciated. + Of course, patches are welcome, too. Contributors can check out the project from + our [source repository](./source-repository.html) and will find supplementary + information in the + [guide to helping with Maven](http://maven.apache.org/guides/development/guide-helping.html). diff --git a/src/site/markdown/jsr223-script-engines.md.vm b/src/site/markdown/jsr223-script-engines.md.vm new file mode 100644 index 0000000..e867a30 --- /dev/null +++ b/src/site/markdown/jsr223-script-engines.md.vm @@ -0,0 +1,23 @@ +# Available JSR223 Script Engines +<!-- +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. +--> + +| EngineName | Dependency | +|------------|----------- | +| groovy | <code><dependency><br/><groupId>org.codehaus.groovy</groupId><br/><artifactId>groovy-jsr223</artifactId><br/><version></version><br/></dependency></code> | \ No newline at end of file diff --git a/src/site/markdown/script-context.md b/src/site/markdown/script-context.md new file mode 100644 index 0000000..03ed850 --- /dev/null +++ b/src/site/markdown/script-context.md @@ -0,0 +1,24 @@ +# Configure the Script Engine +<!-- +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. +--> + +The following variables are available in the script context + + * `org.apache.maven.project.MavenProject project` + * `org.apache.maven.plugin.logging.Log log` \ No newline at end of file diff --git a/src/site/site.xml b/src/site/site.xml new file mode 100644 index 0000000..64047f2 --- /dev/null +++ b/src/site/site.xml @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- +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. +--> + +<project xmlns="http://maven.apache.org/DECORATION/1.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd"> + <body> + <menu name="Overview"> + <item name="Introduction" href="index.html"/> + <item name="Goals" href="plugin-info.html"/> + <!-- <item name="Usage" href="usage.html"/> --> + <!-- <item name="FAQ" href="faq.html"/> --> + <!-- According to https://issues.apache.org/jira/browse/MNGSITE-152 --> + <item name="License" href="http://www.apache.org/licenses/"/> + <item name="Download" href="download.html"/> + </menu> + <menu name="Examples"> + <item name="Configure the Script Engine" href="configure-the-script-engine.html"/> + <item name="JSR223 Script Engines" href="jsr223-script-engines.html"/> + <item name="Script Context" href="script-context.html"/> + </menu> + </body> +</project>