refactor project yaml-doc-maven-plugin into openapi-doc-maven-plugin

fugerit-org/openapi-doc-tool#1

Author: fugerit79

.github/workflows/deploy_maven_package.yml

@@ -24,7 +24,7 @@ jobs:
         java-version: '17'
         distribution: 'corretto'
         cache: maven
-        server-id: ossrh
+        server-id: ${{ vars.MAVEN_SERVERID }}
         server-username: MAVEN_USERNAME
         server-password: MAVEN_PASSWORD
     - name: Import gpg
@@ -34,5 +34,5 @@ jobs:
     - name: Publish package
       run: mvn --batch-mode deploy -P doRelease
       env:
-        MAVEN_USERNAME: ${{ secrets.OSS_USERNAME }}
-        MAVEN_PASSWORD: ${{ secrets.OSS_PASSWORD }}
+        MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
+        MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.0] - 2025-07-27
+
+### Changed
+
+- refactor project yaml-doc-maven-plugin into openapi-doc-maven-plugin <https://github.com/fugerit-org/openapi-doc-tool/issues/1>
+
 ### Removed
 
 - [workflow sonar cloud](.github/workflows/sonarcloud-maven.yml)

README.md

@@ -1,12 +1,12 @@
-# yaml-doc-maven-plugin
+# openapi-doc-maven-plugin
 
