changelog to html maven plugin

[TOC]

简介

• java web 项目 CHANGELOG.md 转换为 html 文件 maven 插件
• 用来将 CHANGELOG.md 转换为浏览器可访问的项目 version 文件
• CHANGELOG.md 文件内容编写参考 keep a changelog
• 功能实现依赖 flexmark-java

使用

• 单文件

  <build>
      <plugins>
          <plugin>
              <groupId>world.weibiansanjue.maven</groupId>
              <artifactId>changelog2html-maven-plugin</artifactId>
              <version>${cl-version}</version>
              <executions>
                  <execution>
                      <goals>
                          <goal>convert</goal>
                      </goals>
                  </execution>
              </executions>
              <configuration>
                  <!-- 文件输入路径-->
                  <inputFile>{project.basedir}/CHANGELOG.md</inputFile>
                  <!-- 文件输出路径 -->
                  <outputFile>${project.basedir}/web/version.html</outputFile>
                  <!-- 标题 -->
                  <title>version</title>
              </configuration>
          </plugin>
      </plugins>
  </build>

• 多文件

  <build>
      <plugins>
          <plugin>
              <groupId>world.weibiansanjue.maven</groupId>
              <artifactId>changelog2html-maven-plugin</artifactId>
              <version>${cl-version}</version>
              <executions>
                  <execution>
                      <goals>
                          <goal>convert</goal>
                      </goals>
                  </execution>
              </executions>
              <configuration>
                  <files>
                      <file>
                        <!-- 文件输入路径-->
                        <inputFile>{project.basedir}/CHANGELOG.md</inputFile>
                        <!-- 文件输出路径 -->
                        <outputFile>${project.basedir}/web/version.html</outputFile>
                        <!-- 自定义参数 -->
                        <params>
                            <!-- 标题 -->
                            <title>version</title>
                            <!-- 目录级别 2(default)、3、4 -->
                            <tocLevel>3</tocLevel>
                        </params>
                      </file>
                      <file>
                          ......
                      </file>
                  </files>
              </configuration>
          </plugin>
      </plugins>
  </build>

CHANGELOG.md 模板

<!-- ## unreleased / vX.Y.Z    -->
<!-- ### 新功能(Added)           -->
<!-- ### 缺陷修复(Fixed)          -->
<!-- ### 功能变更(Changed)        -->
<!-- ### 优化、重构(Refactor)      -->
<!-- ### 即将废弃功能(Deprecated)  -->
<!-- ### 已废弃功能(Removed)      -->
<!-- ### 安全问题修复(Security)    -->

## unreleased / vX.Y.Z

### 新功能(Added)

### 缺陷修复(Fixed)

### 功能变更(Changed)

### 优化、重构(Refactor)

### 即将废弃功能(Deprecated)

### 已废弃功能(Removed)

### 安全问题修复(Security)

效果