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.

Installation

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

Configuration

package.json

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 <[email protected]>",
        {
          "name": "Jane Doe",
          "email": "[email protected]"
        }
      ]
    }
  }
}

You can also install and configure the adapter globally in ~/.czrc

{
  "path": "cz-conventional-changelog-coauthors",
  "defaultCoAuthors": [
    {
      "name": "Jane Doe",
      "email": "[email protected]"
    },
    {
      "name": "Joe Bloggs",
      "email": "[email protected]"
    }
  ]
}

Environment variable

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 <[email protected]>, Jane Doe <[email protected]>"

The automated release is failing 🚨

🚨 The automated release from the `main` branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the main branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two Factor Authentication for your account, set its level to "Authorization only" in your account settings. semantic-release cannot publish with the default "
Authorization and writes" level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

Good luck with your project ✨

Your semantic-release bot 📦🚀

p-m-p / cz-conventional-changelog-coauthors Goto Github PK