-Simple maven plugin for [yaml-doc-tool](https://github.com/fugerit-org/yaml-doc-tool) project.
+Simple maven plugin for [openapi-doc-tool](https://github.com/fugerit-org/openapi-doc-tool) project.
 
 [![Keep a Changelog v1.1.0 badge](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.1.0-%23E05735)](CHANGELOG.md) 
-[![Maven Central](https://img.shields.io/maven-central/v/org.fugerit.java/yaml-doc-maven-plugin.svg)](https://mvnrepository.com/artifact/org.fugerit.java/yaml-doc-maven-plugin)
+[![Maven Central](https://img.shields.io/maven-central/v/org.fugerit.java/openapi-doc-maven-plugin.svg)](https://mvnrepository.com/artifact/org.fugerit.java/openapi-doc-maven-plugin)
 [![license](https://img.shields.io/badge/License-Apache%20License%202.0-teal.svg)](https://opensource.org/licenses/Apache-2.0)
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_yaml-doc-maven-plugin&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=fugerit-org_yaml-doc-maven-plugin)
-[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_yaml-doc-maven-plugin&metric=coverage)](https://sonarcloud.io/summary/new_code?id=fugerit-org_yaml-doc-maven-plugin)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_openapi-doc-maven-plugin&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=fugerit-org_openapi-doc-maven-plugin)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_openapi-doc-maven-plugin&metric=coverage)](https://sonarcloud.io/summary/new_code?id=fugerit-org_openapi-doc-maven-plugin)
 
 Accepted config params are :  
 * configPath
@@ -17,10 +17,10 @@ Here a sample configuration  :
 ```
 			<plugin>
 				<groupId>org.fugerit.java</groupId>
-				<artifactId>yaml-doc-maven-plugin</artifactId>
-				<version>${yaml-doc-version}</version>	
+				<artifactId>openapi-doc-maven-plugin</artifactId>
+				<version>${openapi-doc-version}</version>	
 				<configuration>
-					<configPath>src/config/yaml-doc-config.xml</configPath>
+					<configPath>src/config/openapi-doc-config.xml</configPath>
 					<idCatalog>openapi</idCatalog>		
 				</configuration>							
 				<executions>

pom.xml

@@ -2,37 +2,37 @@
 	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>
 
-	<artifactId>yaml-doc-maven-plugin</artifactId>
+	<artifactId>openapi-doc-maven-plugin</artifactId>
 
 	<parent>
 		<groupId>org.fugerit.java</groupId>
 		<artifactId>fj-bom</artifactId>
-		<version>1.7.4</version>
+		<version>2.0.3</version>
 		<relativePath></relativePath>
 	</parent>
 
-	<version>1.0.3</version>
+	<version>2.0.0</version>
 	<packaging>maven-plugin</packaging>
 
-	<name>yaml-doc-maven-plugin</name>
-	<description>Simple maven plugin for the yaml-doc-tool project</description>
+	<name>openapi-doc-maven-plugin</name>
+	<description>Simple maven plugin for the openapi-doc-tool project</description>
 	<url>http://www.fugerit.org/</url>
 
 	<scm>
-		<connection>scm:git:git://github.com/fugerit-org/yaml-doc-maven-plugin.git</connection>
-		<developerConnection>scm:git:ssh://github.com/fugerit-org/yaml-doc-maven-plugin.git</developerConnection>
-		<url>http://github.com/fugerit-org/yaml-doc-maven-plugin/tree/main</url>
+		<connection>scm:git:git://github.com/fugerit-org/openapi-doc-maven-plugin.git</connection>
+		<developerConnection>scm:git:ssh://github.com/fugerit-org/openapi-doc-maven-plugin.git</developerConnection>
+		<url>http://github.com/fugerit-org/openapi-doc-maven-plugin/tree/main</url>
 	</scm>
 
 	<properties>
 		<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>
+		<openapi-doc-version>${project.version}</openapi-doc-version>
 	    <!-- sonar cloud configuration -->
 		<sonar.host.url>https://sonarcloud.io</sonar.host.url>
 		<sonar.organization>fugerit-org</sonar.organization>
-		<sonar.projectKey>fugerit-org_yaml-doc-maven-plugin</sonar.projectKey>
+		<sonar.projectKey>fugerit-org_openapi-doc-maven-plugin</sonar.projectKey>
 	</properties>
 
 	<licenses>
@@ -81,8 +81,8 @@
 
 		<dependency>
 			<groupId>org.fugerit.java</groupId>
-			<artifactId>yaml-doc-tool</artifactId>
-			<version>${yaml-doc-version}</version>
+			<artifactId>openapi-doc-tool</artifactId>
+			<version>${openapi-doc-version}</version>
 		</dependency>
 		<dependency>
 			<groupId>org.slf4j</groupId>

src/main/java/org/fugerit/java/yaml/doc/maven/MojoGenerate.java renamed to src/main/java/org/fugerit/java/openapi/doc/maven/MojoGenerate.java

@@ -1,14 +1,15 @@
-package org.fugerit.java.yaml.doc.maven;
+package org.fugerit.java.openapi.doc.maven;
 
 import java.util.Properties;
 
 import org.apache.maven.plugin.AbstractMojo;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugins.annotations.Mojo;
 import org.apache.maven.plugins.annotations.Parameter;
-import org.fugerit.java.yaml.doc.YamlDocMain;
+
 
 import lombok.Setter;
+import org.fugerit.java.openapi.doc.OpenAPIDocMain;
 
 @Mojo( name = "generate")
 public class MojoGenerate extends AbstractMojo {
@@ -22,11 +23,11 @@ public class MojoGenerate extends AbstractMojo {
     public void execute() throws MojoExecutionException {
         try {
         	Properties props = new Properties();
-        	props.setProperty( YamlDocMain.ARG_MODE , YamlDocMain.ARG_MODE_CONFIG );
-        	props.setProperty( YamlDocMain.ARG_CONFIG_PATH , this.configPath );
-        	props.setProperty( YamlDocMain.ARG_ID_CATALOG , this.idCatalog );
+        	props.setProperty( OpenAPIDocMain.ARG_MODE , OpenAPIDocMain.ARG_MODE_CONFIG );
+        	props.setProperty( OpenAPIDocMain.ARG_CONFIG_PATH , this.configPath );
+        	props.setProperty( OpenAPIDocMain.ARG_ID_CATALOG , this.idCatalog );
         	this.getLog().info( "props : "+props );
-        	YamlDocMain.worker( props );
+            OpenAPIDocMain.worker( props );
         } catch (Exception e) {
         	throw new MojoExecutionException( "Error generating code : "+e, e );
         }

src/test/java/test/org/fugerit/java/yaml/doc/maven/TestMojoGenerate.java renamed to src/test/java/org/fugerit/java/openapi/doc/maven/TestMojoGenerate.java

@@ -1,10 +1,10 @@
-package test.org.fugerit.java.yaml.doc.maven;
+package org.fugerit.java.openapi.doc.maven;
 
 import java.io.File;
 
 import org.apache.maven.plugin.MojoExecutionException;
 import org.fugerit.java.core.function.SafeFunction;
-import org.fugerit.java.yaml.doc.maven.MojoGenerate;
+import org.fugerit.java.openapi.doc.maven.MojoGenerate;
 import org.junit.Assert;
 import org.junit.Test;
 
@@ -17,7 +17,7 @@ public class TestMojoGenerate {
 	public void testMojoeGenerate001() {
 		SafeFunction.apply( () -> {
 			MojoGenerate generate = new MojoGenerate();
-			generate.setConfigPath( "src/test/resources/yaml-doc-config.xml" );
+			generate.setConfigPath( "src/test/resources/openapi-doc-config.xml" );
 			generate.setIdCatalog( "sample" );
 			generate.execute();
 			File pdf = new File( "target/sample.pdf" );