You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -94,7 +94,7 @@ You can also set any option in `package.json` under the `auto-changelog` key, us
94
94
}
95
95
```
96
96
97
-
####Requirements
97
+
### Requirements
98
98
99
99
`auto-changelog` is designed to be as flexible as possible, providing a clear changelog for any project. There are only two absolute requirements:
100
100
@@ -106,7 +106,7 @@ There are some less strict requirements to improve your changelog:
106
106
-[Close issues using keywords](https://help.github.com/articles/closing-issues-using-keywords)
107
107
- Merge pull requests using the standard merge commit message for your platform
108
108
109
-
####What you might do if you’re clever
109
+
### What you might do if you’re clever
110
110
111
111
Install `auto-changelog` to dev dependencies:
112
112
@@ -135,15 +135,15 @@ Using `-p` or `--package` uses the `version` from `package.json` as the latest r
135
135
136
136
Now every time you run [`npm version`](https://docs.npmjs.com/cli/version), the changelog will automatically update and be part of the version commit.
137
137
138
-
####Breaking changes
138
+
### Breaking changes
139
139
140
140
If you use a common pattern in your commit messages for breaking changes, use `--breaking-pattern` to highlight those commits as breaking changes in your changelog. Breaking change commits will always be listed as part of a release, regardless of any `--commit-limit` set.
If you aren’t happy with the default templates or want to tweak something, you can point to a [handlebars](http://handlebarsjs.com) template in your local repo. Check out the [existing templates](templates) to see what is possible.
149
149
@@ -180,7 +180,7 @@ To see exactly what data is passed in to the templates, you can generate a JSON
Use `{{#commit-list}}` to render a list of commits depending on certain patterns in the commit messages:
186
186
@@ -207,7 +207,7 @@ Use `{{#commit-list}}` to render a list of commits depending on certain patterns
207
207
|`subject`| A regex pattern to match against the commit subject only |
208
208
|`exclude`| A regex pattern to exclude from the list – useful for avoiding listing commits more than once |
209
209
210
-
####Custom issue patterns
210
+
### Custom issue patterns
211
211
212
212
By default, `auto-changelog` will parse [GitHub-style issue fixes](https://help.github.com/articles/closing-issues-using-keywords/) in your commit messages. If you use Jira or an alternative pattern in your commits to reference issues, you can pass in a custom regular expression to `--issue-pattern` along with `--issue-url`:
213
213
@@ -235,7 +235,7 @@ If you use a certain pattern before or after the issue number, like `fixes {id}`
0 commit comments