Skip to content

Commit 399e0b4

Browse files
timoknappchristophwitzko
authored andcommitted
docs: add description withing README
1 parent ad1e4f1 commit 399e0b4

File tree

3 files changed

+66
-0
lines changed

3 files changed

+66
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ The changelog generator will order the types of commits in the changelog in the
2121
- Build
2222
- CI
2323

24+
## Prettified changelogs
25+
26+
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.
27+
2428
[Example Change Log](./examples/GENERATED_CHANGELOG.md)
2529

2630
## Licence
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## 2.0.0 (2020-11-11)
2+
3+
#### Breaking Changes
4+
5+
* commit message (12345678)
6+
```
7+
BREAKING CHANGE: test
8+
```
9+
* **user:** another commit message (12345679)
10+
```
11+
changed ID int into UUID
12+
```
13+
14+
#### Feature
15+
16+
* **app:** commit message (12345678)
17+
18+
#### Bug Fixes
19+
20+
* commit message (abcd)
21+
22+
#### Build
23+
24+
* commit message (43218765)
25+
26+
#### CI
27+
28+
* commit message (87654321)
29+
30+
#### yolo
31+
32+
* **swag:** commit message (12345678)
33+

examples/GENERATED_CHANGELOG.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,32 @@
1+
## 2.0.1 (2020-12-08)
2+
3+
#### 📣 Breaking Changes
4+
5+
* commit message (12345678)
6+
```
7+
BREAKING CHANGE: test
8+
```
9+
* **user:** another commit message (12345679)
10+
```
11+
changed ID int into UUID
12+
```
13+
14+
#### 🎁 Feature
15+
16+
* **app:** commit message (12345678)
17+
18+
#### 🐞 Bug Fixes
19+
20+
* commit message (abcd)
21+
22+
#### 📦 Build
23+
24+
* commit message (43218765)
25+
26+
#### 🔁 CI
27+
28+
* commit message (87654321)
29+
130
## 2.0.0 (2020-11-11)
231

332
#### Breaking Changes

0 commit comments

Comments
 (0)