0.3.0 (2022-11-27)

+ Changed parent pom version (fj-bom) to 0.2.3 * Updated documentation * Updated to yaml-doc-tool 0.3.0
fugerit-org · Nov 27, 2022 · c0d44d6 · c0d44d6
1 parent 6889a6a
commit c0d44d6
Show file tree

Hide file tree

Showing 4 changed files with 148 additions and 87 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,106 @@
-/target/
-/.classpath
-/.project
-/.settings/
+### Idea Intellij ###
+.idea/
+*.iml
+
+### Eclipse ###
+
+.metadata
+bin/
+tmp/
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.settings/
+.loadpath
+.recommenders
+
+.vscode/
+
+# Eclipse Core
+.project
+
+# External tool builders
+.externalToolBuilders/
+
+# Locally stored "Eclipse launch configurations"
+*.launch
+
+# PyDev specific (Python IDE for Eclipse)
+*.pydevproject
+
+# CDT-specific (C/C++ Development Tooling)
+.cproject
+
+# JDT-specific (Eclipse Java Development Tools)
+.classpath
+
+# Java annotation processor (APT)
+.factorypath
+
+# PDT-specific (PHP Development Tools)
+.buildpath
+
+# sbteclipse plugin
+.target
+
+# Tern plugin
+.tern-project
+
+# TeXlipse plugin
+.texlipse
+
+# STS (Spring Tool Suite)
+.springBeans
+
+# Code Recommenders
+.recommenders/
+
+# Scala IDE specific (Scala & Java development for Eclipse)
+.cache-main
+.scala_dependencies
+.worksheet
+
+### Java ###
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+
+### Maven ###
+target/
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+pom.xml.next
+release.properties
+dependency-reduced-pom.xml
+buildNumber.properties
+.mvn/timing.properties
+
+# Avoid ignoring Maven wrapper jar file (.jar files are usually ignored)
+!/.mvn/wrapper/maven-wrapper.jar
+
+# End of https://www.gitignore.io/api/java,maven,eclipse
+
+/.apt_generated/
+/.apt_generated_tests/
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,5 @@
+0.3.0 (2022-11-27)
+------------------
++ Changed parent pom version (fj-bom) to 0.2.3
+* Updated documentation
+* Updated to yaml-doc-tool 0.3.0
diff --git a/README.md b/README.md
@@ -1,24 +1,29 @@
-# yaml-doc-tool
+# yaml-doc-maven-plugin
 
