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

helpURL in config file is ignored #234

Closed
nedbat opened this issue Sep 15, 2021 · 1 comment · Fixed by #259
Closed

helpURL in config file is ignored #234

nedbat opened this issue Sep 15, 2021 · 1 comment · Fixed by #259

Comments

@nedbat
Copy link

nedbat commented Sep 15, 2021

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?

@wagoid
Copy link
Owner

wagoid commented Oct 11, 2021

Hi @nedbat! Sorry for the delay answering this issue. I agree, helpUrl from config file should take precedence over the action input. Will fix it 🐛

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

Successfully merging a pull request may close this issue.

2 participants