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

Question: Support for a custom type? #44

Open
hendrickson-tyler opened this issue Dec 9, 2023 · 1 comment
Open

Question: Support for a custom type? #44

hendrickson-tyler opened this issue Dec 9, 2023 · 1 comment

Comments

@hendrickson-tyler
Copy link

First of all, I'm immensely grateful for this plugin's existence. Thank you for contributing this!

I was curious if the plugin supports additional types that aren't explicitly mentioned in the conventional commits specification. For example, in addition to the usual feat: and fix: types, I'm interested in using an update: type in my project. Reason being, I want to specifically mention items that have outwardly changed, but don't necessarily constitute a new feature.

I've been playing around with the options, but can't ever get my update: commits to be picked up in the release notes—even when using a custom commit_format regex. This is what my actions look like:

...
analyze_commits(
  commit_format: /^(fix|feat|update)(?:\((.*)\))?(!?)\: (.*)/,
  match: 'v[0-9]*.[0-9]*.[0-9]',
  show_version_path: false,
)
notes = conventional_changelog(
  format: 'plain',
  display_title: false,
  display_links: false,
  sections: {
    feat: 'New Features',
    fix: 'Bug Fixes',
    update: 'Other Updates',
    no_type: 'Changes To Remove'
  },
  ignore_scopes: [
    'android',
    'web',
    'back-end',
    'backend',
    'data',
    'core',
    'deps',
    'deps-dev',
])
...

I've verified that my commit message matches the regex I provided, so I wanted to check to see if this is not supported at the moment?

@swilliams-intellum
Copy link

The sections parameter is for defining the wording. You can use the order parameter to define which sections are displayed in which order.

section: ['feat', 'fix', 'update']

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

2 participants