You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
51 lines
2.1 KiB
51 lines
2.1 KiB
2 years ago
|
# [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url]
|
||
|
|
|
||
|
|
## conventionalcommits.org convention
|
||
|
|
|
||
|
|
A concrete implementation of the specification described at
|
||
|
|
[conventionalcommits.org](https://conventionalcommits.org/) for automated
|
||
|
|
CHANGELOG generation and version management.
|
||
|
|
|
||
|
|
|
||
|
|
## Indirect Usage (as preset)
|
||
|
|
|
||
|
|
Use the [Conventional Changelog CLI Quick Start](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli#quick-start) with the `-p conventionalcommits` option.
|
||
|
|
|
||
|
|
## Direct Usage (as a base preset so you can customize it)
|
||
|
|
|
||
|
|
If you want to use this package directly and pass options, you can use the [Conventional Changelog CLI Quick Start](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli#quick-start) and with the `--config` or `-n` parameter, pass a js config that looks like this
|
||
|
|
```
|
||
|
|
'use strict'
|
||
|
|
const config = require('conventional-changelog-conventionalcommits')
|
||
|
|
|
||
|
|
module.exports = config({
|
||
|
|
"issuePrefixes": ["TEST-"],
|
||
|
|
"issueUrlFormat": "https://myBugTracker.com/{{prefix}}{{id}}"
|
||
|
|
})
|
||
|
|
```
|
||
|
|
|
||
|
|
or json config like that:
|
||
|
|
```
|
||
|
|
{
|
||
|
|
"options": {
|
||
|
|
"preset": {
|
||
|
|
"name": "conventionalchangelog",
|
||
|
|
"issuePrefixes": ["TEST-"],
|
||
|
|
"issueUrlFormat": "https://myBugTracker.com/{{prefix}}{{id}}"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
This last json config way passes the `preset` object to the `conventional-changelog-preset-loader` package, that in turn, passes this same `preset` object as the config for the `conventional-changelog-conventionalcommits`.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
See [conventional-changelog-config-spec](https://github.com/conventional-changelog/conventional-changelog-config-spec) for available
|
||
|
|
configuration options.
|
||
|
|
|
||
|
|
|
||
|
|
[travis-image]: https://travis-ci.org/conventional-changelog/conventional-changelog.svg?branch=master
|
||
|
|
[travis-url]: https://travis-ci.org/conventional-changelog/conventional-changelog
|
||
|
|
[coveralls-image]: https://coveralls.io/repos/conventional-changelog/conventional-changelog/badge.svg
|
||
|
|
[coveralls-url]: https://coveralls.io/r/conventional-changelog/conventional-changelog
|