Skip to content

helpURL in config file is ignored #234

@nedbat

Description

@nedbat

I have a commitlint.config.js file with this in it:

module.exports = {
  extends: ['@commitlint/config-conventional'],

  helpUrl:
    'https://open-edx-proposals.readthedocs.io/en/latest/oep-0051-bp-conventional-commits.html',

  rules: {
    'body-leading-blank': [0, "always"],

    'subject-case': [0, "always", []],

    'subject-full-stop': [0, "never", '.'],

    'type-enum':
      [2, 'always', ['revert', 'feat', 'fix', 'perf', 'docs', 'test', 'build', 'refactor', 'style', 'chore', 'temp']],
  },
};

When I run the GitHub action, it shows the default help URL:

ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

If I set the helpURL input in the action, my URL is displayed. But shouldn't the setting in my config file override the built-in default in the action?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions