docs(docs): update docs

Author: ococl

CHANGELOG.json

@@ -1,25 +1,48 @@
 # Changelog
 
-## 0.5.3 (2020-04-10)
+## 0.5.11 (2020-08-02)
+
+### Documentation
+
+- **docs**: update docs ([429a89a2](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/429a89a2dad1f9a9cd6c7b13baa8417fce19d261))
+
+
+### Styles
+
+- **editorconfig**: update .editorconfig, disable .mustache file indent ([bdb1a120](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/bdb1a120243429a17866e6c333a1ab54ca5d216c))
+
+
+### Chores
+
+- **deps**: bump `semantic-gitlog` to `0.5.11` ([fe397c82](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/fe397c820b10a691509600aa82b3f981d15aa49e))
+- **deps**: bump com.gradle.plugin-publish from 0.11.0 to 0.12.0 ([423a1b53](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/423a1b539c7c0e05771fc5685ba97dac49f96bcc))
+- **deps**: bump io.freefair.lombok from 4.1.6 to 5.1.0 ([c1733857](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/c1733857d93e20622cf7aa73f99734685712aec8))
+- **deps**: bump team.yi.semantic-gitlog from 0.5.0 to 0.5.3 ([2b523478](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/2b523478bf7674d834db4ac0b6f01895da5a28d5))
+- **deps**: bump junit-jupiter from 5.6.1 to 5.6.2 ([5839b561](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/5839b56129701571f8271afa121473c7660208bd))
+- **deps**: bump checkstyle from 8.30 to 8.35 ([b99c7f87](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/b99c7f871d302185524f3e1d5656fac4656b445e))
+- **deps**: bump pmd from 6.22.0 to 6.26.0 ([3cd2939f](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/3cd2939fb61046db4a0eb2cabfe5c03dffbdd3ea))
+
+
+## 0.5.3 (2020-04-16)
 
 ### Bug Fixes
 