-Tool for auto documentation of yaml / openapi
+Simple maven plugin for [yaml-doc-tool](https://github.com/fugerit-org/yaml-doc-tool) project.
 
-**Usage:**  
+Accepted config params are :  
+* configPath
+* idCatalog
 
-java -jar dist-yaml-doc-tool-X.X.X.jar --input-yaml [path-to-openapi]\
-										--output-file [output-file]\
-										--language [language]\
-										--labels-override [path-to-labels-properties]
-
-**example :**  
+Here a sample configuration  :
 
-java -jar dist-yaml-doc-tool-0.1.0.jar --input-yaml sample.yaml --output-file sample.pdf --language it
-
-**output-file**   
-currently supported extensions : pdf, xlsx, xml
-
-**language**  
-currently supported languages : it, en
-
-**labels-overrides**   
-path to alternate labels properties
-currently supported labels are available in : src/main/resources/lang/label.properties
+```
+			<plugin>
+				<groupId>org.fugerit.java</groupId>
+				<artifactId>yaml-doc-maven-plugin</artifactId>
+				<version>${yaml-doc-version}</version>	
+				<configuration>
+					<configPath>src/config/yaml-doc-config.xml</configPath>
+					<idCatalog>openapi</idCatalog>		
+				</configuration>							
+				<executions>
+					<execution>
+						<id>openapi</id>
+						<goals>
+							<goal>generate</goal>
+						</goals>
+					</execution>		
+				</executions>
+			</plugin>	
+```
diff --git a/pom.xml b/pom.xml
@@ -2,10 +2,16 @@
 	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 
-	<groupId>org.fugerit.java</groupId>
 	<artifactId>yaml-doc-maven-plugin</artifactId>
 
-	<version>0.2.4</version>
+	<parent>
+		<groupId>org.fugerit.java</groupId>
+		<artifactId>fj-bom</artifactId>
+		<version>0.2.3</version>
+		<relativePath></relativePath>
+	</parent>
+
+	<version>0.3.0</version>
 	<packaging>maven-plugin</packaging>
 
 	<name>yaml-doc-maven-plugin</name>
@@ -22,6 +28,7 @@
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 		<maven.compiler.target>1.8</maven.compiler.target>
 		<maven.compiler.source>1.8</maven.compiler.source>
+		<yaml-doc-version>${project.version}</yaml-doc-version>
 	</properties>
 
 	<licenses>
@@ -59,52 +66,25 @@
 		<dependency>
 			<groupId>org.apache.maven</groupId>
 			<artifactId>maven-plugin-api</artifactId>
-			<version>3.8.5</version>
+			<scope>provided</scope>
 		</dependency>
 
 		<dependency>
 			<groupId>org.apache.maven.plugin-tools</groupId>
 			<artifactId>maven-plugin-annotations</artifactId>
-			<version>3.6.4</version>
+			<scope>provided</scope>
 		</dependency>
 
 		<dependency>
 			<groupId>org.fugerit.java</groupId>
 			<artifactId>yaml-doc-tool</artifactId>
-			<version>${project.version}</version>
-		</dependency>
-
-		<!-- logging -->
-		<dependency>
-		    <groupId>org.apache.logging.log4j</groupId>
-		    <artifactId>log4j-core</artifactId>
-		    <version>2.17.0</version>
+			<version>${yaml-doc-version}</version>
 		</dependency>
 		<dependency>
 			<groupId>org.slf4j</groupId>
 			<artifactId>slf4j-api</artifactId>
-			<version>1.6.4</version>
 			<scope>compile</scope>
 		</dependency>
-		<dependency>
-		    <groupId>org.apache.logging.log4j</groupId>
-		    <artifactId>log4j-slf4j-impl</artifactId>
-		    <version>2.13.1</version>
-		</dependency>
-
-        <dependency>
-            <groupId>org.hsqldb</groupId>
-            <artifactId>hsqldb</artifactId>
-            <version>2.3.4</version>
-            <scope>test</scope>
-        </dependency>
-
-		<dependency>
-			<groupId>junit</groupId>
-			<artifactId>junit</artifactId>
-			<version>4.13.1</version>
-			<scope>test</scope>
-		</dependency>
 
 	</dependencies>
 
@@ -115,7 +95,6 @@
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-plugin-plugin</artifactId>
-				<version>3.6.0</version>
 			   <executions>
 			      <execution>
 			        <id>default-descriptor</id>
@@ -132,36 +111,6 @@
 			    </executions>	
 			</plugin>		
 
-			<plugin>
-				<groupId>org.apache.maven.plugins</groupId>
-				<artifactId>maven-source-plugin</artifactId>
-				<version>3.0.1</version>
-				<executions>
-					<execution>
-						<id>attach-sources</id>
-						<goals>
-							<goal>jar</goal>
-						</goals>
-					</execution>
-				</executions>
-			</plugin>
-			<plugin>
-				<groupId>org.apache.maven.plugins</groupId>
-				<artifactId>maven-javadoc-plugin</artifactId>
-				<version>2.10.4</version>
-				<configuration>
-					<stylesheetfile>src/main/javadoc/stylesheet.css</stylesheetfile>
-				</configuration>
-				<executions>
-					<execution>
-						<id>attach-javadocs</id>
-						<goals>
-							<goal>jar</goal>
-						</goals>
-					</execution>
-				</executions>
-			</plugin>		
-
 		</plugins>
 
 	</build>