cz-conventional-changelog-coauthors

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.

Configuration

package.json

Like commitizen, you specify the configuration of cz-conventional-changelog through the package.json's config.commitizen key. In addition to that configuration you can provide a default list of co-authors as raw strings or as objects with name and email fields.

1{
2  config: {
3    commitizen: {
4      path: './node_modules/cz-conventional-changelog-coauthors',
5      defaultCoAuthors: [
6        'Joe Bloggs <joe.bloggs@github.user>',
7        {
8          name: 'Jane Doe',
9          email: 'jane.doe@github.user',
10        },
11      ],
12    },
13  },
14}

Environment variable

As with the environment variables for cz-conventional-changelog the default co-author list can be provideed in the CZ_CO_AUTHORS environment variable.

1export CZ_CO_AUTHORS = "Joe Bloggs <joe.bloggs@github.user>, Jane Doe <jane.doe@github.user>"