-- **task/changelog**: fix configuration issues for `fileSets` under gradle-kotlin ([72b2c562](https://github.com/ymind/gradle-semantic-gitlog/commit/72b2c562333063db772bc4ac30b20519153f056d))
+- **task/changelog**: fix configuration issues for `fileSets` under gradle-kotlin ([72b2c562](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/72b2c562333063db772bc4ac30b20519153f056d))
 
 
 ### Code Refactoring
 
-- **model**: remove lombok annotations from `FileSet` ([2b381fe2](https://github.com/ymind/gradle-semantic-gitlog/commit/2b381fe2ad07532c06e239c2ab0cda613b736e0b))
+- **model**: remove lombok annotations from `FileSet` ([2b381fe2](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/2b381fe2ad07532c06e239c2ab0cda613b736e0b))
 
 
 ### Chores
 
-- **deps**: bumped `team.yi.semantic-gitlog` version to `0.5.0` ([59fadf61](https://github.com/ymind/gradle-semantic-gitlog/commit/59fadf616d1d86abbf1da954819438dd2b7ed7f7))
+- **deps**: bumped `team.yi.semantic-gitlog` version to `0.5.0` ([59fadf61](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/59fadf616d1d86abbf1da954819438dd2b7ed7f7))
 
 
 ## 0.5.0 (2020-03-28)
 
 ### Features
 
-- **task/changelog**: implement primary features and challenges ([d950193d](https://github.com/ymind/gradle-semantic-gitlog/commit/d950193d1249573fe78cb42182eb15699b96d72c))
+- **task/changelog**: implement primary features and challenges ([d950193d](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/d950193d1249573fe78cb42182eb15699b96d72c))
 

CHANGELOG.md

@@ -1,25 +1,48 @@
 # 更新日志
 
-## 0.5.3 (2020-04-10)
+## 0.5.11 (2020-08-02)
+
+### Documentation
+
+- **文档**: 更新说明文档 ([429a89a2](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/429a89a2dad1f9a9cd6c7b13baa8417fce19d261))
+
+
+### Styles
+
+- ****: update .editorconfig, disable .mustache file indent ([bdb1a120](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/bdb1a120243429a17866e6c333a1ab54ca5d216c))
+
+
+### Chores
+
+- **依赖项**: 更新 `semantic-gitlog` 至 `0.5.11` ([fe397c82](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/fe397c820b10a691509600aa82b3f981d15aa49e))
+- **依赖项**: bump com.gradle.plugin-publish from 0.11.0 to 0.12.0 ([423a1b53](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/423a1b539c7c0e05771fc5685ba97dac49f96bcc))
+- **依赖项**: bump io.freefair.lombok from 4.1.6 to 5.1.0 ([c1733857](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/c1733857d93e20622cf7aa73f99734685712aec8))
+- **依赖项**: bump team.yi.semantic-gitlog from 0.5.0 to 0.5.3 ([2b523478](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/2b523478bf7674d834db4ac0b6f01895da5a28d5))
+- **依赖项**: bump junit-jupiter from 5.6.1 to 5.6.2 ([5839b561](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/5839b56129701571f8271afa121473c7660208bd))
+- **依赖项**: bump checkstyle from 8.30 to 8.35 ([b99c7f87](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/b99c7f871d302185524f3e1d5656fac4656b445e))
+- **依赖项**: bump pmd from 6.22.0 to 6.26.0 ([3cd2939f](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/3cd2939fb61046db4a0eb2cabfe5c03dffbdd3ea))
+
+
+## 0.5.3 (2020-04-16)
 
 ### Bug Fixes
 
-- **任务/日志生成**: 修复 gradle-kotlin 下的 `fileSets` 配置问题 ([72b2c562](https://github.com/ymind/gradle-semantic-gitlog/commit/72b2c562333063db772bc4ac30b20519153f056d))
+- **任务/日志生成**: 修复 gradle-kotlin 下的 `fileSets` 配置问题 ([72b2c562](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/72b2c562333063db772bc4ac30b20519153f056d))
 
 
 ### Code Refactoring
 
-- **模型**: 剔除 `FileSet` 的 lombok 注解 ([2b381fe2](https://github.com/ymind/gradle-semantic-gitlog/commit/2b381fe2ad07532c06e239c2ab0cda613b736e0b))
+- **模型**: 剔除 `FileSet` 的 lombok 注解 ([2b381fe2](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/2b381fe2ad07532c06e239c2ab0cda613b736e0b))
 
 
 ### Chores
 
-- **依赖项**: 更新 `team.yi.semantic-gitlog` 版本至 `0.5.0` ([59fadf61](https://github.com/ymind/gradle-semantic-gitlog/commit/59fadf616d1d86abbf1da954819438dd2b7ed7f7))
+- **依赖项**: 更新 `team.yi.semantic-gitlog` 版本至 `0.5.0` ([59fadf61](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/59fadf616d1d86abbf1da954819438dd2b7ed7f7))
 
 
 ## 0.5.0 (2020-03-28)
 
 ### Features
 
-- **任务/日志生成**: 实现主要功能 ([d950193d](https://github.com/ymind/gradle-semantic-gitlog/commit/d950193d1249573fe78cb42182eb15699b96d72c))
+- **任务/日志生成**: 实现主要功能 ([d950193d](https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/d950193d1249573fe78cb42182eb15699b96d72c))
 

CHANGELOG.zh-cn.md

@@ -1,4 +1,4 @@
-[![Build Status](https://github.com/semantic-gitlog/semantic-gitlog/workflows/gradle-semantic-gitlog/badge.svg?branch=master)](https://github.com/semantic-gitlog/gradle-semantic-gitlog/actions)
+[![Build Status](https://github.com/semantic-gitlog/gradle-semantic-gitlog/workflows/gradle-semantic-gitlog/badge.svg?branch=master)](https://github.com/semantic-gitlog/gradle-semantic-gitlog/actions)
 [![GitHub release (latest by date)](https://img.shields.io/github/v/release/semantic-gitlog/gradle-semantic-gitlog)](https://github.com/semantic-gitlog/gradle-semantic-gitlog/releases)
 [![Maven Central](https://img.shields.io/maven-central/v/team.yi.gradle.plugin/gradle-semantic-gitlog)](https://search.maven.org/artifact/team.yi.gradle.plugin/gradle-semantic-gitlog)
 [![Semantic Versioning 2.0.0](https://img.shields.io/badge/Semantic%20Versioning-2.0.0-brightgreen)](https://semver.org/)

README.md

@@ -188,8 +188,8 @@ signing {
     sign publishing.publications.mavenJava
 }
 
-// ./gradlew setVersion -P newVersion=2.1.3
-task setVersion {
+// ./gradlew setNewVersion -P newVersion=2.1.3
+task setNewVersion {
     println version
 
     if (project.hasProperty('newVersion')) {
@@ -202,9 +202,7 @@ task setVersion {
 }
 
 changelog {
-    toRef = "dev"
-    isUnstable = true
-    preRelease = 'SNAPSHOT'
+    toRef = "master"
 
     jsonFile = file("${rootDir}/CHANGELOG.json")
     fileSets = [
@@ -228,12 +226,12 @@ changelog {
     issueUrlTemplate = "https://github.com/semantic-gitlog/gradle-semantic-gitlog/issues/:issueId"
     commitUrlTemplate = "https://github.com/semantic-gitlog/gradle-semantic-gitlog/commit/:commitId"
     mentionUrlTemplate = "https://github.com/:username"
+
+    outputs.upToDateWhen { false }
 }
 
 derive {
-    toRef = "dev"
-    isUnstable = true
-    preRelease = 'SNAPSHOT'
+    toRef = "master"
     derivedVersionMark = "NEXT_VERSION:=="
 
     commitLocales = [
@@ -244,4 +242,6 @@ derive {
         "en"   : file("${rootDir}/config/gitlog/commit-scopes.md"),
         "zh-cn": file("${rootDir}/config/gitlog/commit-scopes.zh-cn.md")
     ]
+
+    outputs.upToDateWhen { false }
 }

build.gradle

@@ -1,7 +1,7 @@
 # Changelog
 {{#tags}}
 
-{{#version}}## {{version}} ({{#releaseDate}}{{#formatDate}}{{releaseDate}}|yyyy-MM-dd{{/formatDate}}{{/releaseDate}}{{^releaseDate}}{{#formatDate}}{{now}}|yyyy-MM-dd{{/formatDate}}{{/releaseDate}}){{/version}}{{^version}}## {{nextVersion}} (Unreleased, {{#releaseDate}}{{#formatDate}}{{releaseDate}}|yyyy-MM-dd{{/formatDate}}{{/releaseDate}}{{^releaseDate}}{{#formatDate}}{{now}}|yyyy-MM-dd{{/formatDate}}{{/releaseDate}}){{/version}}
+{{#version}}## {{version}} ({{#releaseDate}}{{#formatDate}}{{releaseDate}}|yyyy-MM-dd{{/formatDate}}{{/releaseDate}}{{^releaseDate}}{{#formatDate}}{{now}}|yyyy-MM-dd{{/formatDate}}{{/releaseDate}}){{/version}}{{^version}}## {{nextVersion}} ({{#releaseDate}}{{#formatDate}}{{releaseDate}}|yyyy-MM-dd{{/formatDate}}{{/releaseDate}}{{^releaseDate}}{{#formatDate}}{{now}}|yyyy-MM-dd{{/formatDate}}{{/releaseDate}}){{/version}}
 {{#sections}}
 
 ### {{title}}

config/gitlog/CHANGELOG.md.mustache

@@ -1,7 +1,7 @@
 # 更新日志
 {{#tags}}
 
-{{#version}}## {{version}} ({{#releaseDate}}{{#formatDate}}{{releaseDate}}|yyyy-MM-dd{{/formatDate}}{{/releaseDate}}{{^releaseDate}}{{#formatDate}}{{now}}|yyyy-MM-dd{{/formatDate}}{{/releaseDate}}){{/version}}{{^version}}## {{nextVersion}} (Unreleased, {{#releaseDate}}{{#formatDate}}{{releaseDate}}|yyyy-MM-dd{{/formatDate}}{{/releaseDate}}{{^releaseDate}}{{#formatDate}}{{now}}|yyyy-MM-dd{{/formatDate}}{{/releaseDate}}){{/version}}
+{{#version}}## {{version}} ({{#releaseDate}}{{#formatDate}}{{releaseDate}}|yyyy-MM-dd{{/formatDate}}{{/releaseDate}}{{^releaseDate}}{{#formatDate}}{{now}}|yyyy-MM-dd{{/formatDate}}{{/releaseDate}}){{/version}}{{^version}}## {{nextVersion}} ({{#releaseDate}}{{#formatDate}}{{releaseDate}}|yyyy-MM-dd{{/formatDate}}{{/releaseDate}}{{^releaseDate}}{{#formatDate}}{{now}}|yyyy-MM-dd{{/formatDate}}{{/releaseDate}}){{/version}}
 {{#sections}}
 
 ### {{title}}