Skip to content
Snippets Groups Projects
Commit 399e0b45 authored by timoknapp's avatar timoknapp Committed by Christoph Witzko
Browse files

docs: add description withing README

parent ad1e4f19
Branches
Tags
No related merge requests found
......@@ -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
......
## 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)
## 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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment