There are multiple tools that work with commit message formats to generate changelogs and releases, provide help by writing good commit messages, lint your messages and many more (to come).
Although conceptual similar all these tools need to be configured individually which adds an unnecessary overhead to tooling setup.
.changelogrc
file..changelogrc
file MUST be formatted as JSON..changelogrc
file..changelogrc
file closest to the current working directory
MUST be used for configuration..changelogrc
files MUST NOT be merged with .changelogrc
files in parent directories unless specified by the .changelogrc
itself (see 5.i.)..changelogrc
file CAN provide an array of change "types".example .changelogrc
with types:
{
"types": [
{
"key": "feat",
"name": "Features"
},
{
"key": "test",
"name": "Tests",
"hide": true
}
]
}
.changelogrc
file CAN provide an array of change "notes".example .changelogrc
with note:
{
"notes": [
{
"keyword": "BREAKING CHANGES",
"alias": [
"BREAKING CHANGE"
],
"important": true
}
]
}
.changelogrc
file CAN provide an "extend" property specifying
a path to another .changelogrc
file in with the configuration is
deeply merged.The MIT License
Copyright (C) 2016 Jimdo GmbH
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.