Skip to content
This repository was archived by the owner on Jul 27, 2025. It is now read-only.

Commit c0d44d6

Browse files
fugerit79fugerit79
committed
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
1 parent 6889a6a commit c0d44d6

File tree

4 files changed

+148
-87
lines changed

4 files changed

+148
-87
lines changed

‎.gitignore‎

Lines changed: 106 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,106 @@
1-
/target/
2-
/.classpath
3-
/.project
4-
/.settings/
1+
### Idea Intellij ###
2+
.idea/
3+
*.iml
4+
5+
### Eclipse ###
6+
7+
.metadata
8+
bin/
9+
tmp/
10+
*.tmp
11+
*.bak
12+
*.swp
13+
*~.nib
14+
local.properties
15+
.settings/
16+
.loadpath
17+
.recommenders
18+
19+
.vscode/
20+
21+
# Eclipse Core
22+
.project
23+
24+
# External tool builders
25+
.externalToolBuilders/
26+
27+
# Locally stored "Eclipse launch configurations"
28+
*.launch
29+
30+
# PyDev specific (Python IDE for Eclipse)
31+
*.pydevproject
32+
33+
# CDT-specific (C/C++ Development Tooling)
34+
.cproject
35+
36+
# JDT-specific (Eclipse Java Development Tools)
37+
.classpath
38+
39+
# Java annotation processor (APT)
40+
.factorypath
41+
42+
# PDT-specific (PHP Development Tools)
43+
.buildpath
44+
45+
# sbteclipse plugin
46+
.target
47+
48+
# Tern plugin
49+
.tern-project
50+
51+
# TeXlipse plugin
52+
.texlipse
53+
54+
# STS (Spring Tool Suite)
55+
.springBeans
56+
57+
# Code Recommenders
58+
.recommenders/
59+
60+
# Scala IDE specific (Scala & Java development for Eclipse)
61+
.cache-main
62+
.scala_dependencies
63+
.worksheet
64+
65+
### Java ###
66+
# Compiled class file
67+
*.class
68+
69+
# Log file
70+
*.log
71+
72+
# BlueJ files
73+
*.ctxt
74+
75+
# Mobile Tools for Java (J2ME)
76+
.mtj.tmp/
77+
78+
# Package Files #
79+
*.jar
80+
*.war
81+
*.ear
82+
*.zip
83+
*.tar.gz
84+
*.rar
85+
86+
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
87+
hs_err_pid*
88+
89+
### Maven ###
90+
target/
91+
pom.xml.tag
92+
pom.xml.releaseBackup
93+
pom.xml.versionsBackup
94+
pom.xml.next
95+
release.properties
96+
dependency-reduced-pom.xml
97+
buildNumber.properties
98+
.mvn/timing.properties
99+
100+
# Avoid ignoring Maven wrapper jar file (.jar files are usually ignored)
101+
!/.mvn/wrapper/maven-wrapper.jar
102+
103+
# End of https://www.gitignore.io/api/java,maven,eclipse
104+
105+
/.apt_generated/
106+
/.apt_generated_tests/

‎CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
0.3.0 (2022-11-27)
2+
------------------
3+
+ Changed parent pom version (fj-bom) to 0.2.3
4+
* Updated documentation
5+
* Updated to yaml-doc-tool 0.3.0

‎README.md‎

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,29 @@
1-
# yaml-doc-tool
1+
# yaml-doc-maven-plugin
22

