Refactor: added auto-generated readable readme file to releases

This commit is contained in:
Oleg Agafonov 2023-03-12 13:56:29 +04:00
parent 7880d6cc43
commit e2271d79fb
7 changed files with 62 additions and 3 deletions

View File

@ -215,6 +215,10 @@
</descriptors>
</configuration>
</plugin>
<plugin>
<groupId>com.ruleoftech</groupId>
<artifactId>markdown-page-generator-plugin</artifactId>
</plugin>
</plugins>
<finalName>mage-client</finalName>

View File

@ -37,8 +37,16 @@
<filtered>true</filtered>
<directory>../</directory>
<includes>
<include>readme.md</include>
<include>LICENSE.txt</include>
<include>readme.md</include>
</includes>
<outputDirectory>/</outputDirectory>
</fileSet>
<fileSet>
<filtered>true</filtered>
<directory>${project.build.directory}/docs/</directory>
<includes>
<include>readme.html</include>
</includes>
<outputDirectory>/</outputDirectory>
</fileSet>

View File

@ -62,6 +62,10 @@
</descriptors>
</configuration>
</plugin>
<plugin>
<groupId>com.ruleoftech</groupId>
<artifactId>markdown-page-generator-plugin</artifactId>
</plugin>
</plugins>
<finalName>mage-serverconsole</finalName>

View File

@ -28,8 +28,16 @@
<filtered>true</filtered>
<directory>../</directory>
<includes>
<include>readme.md</include>
<include>LICENSE.txt</include>
<include>readme.md</include>
</includes>
<outputDirectory>/</outputDirectory>
</fileSet>
<fileSet>
<filtered>true</filtered>
<directory>${project.build.directory}/docs/</directory>
<includes>
<include>readme.html</include>
</includes>
<outputDirectory>/</outputDirectory>
</fileSet>

View File

@ -352,6 +352,10 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
</plugin>
<plugin>
<groupId>com.ruleoftech</groupId>
<artifactId>markdown-page-generator-plugin</artifactId>
</plugin>
</plugins>
<finalName>mage-server</finalName>

View File

@ -54,8 +54,16 @@
<filtered>true</filtered>
<directory>../</directory>
<includes>
<include>readme.md</include>
<include>LICENSE.txt</include>
<include>readme.md</include>
</includes>
<outputDirectory>/</outputDirectory>
</fileSet>
<fileSet>
<filtered>true</filtered>
<directory>${project.build.directory}/docs/</directory>
<includes>
<include>readme.html</include>
</includes>
<outputDirectory>/</outputDirectory>
</fileSet>

23
pom.xml
View File

@ -116,11 +116,34 @@
<version>2.7</version>
</plugin>
<!-- devs only: allows to run apps from command line by exec:java command -->
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>3.0.0</version>
</plugin>
<!-- generate readable readme file for releases -->
<!-- results uses in distribution.xml -->
<!-- https://github.com/walokra/markdown-page-generator-plugin -->
<plugin>
<groupId>com.ruleoftech</groupId>
<artifactId>markdown-page-generator-plugin</artifactId>
<version>2.4.0</version>
<executions>
<execution>
<phase>process-resources</phase>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
<configuration>
<inputDirectory>../</inputDirectory>
<inputFileExtensions>md</inputFileExtensions>
<outputDirectory>${project.build.directory}/docs</outputDirectory>
</configuration>
</plugin>
</plugins>
</pluginManagement>
</build>