A simple wrapper around cz-conventional-changelog to provide an addition Co-authored-by
prompt for teams that use pair/mob programming and wish to attribute additional authors to a commit.
Make your repository commitizen friendly using the commitizen cli.
# npm
commitizen init cz-conventional-changelog-coauthors --save-dev --save-exact
# yarn
commitizen init cz-conventional-changelog-coauthors --yarn --dev --exact
# pnpm
commitizen init cz-conventional-changelog-coauthors --pnpm --save-dev --save-exact
See cz-conventional-changelog for a full list of configuration options. Co-authors can be provided in the defaultCoAuthors
option as list of raw strings or objects with name and email fields.
{
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog-coauthors",
"defaultCoAuthors": [
"Joe Bloggs <joe.bloggs@github.user>",
{
"name": "Jane Doe",
"email": "jane.doe@github.user"
}
]
}
}
}
You can also install and configure the adapter globally in ~/.czrc
{
"path": "cz-conventional-changelog-coauthors",
"defaultCoAuthors": [
{
"name": "Jane Doe",
"email": "jane.doe@github.user"
},
{
"name": "Joe Bloggs",
"email": "joe.bloggs@github.user"
}
]
}
As with the environment variables for cz-conventional-changelog the co-author list can be provideed in the CZ_CO_AUTHORS
environment variable. The environment variable overrides the defaultCoAuthors
configuration option and can be used to populate the author list dynamically.
export CZ_CO_AUTHORS = "Joe Bloggs <joe.bloggs@github.user>, Jane Doe <jane.doe@github.user>"