This is an automated email from the ASF dual-hosted git repository. aw pushed a commit to branch YETUS-1034-release in repository https://gitbox.apache.org/repos/asf/yetus.git
commit 168194c7f8ab441d05ca549b159d9a0adbdfb978 Author: Allen Wittenauer <[email protected]> AuthorDate: Mon Oct 26 09:13:24 2020 -0700 YETUS-1046. remove jython releasedocmaker and shelldocs (#174) --- .../in-progress/releasedocmaker.html.md | 3 +- .../in-progress/yetus-maven-plugin.html.md | 82 +----- releasedocmaker/pom.xml | 58 +---- .../src/main/assemblies/jar-with-dependencies.xml | 46 ---- .../yetus/releasedocmaker/ReleaseDocMaker.java | 62 ----- shelldocs/pom.xml | 50 +--- .../java/org/apache/yetus/shelldocs/ShellDocs.java | 62 ----- yetus-maven-plugin/pom.xml | 12 - .../maven/plugin/rdm/ReleaseDocMakerMojo.java | 274 --------------------- .../yetus/maven/plugin/rdm/package-info.java | 22 -- .../maven/plugin/shelldocs/ShellDocsMojo.java | 106 -------- .../yetus/maven/plugin/shelldocs/package-info.java | 22 -- 12 files changed, 6 insertions(+), 793 deletions(-) diff --git a/asf-site-src/source/documentation/in-progress/releasedocmaker.html.md b/asf-site-src/source/documentation/in-progress/releasedocmaker.html.md index 82d1e42..c946c3b 100644 --- a/asf-site-src/source/documentation/in-progress/releasedocmaker.html.md +++ b/asf-site-src/source/documentation/in-progress/releasedocmaker.html.md @@ -231,7 +231,8 @@ This will do the normal JIRA querying, looking for items it considers problemati # Index Mode -There is basic support for an autoindexer. It will create two files that contain links to all directories that have a major.minor*-style version numbering system. +There is basic support for an autoindexer. It will create two files that contain links to all directories that have a major.minor\*-style +version numbering system. For example directories with names like 0.6, 1.2.2, 1.2alpha etc. will all be linked. * `index.md`: a file suitable for conversion to HTML via mvn site diff --git a/asf-site-src/source/documentation/in-progress/yetus-maven-plugin.html.md b/asf-site-src/source/documentation/in-progress/yetus-maven-plugin.html.md index ada3868..8928c2e 100644 --- a/asf-site-src/source/documentation/in-progress/yetus-maven-plugin.html.md +++ b/asf-site-src/source/documentation/in-progress/yetus-maven-plugin.html.md @@ -26,8 +26,6 @@ * [bin4libs](#bin4libs) * [symlink](#symlink) * [parallel-mkdirs](#parallel-mkdirs) -* [releasedocmaker](#releasedocmaker) -* [shelldocs](#shelldocs) <!-- /MarkdownTOC --> @@ -87,7 +85,8 @@ The wrapper as written above makes sure that nearly all forms of referencing (re ### Licenses -The `license` field translates to `licenses/NAME.txt` as the name of the file to load from the CLASSPATH. The `ASL20` license is the Apache Software License v2.0. +The `license` field translates to `licenses/NAME.txt` as the name of the file to load from the CLASSPATH. +The `ASL20` license is the Apache Software License v2.0. If no license is wanted, then set `license` to the string `none`. @@ -157,80 +156,3 @@ Available configuration options: | `goal` | the goal to use to create the directories | `generate-test-resources` | By default, `forkCount` is inherited from surefire and therefore follows the same rules as described in its [documentation](https://maven.apache.org/surefire/maven-surefire-plugin/examples/fork-options-and-parallel-execution.html). Of special note is that 'C' (aka core) values are honored. - -# releasedocmaker - -This goal runs releasedocmaker without the need to download or build an Apache Yetus tarball. Instead, yetus-maven-plugin contains all the necessary components in a native maven way! - -```xml - <plugin> - <groupId>org.apache.yetus</groupId> - <artifactId>yetus-maven-plugin</artifactId> - <executions> - <execution> - <id>rdm</id> - <phase>pre-site</phase> - <goals> - <goal>releasedocmaker</goal> - </goals> - <configuration> - <projects> - <project>HADOOP</project> - <project>HDFS</project> - <project>MAPRED</project> - <project>YARN</project> - </projects> - </configuration> - </execution> - </plugin> -``` - -The configuration options generally map 1:1 to the `releasedocmaker` executable's options. Unless otherwise specified, defaults are set by the actual executable. - -| Option | Description | Default | -|--------|-------------|---------| -| `baseUrl` | --baseurl | | -| `dirversions` | boolean; same as --dirversions | false | -| `fileversions` | boolean; same as --fileversions | false | -| `incompatibleLabel` | --incompatiblelabel | | -| `index` | boolean; --index | false | -| `license` | boolean; --license | false | -| `lintFilters` | ArrayList; --lint | | -| `outputDir` | --outputdir | `${project.build.directory}/generated-site/markdown` | -| `projects` | ArrayList; --projects | `${project.name}` | -| `projectTitle` | --projecttitle | | -| `range` | boolean; --range | false | -| `retries` | integer; --retries | | -| `skipcredits` | boolean; --skipcredits | false | -| `sortorder` | --sortorder | | -| `sorttype` | --sorttype | | -| `useToday` | --usetoday | false | -| `versions` | ArrayList; --versions | `${project.version}` | - -# shelldocs - -Similar to the `releasedocmaker` goal, the `shelldocs` goal runs the Apache Yetus `shelldocs` utility against a given set of input files or directories and generates a single output MultiMarkdown file: - -```xml - <plugin> - <groupId>org.apache.yetus</groupId> - <artifactId>yetus-maven-plugin</artifactId> - <executions> - <execution> - <id>shelldocs</id> - <phase>pre-site</phase> - <goals> - <goal>shelldocs</goal> - </goals> - </execution> - </plugin> -``` - -The configuration options generally map 1:1 to the `shelldocs` executable's options. Unless otherwise specified, defaults are set by the actual executable. - -| Option | Description | Default | -|--------|-------------|---------| -| `lint` | boolean; --lint | false | -| `output` | --output | `${project.build.directory}/generated-site/markdown/${project.name}.md` | -| `inputs` | ArrayList; --input ... | *sh files located in`${project.basedir}/src/main/shell` | -| `skipprnorep` | --skipprnorep | false | diff --git a/releasedocmaker/pom.xml b/releasedocmaker/pom.xml index 6836e72..cb09b2a 100644 --- a/releasedocmaker/pom.xml +++ b/releasedocmaker/pom.xml @@ -31,20 +31,7 @@ <artifactId>releasedocmaker</artifactId> <description>JIRA-based Changelog and Release Notes Generator</description> <name>Apache Yetus - releasedocmaker</name> - <packaging>jar</packaging> - - <dependencies> - <dependency> - <groupId>org.python</groupId> - <artifactId>jython-slim</artifactId> - <version>${jython-slim.version}</version> - </dependency> - <dependency> - <groupId>org.apache.yetus</groupId> - <artifactId>audience-annotations</artifactId> - <version>${project.version}</version> - </dependency> - </dependencies> + <packaging>pom</packaging> <build> <resources> @@ -54,10 +41,6 @@ </resources> <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-compiler-plugin</artifactId> - </plugin> <plugin> <artifactId>maven-assembly-plugin</artifactId> @@ -100,45 +83,6 @@ </configuration> </execution> - <execution> - <id>make-jar-assembly</id> - <phase>package</phase> - <goals> - <goal>single</goal> - </goals> - <configuration> - <archive> - <manifest> - <mainClass>org.apache.yetus.releasedocmaker.ReleaseDocMaker</mainClass> - </manifest> - </archive> - <descriptors> - <descriptor>src/main/assemblies/jar-with-dependencies.xml</descriptor> - </descriptors> - </configuration> - </execution> - - </executions> - </plugin> - - <plugin> - <groupId>net.sf.mavenjython</groupId> - <artifactId>jython-compile-maven-plugin</artifactId> - <version>${jython-compile-maven-plugin.version}</version> - <executions> - <execution> - <phase>compile</phase> - <goals> - <goal>jython</goal> - </goals> - <configuration> - <temporaryBuildDirectory>${project.build.directory}/jython-plugins-tmp/</temporaryBuildDirectory> - <libraries> - <param>--index-url=https://pypi.python.org/simple/</param> - <param>python-dateutil</param> - </libraries> - </configuration> - </execution> </executions> </plugin> diff --git a/releasedocmaker/src/main/assemblies/jar-with-dependencies.xml b/releasedocmaker/src/main/assemblies/jar-with-dependencies.xml deleted file mode 100644 index 6236faf..0000000 --- a/releasedocmaker/src/main/assemblies/jar-with-dependencies.xml +++ /dev/null @@ -1,46 +0,0 @@ -<?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. ---> -<assembly xmlns="https://maven.apache.org/ASSEMBLY/2.0.0"; - xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="https://maven.apache.org/ASSEMBLY/2.0.0 https://maven.apache.org/xsd/assembly-2.0.0.xsd";> - <!-- TODO: a jarjar format would be better --> - <id>jar-with-dependencies</id> - <formats> - <format>jar</format> - </formats> - <includeBaseDirectory>false</includeBaseDirectory> - <dependencySets> - <dependencySet> - <outputDirectory>/</outputDirectory> - <useProjectArtifact>true</useProjectArtifact> - <unpack>true</unpack> - <scope>runtime</scope> - </dependencySet> - </dependencySets> - <fileSets> - <fileSet> - <directory>${project.build.directory}/jython-plugins-tmp/Lib/site-packages</directory> - <outputDirectory>Lib</outputDirectory> - <includes> - <include>**</include> - </includes> - </fileSet> - </fileSets> -</assembly> diff --git a/releasedocmaker/src/main/java/org/apache/yetus/releasedocmaker/ReleaseDocMaker.java b/releasedocmaker/src/main/java/org/apache/yetus/releasedocmaker/ReleaseDocMaker.java deleted file mode 100644 index 1b6e8db..0000000 --- a/releasedocmaker/src/main/java/org/apache/yetus/releasedocmaker/ReleaseDocMaker.java +++ /dev/null @@ -1,62 +0,0 @@ -/* - * 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. - */ -package org.apache.yetus.releasedocmaker; - -import java.util.Arrays; -import java.util.LinkedList; -import java.util.List; - -import org.python.core.Py; -import org.python.core.PyException; -import org.python.core.PySystemState; -import org.python.util.PythonInterpreter; - -import org.apache.yetus.audience.InterfaceAudience; -import org.apache.yetus.audience.InterfaceStability; - -/** - * Jython-based interface to releasedocmaker. - */ - -public class ReleaseDocMaker { - /** - * - * This method calls the main() method of the shelldocs Python program. - * - * @param args argument string - * @throws PyException standard exception thrown for Jython - */ - - @InterfaceAudience.Public - @InterfaceStability.Evolving - public static void main(final String[] args) throws PyException { - List<String> list = new LinkedList<String>(Arrays.asList(args)); - list.add(0,"releasedocmaker"); - String[] newargs = list.toArray(new String[list.size()]); - PythonInterpreter.initialize(System.getProperties(), System.getProperties(), newargs); - PySystemState systemState = Py.getSystemState(); - PythonInterpreter interpreter = new PythonInterpreter(); - systemState.__setattr__("_jy_interpreter", Py.java2py(interpreter)); - String command = "try:\n " - + " import releasedocmaker\n " - + " releasedocmaker.main()\n" - + "except " - + " SystemExit: pass"; - interpreter.exec(command); - } -} diff --git a/shelldocs/pom.xml b/shelldocs/pom.xml index 5226dc9..c44741d 100644 --- a/shelldocs/pom.xml +++ b/shelldocs/pom.xml @@ -31,20 +31,7 @@ <artifactId>shelldocs</artifactId> <description>API Documentation for Shell Scripts</description> <name>Apache Yetus - shelldocs</name> - <packaging>jar</packaging> - - <dependencies> - <dependency> - <groupId>org.python</groupId> - <artifactId>jython-slim</artifactId> - <version>${jython-slim.version}</version> - </dependency> - <dependency> - <groupId>org.apache.yetus</groupId> - <artifactId>audience-annotations</artifactId> - <version>${project.version}</version> - </dependency> - </dependencies> + <packaging>pom</packaging> <build> @@ -57,23 +44,6 @@ <plugins> <plugin> - <groupId>net.sf.mavenjython</groupId> - <artifactId>jython-compile-maven-plugin</artifactId> - <version>${jython-compile-maven-plugin.version}</version> - <executions> - <execution> - <phase>package</phase> - <goals> - <goal>jython</goal> - </goals> - <configuration> - <temporaryBuildDirectory>${project.build.directory}/jython-plugins-tmp/</temporaryBuildDirectory> - </configuration> - </execution> - </executions> - </plugin> - - <plugin> <artifactId>maven-assembly-plugin</artifactId> <dependencies> <dependency> @@ -86,24 +56,6 @@ <executions> <execution> - <id>make-jar-assembly</id> - <phase>package</phase> - <goals> - <goal>single</goal> - </goals> - <configuration> - <archive> - <manifest> - <mainClass>org.apache.yetus.shelldocs.ShellDocs</mainClass> - </manifest> - </archive> - <descriptorRefs> - <descriptorRef>jar-with-dependencies</descriptorRef> - </descriptorRefs> - </configuration> - </execution> - - <execution> <id>build</id> <phase>prepare-package</phase> <goals> diff --git a/shelldocs/src/main/java/org/apache/yetus/shelldocs/ShellDocs.java b/shelldocs/src/main/java/org/apache/yetus/shelldocs/ShellDocs.java deleted file mode 100644 index 0ed6eff..0000000 --- a/shelldocs/src/main/java/org/apache/yetus/shelldocs/ShellDocs.java +++ /dev/null @@ -1,62 +0,0 @@ -/* - * 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. - */ -package org.apache.yetus.shelldocs; - -import java.util.Arrays; -import java.util.LinkedList; -import java.util.List; - -import org.python.core.Py; -import org.python.core.PyException; -import org.python.core.PySystemState; -import org.python.util.PythonInterpreter; - -import org.apache.yetus.audience.InterfaceAudience; -import org.apache.yetus.audience.InterfaceStability; - -/** - * Jython-based interface to shelldocs. - */ - -public class ShellDocs { - /** - * - * This method calls the main() method of the shelldocs Python program. - * - * @param args argument string - * @throws PyException standard exception thrown for Jython - */ - - @InterfaceAudience.Public - @InterfaceStability.Evolving - public static void main(final String[] args) throws PyException { - List<String> list = new LinkedList<String>(Arrays.asList(args)); - list.add(0,"shelldocs"); - String[] newargs = list.toArray(new String[list.size()]); - PythonInterpreter.initialize(System.getProperties(), System.getProperties(), newargs); - PySystemState systemState = Py.getSystemState(); - PythonInterpreter interpreter = new PythonInterpreter(); - systemState.__setattr__("_jy_interpreter", Py.java2py(interpreter)); - String command = "try:\n" - + " import shelldocs\n" - + " shelldocs.main()\n" - + "except" - + " SystemExit: pass"; - interpreter.exec(command); - } -} diff --git a/yetus-maven-plugin/pom.xml b/yetus-maven-plugin/pom.xml index 0069d95..f3e2e47 100644 --- a/yetus-maven-plugin/pom.xml +++ b/yetus-maven-plugin/pom.xml @@ -56,18 +56,6 @@ <version>${maven.api.version}</version> <scope>provided</scope> </dependency> - <dependency> - <groupId>org.apache.yetus</groupId> - <artifactId>releasedocmaker</artifactId> - <version>${project.version}</version> - <classifier>jar-with-dependencies</classifier> - </dependency> - <dependency> - <groupId>org.apache.yetus</groupId> - <artifactId>shelldocs</artifactId> - <version>${project.version}</version> - <classifier>jar-with-dependencies</classifier> - </dependency> </dependencies> <build> diff --git a/yetus-maven-plugin/src/main/java/org/apache/yetus/maven/plugin/rdm/ReleaseDocMakerMojo.java b/yetus-maven-plugin/src/main/java/org/apache/yetus/maven/plugin/rdm/ReleaseDocMakerMojo.java deleted file mode 100644 index c1c9810..0000000 --- a/yetus-maven-plugin/src/main/java/org/apache/yetus/maven/plugin/rdm/ReleaseDocMakerMojo.java +++ /dev/null @@ -1,274 +0,0 @@ -/* - * Licensed 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. - */ -package org.apache.yetus.maven.plugin.rdm; - -import java.io.File; -import java.util.ArrayList; - -import org.apache.maven.plugin.AbstractMojo; -import org.apache.maven.plugin.MojoExecutionException; -import org.apache.maven.plugins.annotations.LifecyclePhase; -import org.apache.maven.plugins.annotations.Mojo; -import org.apache.maven.plugins.annotations.Parameter; - -import org.apache.yetus.audience.InterfaceAudience; -import org.apache.yetus.audience.InterfaceStability; -import org.apache.yetus.releasedocmaker.ReleaseDocMaker; - -/** - * Goal which executes releasedocmaker. - */ -@Mojo(name = "releasedocmaker", - defaultPhase = LifecyclePhase.PRE_SITE, - threadSafe = true) [email protected] [email protected] -public final class ReleaseDocMakerMojo extends AbstractMojo { - - /** - * Location of output. - */ - @Parameter - private String baseUrl; - - /** - * Location of the dirName. - */ - @Parameter(defaultValue = "${project.build.directory}") - private File buildDir; - - /** - * Create diretory versions. - */ - @Parameter(defaultValue = "false") - private Boolean dirversions; - - /** - * Allow empty files. - */ - @Parameter(defaultValue = "false") - private Boolean empty; - - /** - * Create file versions. - */ - @Parameter(defaultValue = "false") - private Boolean fileversions; - - /** - * label for incompatible issues. - */ - @Parameter - private String incompatibleLabel; - - /** - * Create an index. - */ - @Parameter(defaultValue = "false") - private Boolean index; - - /** - * Put the ASF License on generated files. - */ - @Parameter(defaultValue = "false") - private Boolean license; - - /** - * Run in --lint mode. - */ - @Deprecated - @Parameter(defaultValue = "false") - private Boolean lint; - - /** - * lint filters. - */ - @Parameter - private String[] lintFilters; - - /** - * Location of output. - */ - @Parameter(defaultValue = "${project.build.directory}/generated-site/markdown") - private String outputDir; - - /** - * Put the ASF License on generated files. - */ - @Parameter(defaultValue = "${project.name}") - private String[] projects; - - /** - * Title of project. - */ - @Parameter - private String projectTitle; - - /** - * Treat versions as a range. - */ - @Parameter(defaultValue = "false") - private Boolean range; - - /** - * Number of times to retry the HTTPS connection. - */ - @Parameter - private Integer retries; - - /** - * Drop reporter/assignee. - */ - @Parameter(defaultValue = "false") - private Boolean skipcredits; - - /** - * Set the sort order. - */ - @Parameter - private String sortorder; - - /** - * Set the type order. - */ - @Parameter - private String sorttype; - - - /** - * Use today. - */ - @Parameter(defaultValue = "false") - private Boolean useToday; - - /** - * Version to generate. - */ - @Parameter(defaultValue = "${project.version}") - private String[] versions; - - /** - * Build our argument list to pass to the executor. - */ - private ArrayList<String> argList = new ArrayList<String>(); - - /** - * Execute our plugin. - * @throws MojoExecutionException an error occurred - */ - @InterfaceAudience.Private - @InterfaceStability.Unstable - public void execute() throws MojoExecutionException { - - buildArgs(); - String[] args = argList.toArray(new String[0]); - - ReleaseDocMaker rdm = new ReleaseDocMaker(); - rdm.main(args); - } - - - /** - * Based upon what we got from maven, build our rdm command line params. - */ - private void buildArgs() { - - if (baseUrl != null) { - argList.add("--baseurl"); - argList.add(baseUrl); - } - - if (dirversions) { - argList.add("--dirversions"); - } - - if (empty) { - argList.add("--empty"); - } - - if (fileversions) { - argList.add("--fileversions"); - } - - if (incompatibleLabel != null) { - argList.add("--incompatiblelabel"); - argList.add(incompatibleLabel); - } - - if (index) { - argList.add("--index"); - } - - if (license) { - argList.add("--license"); - } - - if (lint) { - argList.add("--lint"); - argList.add("all"); - } - - for (String f: lintFilters) { - argList.add("--lint"); - argList.add(f); - } - - argList.add("--outputdir"); - argList.add(outputDir); - - for (String p: projects) { - argList.add("--project"); - argList.add(p); - } - - if (projectTitle != null) { - argList.add("--projecttitle"); - argList.add(projectTitle); - } - - if (range) { - argList.add("--range"); - } - - if (retries != null) { - argList.add("--retries"); - argList.add(retries.toString()); - } - - if (skipcredits) { - argList.add("--skipcredits"); - } - - if (sortorder != null) { - argList.add("--sortorder"); - argList.add(sortorder); - } - - if (sorttype != null) { - argList.add("--sorttype"); - argList.add(sorttype); - } - - if (useToday) { - argList.add("--usetoday"); - } - - for (String v: versions) { - argList.add("--version"); - argList.add(v); - } - - } - -} diff --git a/yetus-maven-plugin/src/main/java/org/apache/yetus/maven/plugin/rdm/package-info.java b/yetus-maven-plugin/src/main/java/org/apache/yetus/maven/plugin/rdm/package-info.java deleted file mode 100644 index 04067bd..0000000 --- a/yetus-maven-plugin/src/main/java/org/apache/yetus/maven/plugin/rdm/package-info.java +++ /dev/null @@ -1,22 +0,0 @@ -/* - * 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. - */ - -/** - * Utilities for running releasedocmaker. - */ -package org.apache.yetus.maven.plugin.rdm; diff --git a/yetus-maven-plugin/src/main/java/org/apache/yetus/maven/plugin/shelldocs/ShellDocsMojo.java b/yetus-maven-plugin/src/main/java/org/apache/yetus/maven/plugin/shelldocs/ShellDocsMojo.java deleted file mode 100644 index 05bd59f..0000000 --- a/yetus-maven-plugin/src/main/java/org/apache/yetus/maven/plugin/shelldocs/ShellDocsMojo.java +++ /dev/null @@ -1,106 +0,0 @@ -/* - * Licensed 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. - */ -package org.apache.yetus.maven.plugin.shelldocs; - -import java.util.ArrayList; - -import org.apache.maven.plugin.AbstractMojo; -import org.apache.maven.plugin.MojoExecutionException; -import org.apache.maven.plugins.annotations.LifecyclePhase; -import org.apache.maven.plugins.annotations.Mojo; -import org.apache.maven.plugins.annotations.Parameter; - -import org.apache.yetus.audience.InterfaceAudience; -import org.apache.yetus.audience.InterfaceStability; -import org.apache.yetus.shelldocs.ShellDocs; - -/** - * Goal which executes releasedocmaker. - */ -@Mojo(name = "shelldocs", - defaultPhase = LifecyclePhase.PRE_SITE, - threadSafe = true) [email protected] [email protected] -public final class ShellDocsMojo extends AbstractMojo { - - /** - * Run in --lint mode. - */ - @Parameter(defaultValue = "false") - private Boolean lint; - - /** - * Run in --skipprnorep mode. - */ - @Parameter(defaultValue = "false") - private Boolean skipprnorep; - - /** - * Location of output. - */ - @Parameter(defaultValue = "${project.build.directory}/generated-site/markdown/${project.name}.md") - private String output; - - /** - * Version to generate. - */ - @Parameter(defaultValue = "${project.basedir}/src/main/shell") - private String[] inputs; - - /** - * Build our argument list to pass to the executor. - */ - private ArrayList<String> argList = new ArrayList<String>(); - - /** - * Execute our plugin. - * @throws MojoExecutionException an error occurred - */ - @InterfaceAudience.Private - @InterfaceStability.Unstable - public void execute() throws MojoExecutionException { - - buildArgs(); - String[] args = argList.toArray(new String[0]); - - ShellDocs shelldocs = new ShellDocs(); - shelldocs.main(args); - } - - - /** - * Based upon what we got from maven, build our shelldocs command line params. - */ - private void buildArgs() { - - if (lint) { - argList.add("--lint"); - } - - argList.add("--output"); - argList.add(output); - - for (String p: inputs) { - argList.add("--input"); - argList.add(p); - } - - if (skipprnorep) { - argList.add("--skipprnorep"); - } - - } - -} diff --git a/yetus-maven-plugin/src/main/java/org/apache/yetus/maven/plugin/shelldocs/package-info.java b/yetus-maven-plugin/src/main/java/org/apache/yetus/maven/plugin/shelldocs/package-info.java deleted file mode 100644 index 1a83c36..0000000 --- a/yetus-maven-plugin/src/main/java/org/apache/yetus/maven/plugin/shelldocs/package-info.java +++ /dev/null @@ -1,22 +0,0 @@ -/* - * 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. - */ - -/** - * Utilities for running releasedocmaker. - */ -package org.apache.yetus.maven.plugin.shelldocs;
