feat: support conventional commits

Author: tomasbjerre

CHANGELOG.md

@@ -2,8 +2,26 @@
 
 Changelog of Git Changelog Maven plugin.
 
+## Unreleased
+### GitHub #31 
+
+**Merge pull request #31 from edeso/simplePlainTextExample**
+
+ * Add unescaped simple plain text example 
+
+[b22f0da746acfa7](https://github.com/tomasbjerre/git-changelog-maven-plugin/commit/b22f0da746acfa7) Tomas Bjerre *2021-05-25 14:07:41*
+
+
+### No issue
+
+**Add unescaped simple plain text example**
+
+
+[7f8db986669cdb9](https://github.com/tomasbjerre/git-changelog-maven-plugin/commit/7f8db986669cdb9) ed *2021-05-25 13:57:25*
+
+
 ## 1.69
-### GitHub [#27](https://github.com/tomasbjerre/git-changelog-maven-plugin/pull/27) Support custom headers to JIRA to bypass 2 factor auth
+### GitHub #27 
 
 **Merge pull request #27 from drhip/feature/extended_headers**
 
@@ -49,7 +67,7 @@ Changelog of Git Changelog Maven plugin.
 
 
 ## 1.65
-### GitHub [#24](https://github.com/tomasbjerre/git-changelog-maven-plugin/issues/24) Passing extendedVariables Property using mvn -D Commandline Option
+### GitHub #24 
 
 **More logging of extended variables from CLI #24**
 
@@ -68,7 +86,7 @@ Changelog of Git Changelog Maven plugin.
 
 
 ## 1.64
-### GitHub [#21](https://github.com/tomasbjerre/git-changelog-maven-plugin/issues/21) Goal not marked as Thread-safe
+### GitHub #21 
 
 **Mark as thread safe #21**
 
@@ -77,7 +95,7 @@ Changelog of Git Changelog Maven plugin.
 
 
 ## 1.63
-### GitHub [#19](https://github.com/tomasbjerre/git-changelog-maven-plugin/pull/19) Add support for pathfilter
+### GitHub #19 
 
 **Adjustments after merge of PR #19**
 
@@ -100,7 +118,7 @@ Changelog of Git Changelog Maven plugin.
 
 
 ## 1.62
-### GitHub [#18](https://github.com/tomasbjerre/git-changelog-maven-plugin/pull/18) Add extendedVariables property
+### GitHub #18 
 
 **Merge pull request #18 from djn72/master**
 
@@ -123,7 +141,7 @@ Changelog of Git Changelog Maven plugin.
 
 
 ## 1.61
-### GitHub [#12](https://github.com/tomasbjerre/git-changelog-maven-plugin/issues/12) Add a skip configration option
+### GitHub #12 
 
 **Adding skip option #12**
 
@@ -205,7 +223,7 @@ Changelog of Git Changelog Maven plugin.
 
 
 ## 1.55
-### GitHub [#10](https://github.com/tomasbjerre/git-changelog-maven-plugin/pull/10) docs: Updates README.md to improve readability
+### GitHub #10 
 
 **Merge pull request #10 from lennonjesus/patch-1**
 
@@ -287,7 +305,7 @@ Changelog of Git Changelog Maven plugin.
 
 
 ## 1.50
-### GitHub [#9](https://github.com/tomasbjerre/git-changelog-maven-plugin/issues/9) Issue when using removeIssueFromMessage and settingFile
+### GitHub #9 
 
 **Defaulting ignoreCommitsWithoutIssue #9**
 
@@ -451,7 +469,7 @@ Changelog of Git Changelog Maven plugin.
 
 
 ## 1.39
-### GitHub [#7](https://github.com/tomasbjerre/git-changelog-maven-plugin/pull/7) Fix fromCommit and fromRef property typo
+### GitHub #7 
 
 **Merge pull request #7 from dunse/patch-1**
 
@@ -739,7 +757,7 @@ Changelog of Git Changelog Maven plugin.
 
 
 ## 1.20
-### GitHub [#6](https://github.com/tomasbjerre/git-changelog-maven-plugin/issues/6) GitHub OAuth2 Token support
+### GitHub #6 
 
 **Support GitHub OAuth2 tokens #6**
 
@@ -837,7 +855,7 @@ Changelog of Git Changelog Maven plugin.
 
 
 ## 1.14
-### GitHub [#5](https://github.com/tomasbjerre/git-changelog-maven-plugin/issues/5) One line git commit messege
+### GitHub #5 
 
 **Added variables: messageTitle, messageBody, messageItems #5**
 
@@ -882,7 +900,7 @@ Changelog of Git Changelog Maven plugin.
 
 
 ## 1.12
-### GitHub [#4](https://github.com/tomasbjerre/git-changelog-maven-plugin/issues/4) The tags are out of order
+### GitHub #4 
 
 **Using lib 1.23 to sort commits by time, not formatted time #4**
 
@@ -904,7 +922,7 @@ Changelog of Git Changelog Maven plugin.
 
 
 ## 1.11
-### GitHub [#3](https://github.com/tomasbjerre/git-changelog-maven-plugin/issues/3) Enhance documentation for changelog.json file
+### GitHub #3 
 
 **Documentation and more configuration available in pom #3**
 
@@ -931,7 +949,7 @@ Changelog of Git Changelog Maven plugin.
 
 
 ## 1.10
-### GitHub [#2](https://github.com/tomasbjerre/git-changelog-maven-plugin/issues/2) Allow for template to be added directly in pom.xml
+### GitHub #2 
 
 **Template can be configured directly in the pom #2**
 
@@ -948,7 +966,7 @@ Changelog of Git Changelog Maven plugin.
 
 
 ## 1.9
-### GitHub [#1](https://github.com/tomasbjerre/git-changelog-maven-plugin/issues/1) Update to lates lib version
+### GitHub #1 
 
 **Using lib 1.17 #1**
 
@@ -965,7 +983,7 @@ Changelog of Git Changelog Maven plugin.
 
 
 ## 1.8
-### GitHub [#1](https://github.com/tomasbjerre/git-changelog-maven-plugin/issues/1) Update to lates lib version
+### GitHub #1 
 
 **Using lib 1.15 #1**
 
@@ -1002,7 +1020,7 @@ Changelog of Git Changelog Maven plugin.
 
 
 ## 1.5
-### GitHub [#1](https://github.com/tomasbjerre/git-changelog-maven-plugin/issues/1) Update to lates lib version
+### GitHub #1 
 
 **Using lib 1.12 #1**
 

README.md

@@ -1,10 +1,12 @@
 # Git Changelog Maven Plugin
+
 [![Build Status](https://travis-ci.org/tomasbjerre/git-changelog-maven-plugin.svg?branch=master)](https://travis-ci.org/tomasbjerre/git-changelog-maven-plugin)
 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/se.bjurr.gitchangelog/git-changelog-maven-plugin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/se.bjurr.gitchangelog/git-changelog-maven-plugin)
 
 This is a Maven plugin for [Git Changelog Lib](https://github.com/tomasbjerre/git-changelog-lib).
 
-## Usage ##
+## Usage
+
 There is a running example [here](https://github.com/tomasbjerre/git-changelog-maven-plugin/tree/master/git-changelog-maven-plugin-example).
 
 Have a look at the [pom.xml](https://github.com/tomasbjerre/git-changelog-maven-plugin/blob/master/git-changelog-maven-plugin-example/pom.xml) where you will find some more examples.
@@ -28,9 +30,20 @@ Here is and example that will generate a CHANGELOG.md when running `mvn generate
         <configuration>
          <templateContent>
          <![CDATA[
-# Changelog
-Changelog of My Project.
+          Template here!
+         ]]>
+         </templateContent>
+        </configuration>
+       </execution>
+      </executions>
+     </plugin>
+    </plugins>
+  </build>
+```
+
+### Template - Simple
 
+```hbs
 {{#tags}}
 ## {{name}}
  {{#issues}}
@@ -50,7 +63,7 @@ Changelog of My Project.
 **{{{messageTitle}}}**
 
 {{#messageBodyItems}}
- * {{.}} 
+ * {{.}}
 {{/messageBodyItems}}
 
 [{{hash}}](https://github.com/{{ownerName}}/{{repoName}}/commit/{{hash}}) {{authorName}} *{{commitTime}}*
@@ -59,8 +72,99 @@ Changelog of My Project.
 
  {{/issues}}
 {{/tags}}
-         ]]>
-         </templateContent>
+```
+
+### Template - Semantic versioning from conventional commits
+
+If you are using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/):
+
+```shell
+<type>[optional scope]: <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+A changelog can be rendered (using [Helpers](https://github.com/tomasbjerre/git-changelog-lib#Helpers)) like this:
+
+```hbs
+# Changelog
+
+{{#tags}}
+{{#ifReleaseTag .}}
+## [{{name}}](https://gitservice/{{name}}) ({{tagDate .}})
+
+  {{#ifContainsType commits type='feat'}}
+### Features
+
+    {{#commits}}
+      {{#ifCommitType . type='feat'}}
+ - {{#eachCommitScope .}} **{{.}}** {{/eachCommitScope}} {{{commitDescription .}}} ([{{hash}}](https://gitservice/commit/{{hashFull}}))
+      {{/ifCommitType}}
+    {{/commits}}
+  {{/ifContainsType}}
+
+  {{#ifContainsType commits type='fix'}}
+### Bug Fixes
+
+    {{#commits}}
+      {{#ifCommitType . type='fix'}}
+ - {{#eachCommitScope .}} **{{.}}** {{/eachCommitScope}} {{{commitDescription .}}} ([{{hash}}](https://gitservice/commit/{{hashFull}}))
+      {{/ifCommitType}}
+    {{/commits}}
+  {{/ifContainsType}}
+
+{{/ifReleaseTag}}
+{{/tags}}
+```
+
+### Example - custom helpers
+
+You can add your own helpers and use them in the template. There are also [built in Helpers](https://github.com/tomasbjerre/git-changelog-lib#Helpers).
+
+```xml
+  <build>
+    <plugins>
+     <plugin>
+      <groupId>se.bjurr.gitchangelog</groupId>
+      <artifactId>git-changelog-maven-plugin</artifactId>
+      <version>${changelog}</version>
+      <executions>
+       <execution>
+        <id>GenerateGitChangelog</id>
+        <phase>generate-sources</phase>
+        <goals>
+         <goal>git-changelog</goal>
+        </goals>
+        <configuration>
+          <javascriptHelper>
+<![CDATA[
+Handlebars.registerHelper('startsWith', function(messageTitle, options) {
+  const s = options.hash['s']
+  if (new RegExp('^' + s + '.*').test(messageTitle)) {
+    return options.fn(this);
+  } else {
+    return options.inverse(this);
+  }
+});
+
+Handlebars.registerHelper('firstLetters', function(from, options) {
+  const num = parseInt(options.hash['number'])
+  return from.substring(0,num)
+});
+]]>
+          </javascriptHelper>
+          <templateContent>
+<![CDATA[
+{{#commits}}
+  {{#startsWith messageTitle s='Removing'}}
+    Starts with Removing: "{{messageTitle}}"
+    first 10 letters of hash is: {{firstLetters hash number='10'}}
+  {{/startsWith}}
+{{/commits}}
+]]>
+          </templateContent>
         </configuration>
        </execution>
       </executions>