Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for config.commitizen settings and custom configuration file support #222

Open
wojtekKrol opened this issue Jul 13, 2024 · 0 comments

Comments

@wojtekKrol
Copy link

Hi,

I am having difficulty finding documentation for the settings available under config.commitizen for cz-conventional-changelog.

The official documentation states:

"Like Commitizen, you specify the configuration of cz-conventional-changelog through the package.json's config.commitizen key."

However, I have not been able to find comprehensive documentation for the available settings.

Additionally, I attempted to use a custom configuration file by setting up the following in my package.json:

"config": {
  "commitizen": {
    "path": "./node_modules/cz-conventional-changelog",
    "config": "./.cz-config.mjs"
  }
}

In .cz-config.mjs, I have custom settings, but it does not seem to work as expected. Here is a sample of my .cz-config.mjs:

export default {
  types: [
    { value: 'feat', name: 'feat:     A new feature' },
    { value: 'fix', name: 'fix:      A bug fix' },
    { value: 'docs', name: 'docs:     Documentation only changes' },
    // other types
  ],
  scopes: [
    { name: 'module1' },
    { name: 'module2' },
    { name: 'module3' }
  ],
  // other settings
};

Can you please provide detailed documentation for the available settings under config.commitizen and clarify if custom configuration files like .cz-config.mjs are supported?

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant