diff --git a/README.md b/README.md index e8d2ba035e1295231ffdc55afb7b4ad17bb06253..67a4dc5b440e1e5956452ae5cf564001bc0931ad 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,10 @@ The changelog generator will order the types of commits in the changelog in the - Build - CI +## Prettified changelogs + +In order to use prettified changelogs including a prefixed emoji, you need to provide the following config when calling semantic-relase: `--changelog-generator-opt "prettified_output=true"`. Or add the config within your `.semrelrc` file. + [Example Change Log](./examples/GENERATED_CHANGELOG.md) ## Licence diff --git a/examples/GENERATED_CHANGELOG copy.md b/examples/GENERATED_CHANGELOG copy.md new file mode 100644 index 0000000000000000000000000000000000000000..bef009bf0403ca7a6cd5c63ca3b12c15908e872d --- /dev/null +++ b/examples/GENERATED_CHANGELOG copy.md @@ -0,0 +1,33 @@ +## 2.0.0 (2020-11-11) + +#### Breaking Changes + +* commit message (12345678) +``` +BREAKING CHANGE: test +``` +* **user:** another commit message (12345679) +``` +changed ID int into UUID +``` + +#### Feature + +* **app:** commit message (12345678) + +#### Bug Fixes + +* commit message (abcd) + +#### Build + +* commit message (43218765) + +#### CI + +* commit message (87654321) + +#### yolo + +* **swag:** commit message (12345678) + diff --git a/examples/GENERATED_CHANGELOG.md b/examples/GENERATED_CHANGELOG.md index bef009bf0403ca7a6cd5c63ca3b12c15908e872d..ee5598bcbaeb3b1cdcea78a6182b59f17271d0fe 100644 --- a/examples/GENERATED_CHANGELOG.md +++ b/examples/GENERATED_CHANGELOG.md @@ -1,3 +1,32 @@ +## 2.0.1 (2020-12-08) + +#### 📣 Breaking Changes + +* commit message (12345678) +``` +BREAKING CHANGE: test +``` +* **user:** another commit message (12345679) +``` +changed ID int into UUID +``` + +#### 🎁 Feature + +* **app:** commit message (12345678) + +#### 🐞 Bug Fixes + +* commit message (abcd) + +#### 📦 Build + +* commit message (43218765) + +#### 🔁 CI + +* commit message (87654321) + ## 2.0.0 (2020-11-11) #### Breaking Changes