3-
Tool for auto documentation of yaml / openapi
3+
Simple maven plugin for [yaml-doc-tool](https://github.com/fugerit-org/yaml-doc-tool) project.
44

5-
**Usage:**
5+
Accepted config params are :
6+
* configPath
7+
* idCatalog
68

7-
java -jar dist-yaml-doc-tool-X.X.X.jar --input-yaml [path-to-openapi]\
8-
--output-file [output-file]\
9-
--language [language]\
10-
--labels-override [path-to-labels-properties]
11-
12-
**example :**
9+
Here a sample configuration :
1310

14-
java -jar dist-yaml-doc-tool-0.1.0.jar --input-yaml sample.yaml --output-file sample.pdf --language it
15-
16-
**output-file**
17-
currently supported extensions : pdf, xlsx, xml
18-
19-
**language**
20-
currently supported languages : it, en
21-
22-
**labels-overrides**
23-
path to alternate labels properties
24-
currently supported labels are available in : src/main/resources/lang/label.properties
11+
```
12+
<plugin>
13+
<groupId>org.fugerit.java</groupId>
14+
<artifactId>yaml-doc-maven-plugin</artifactId>
15+
<version>${yaml-doc-version}</version>
16+
<configuration>
17+
<configPath>src/config/yaml-doc-config.xml</configPath>
18+
<idCatalog>openapi</idCatalog>
19+
</configuration>
20+
<executions>
21+
<execution>
22+
<id>openapi</id>
23+
<goals>
24+
<goal>generate</goal>
25+
</goals>
26+
</execution>
27+
</executions>
28+
</plugin>
29+
```

‎pom.xml‎

Lines changed: 12 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,16 @@
22
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
33
<modelVersion>4.0.0</modelVersion>
44

5-
<groupId>org.fugerit.java</groupId>
65
<artifactId>yaml-doc-maven-plugin</artifactId>
76

8-
<version>0.2.4</version>
7+
<parent>
8+
<groupId>org.fugerit.java</groupId>
9+
<artifactId>fj-bom</artifactId>
10+
<version>0.2.3</version>
11+
<relativePath></relativePath>
12+
</parent>
13+
14+
<version>0.3.0</version>
915
<packaging>maven-plugin</packaging>
1016

1117
<name>yaml-doc-maven-plugin</name>
@@ -22,6 +28,7 @@
2228
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
2329
<maven.compiler.target>1.8</maven.compiler.target>
2430
<maven.compiler.source>1.8</maven.compiler.source>
31+
<yaml-doc-version>${project.version}</yaml-doc-version>
2532
</properties>
2633

2734
<licenses>
@@ -59,52 +66,25 @@
5966
<dependency>
6067
<groupId>org.apache.maven</groupId>
6168
<artifactId>maven-plugin-api</artifactId>
62-
<version>3.8.5</version>
69+
<scope>provided</scope>
6370
</dependency>
6471

6572
<dependency>
6673
<groupId>org.apache.maven.plugin-tools</groupId>
6774
<artifactId>maven-plugin-annotations</artifactId>
68-
<version>3.6.4</version>
75+
<scope>provided</scope>
6976
</dependency>
7077

7178
<dependency>
7279
<groupId>org.fugerit.java</groupId>
7380
<artifactId>yaml-doc-tool</artifactId>
74-
<version>${project.version}</version>
75-
</dependency>
76-
77-
<!-- logging -->
78-
<dependency>
79-
<groupId>org.apache.logging.log4j</groupId>
80-
<artifactId>log4j-core</artifactId>
81-
<version>2.17.0</version>
81+
<version>${yaml-doc-version}</version>
8282
</dependency>
8383
<dependency>
8484
<groupId>org.slf4j</groupId>
8585
<artifactId>slf4j-api</artifactId>
86-
<version>1.6.4</version>
8786
<scope>compile</scope>
8887
</dependency>
89-
<dependency>
90-
<groupId>org.apache.logging.log4j</groupId>
91-
<artifactId>log4j-slf4j-impl</artifactId>
92-
<version>2.13.1</version>
93-
</dependency>
94-
95-
<dependency>
96-
<groupId>org.hsqldb</groupId>
97-
<artifactId>hsqldb</artifactId>
98-
<version>2.3.4</version>
99-
<scope>test</scope>
100-
</dependency>
101-
102-
<dependency>
103-
<groupId>junit</groupId>
104-
<artifactId>junit</artifactId>
105-
<version>4.13.1</version>
106-
<scope>test</scope>
107-
</dependency>
10888

10989
</dependencies>
11090

@@ -115,7 +95,6 @@
11595
<plugin>
11696
<groupId>org.apache.maven.plugins</groupId>
11797
<artifactId>maven-plugin-plugin</artifactId>
118-
<version>3.6.0</version>
11998
<executions>
12099
<execution>
121100
<id>default-descriptor</id>
@@ -132,36 +111,6 @@
132111
</executions>
133112
</plugin>
134113

135-
<plugin>
136-
<groupId>org.apache.maven.plugins</groupId>
137-
<artifactId>maven-source-plugin</artifactId>
138-
<version>3.0.1</version>
139-
<executions>
140-
<execution>
141-
<id>attach-sources</id>
142-
<goals>
143-
<goal>jar</goal>
144-
</goals>
145-
</execution>
146-
</executions>
147-
</plugin>
148-
<plugin>
149-
<groupId>org.apache.maven.plugins</groupId>
150-
<artifactId>maven-javadoc-plugin</artifactId>
151-
<version>2.10.4</version>
152-
<configuration>
153-
<stylesheetfile>src/main/javadoc/stylesheet.css</stylesheetfile>
154-
</configuration>
155-
<executions>
156-
<execution>
157-
<id>attach-javadocs</id>
158-
<goals>
159-
<goal>jar</goal>
160-
</goals>
161-
</execution>
162-
</executions>
163-
</plugin>
164-
165114
</plugins>
166115

167116
</build>

0 commit comments

Comments
 (0)