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.

{
  config: {
    commitizen: {
      path: './node_modules/cz-conventional-changelog-coauthors',
      defaultCoAuthors: [
        'Joe Bloggs <[email protected]>',
        {
          name: 'Jane Doe',
          email: '[email protected]',
        },
      ],
    },
  },
}

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.

export CZ_CO_AUTHORS = "Joe Bloggs <[email protected]>, Jane Doe <[email protected]>"