Skip to content

Commit

Permalink
docs(readme): mention breaking changes for templating
Browse files Browse the repository at this point in the history
  • Loading branch information
orhun committed Aug 20, 2021
1 parent e0f6ca1 commit 6fa5d28
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
- [Templating](#templating)
- [Context](#context)
- [Conventional Commits](#conventional-commits)
- [Breaking Changes](#breaking-changes)
- [Non-Conventional Commits](#non-conventional-commits)
- [Syntax](#syntax)
- [Examples](#examples-1)
Expand Down Expand Up @@ -387,6 +388,7 @@ following context is generated to use for templating:
"message": "<description>",
"body": "[body]",
"footers": ["[footer]", "[footer]"],
"breaking_description": "<description>",
"breaking": false
}
],
Expand All @@ -398,6 +400,24 @@ following context is generated to use for templating:
}
```

##### Breaking Changes

`breaking` flag is set to `true` when the commit has an exclamation mark after the commit type and scope, e.g.:

```
feat(scope)!: this is a breaking change
```

Or when the `BREAKING CHANGE:` footer is defined:

```
feat: add xyz
BREAKING CHANGE: this is a breaking change
```

`breaking_description` is set to the explanation of the breaking change. This description is expected to be present in the `BREAKING CHANGE` footer. However, if it's not provided, the `message` is expected to describe the breaking change.

#### Non-Conventional Commits

> conventional_commits = **false**
Expand Down

0 comments on commit 6fa5d28

Please sign in to comment.