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
+16-12
Original file line number
Diff line number
Diff line change
@@ -99,33 +99,37 @@ You can configure `commit-and-tag-version` either by:
99
99
100
100
- If you are using a `.versionrc.js` your default export must be a configuration object, or a function returning a configuration object.
101
101
102
-
103
-
104
102
Any of the command line parameters accepted by `commit-and-tag-version` can instead
105
103
be provided via configuration. Please refer to the [conventional-changelog-config-spec](https://github.com/conventional-changelog/conventional-changelog-config-spec/) for details on available configuration options.
106
104
107
105
### Customizing CHANGELOG Generation
108
106
109
107
By default, `commit-and-tag-version` uses the [conventionalcommits preset](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-conventionalcommits).
110
108
111
-
This preset:
112
-
113
-
- Adheres closely to the [conventionalcommits.org](https://www.conventionalcommits.org)
114
-
specification.
115
-
- Is highly configurable, following the configuration specification
-_We've documented these config settings as a recommendation to other tooling makers._
118
-
119
-
There are a variety of dials and knobs you can turn related to CHANGELOG generation.
109
+
This preset adheres closely to the [conventionalcommits.org](https://www.conventionalcommits.org) specification.
120
110
121
-
As an example, suppose you're using GitLab, rather than GitHub, you might modify the following variables:
111
+
Suppose you're using GitLab, rather than GitHub, you might modify the following variables:
122
112
123
113
-`commitUrlFormat`: the URL format of commit SHAs detected in commit messages.
124
114
-`compareUrlFormat`: the URL format used to compare two tags.
125
115
-`issueUrlFormat`: the URL format used to link to issues.
126
116
127
117
Making these URLs match GitLab's format, rather than GitHub's.
128
118
119
+
### Deeper customization
120
+
121
+
You can override both [parser](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser) and [writer](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-writer) options (they will be merged into the preset we just mentioned). As an example, to list commits in the order that they were committed:
122
+
123
+
```json
124
+
{
125
+
"standard-version": {
126
+
"writerOpts": {
127
+
"commitsSort": false
128
+
}
129
+
}
130
+
}
131
+
```
132
+
129
133
## CLI Usage
130
134
131
135
> **NOTE:** To pass nested configurations to the CLI without defining them in the `package.json` use dot notation as the parameters `e.g. --skip.changelog`.
0 commit comments