Skip to content

Commit

Permalink
doc: Add changelog plugin to generate CHANGELOG.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@roman-marcu
roman-marcu committed Aug 29, 2024
1 parent 53fc5be commit c587a88
Show file tree
Hide file tree
Showing 3 changed files with 122 additions and 1 deletion.
86 changes: 86 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
## [Version 1.1.0-SNAPSHOT]

<ul>
<li>
<b>build</b> : use start version 1.0.0
</li>
<li>
<b>build</b> : revert back the first version
</li>
<li>
<b>build</b> : don't execute release workflow
</li>
<li>
<b>build</b> : don't execute release workflow
</li>
<li>
<b>build</b> : don't execute release workflow
</li>
<li>
<b>build</b> : add release tag only
</li>
<li>
<b>build</b> : revert back the version
</li>
<li>
<b>build</b> : define ci/cd for main branch
</li>
<li>
<b>build</b> : define ci/cd for main branch
</li>
<li>
<b>build</b> : update pom version
</li>
<li>
<b>feat</b> : Add maven release plugin
</li>
<li>
<b>build</b> : Add release job to circleCI
</li>
<li>
<b>build</b> : Add release job to circleCI
</li>
<li>
<b>build</b> : Add release job to circleCI
</li>
<li>
<b>build</b> : Add release job to circleCI
</li>
<li>
<b>build</b> : Add release job to circleCI
</li>
<li>
<b>build</b> : Add release job to circleCI
</li>
<li>
<b>build</b> : Add release job to circleCI
</li>
<li>
<b>build</b> : Add release job to circleCI
</li>
<li>
<b>build</b> : Add release job to circleCI
</li>
<li>
<b>build</b> : Add release job to circleCI
</li>
<li>
<b>build</b> : Add release job to circleCI
</li>
<li>
<b>feat</b> : Update README description
</li>
<li>
<b>feat</b> : prepare pom for releasing plugin to sonatype repository
</li>
<li>
<b>feat</b> : Add specific model class to be passed to the template engine
</li>
<li>
<b>doc</b> : Update badges
</li>
<li>
<b>feat</b> : Load template from external resource
</li>
</ul>

13 changes: 13 additions & 0 deletions changelog/CHANGELOG.md_en_US.ftl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<#ftl output_format="plainText" >
## [Version ${projectVersion}]

<#list commits>
<ul>
<#items as commit>
<li>
<b>${commit.type}</b> : ${commit.description}
</li>
</#items>
</ul>
</#list>

24 changes: 23 additions & 1 deletion pom.xml
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
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>io.github.roman-marcu</groupId>
Expand Down Expand Up @@ -209,6 +210,27 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>io.github.roman-marcu</groupId>
<artifactId>changelog-plugin</artifactId>
<version>1.0.0</version>
<executions>
<execution>
<id>generate-changelog</id>
<phase>package</phase>
<goals>
<goal>git-changelog</goal>
</goals>
<configuration>
<templateFilePath>./changelog/CHANGELOG.md.ftl
</templateFilePath>
<outputFilePath>./CHANGELOG.md</outputFilePath>
<startRevision>fff362b1</startRevision>
<endRevision>8ca87482</endRevision>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
Expand Down

0 comments on commit c587a88

Please sign in to comment.