Previously we were using theconfig-conventional rule set (rules only) to lint within our action, excluding additional settings like parserPreset. Simply extending the config how you would in a local commitlint.config.js does not seem possible as the parserPreset and possibly some other config requires resolution before it is usable, which does not work inside a Github action out of the box.
For this reason, the parserPreset used in config-conventional settings was excluded, but this caused certain commit messages to fail even if they met the conventional commit spec, ex : commit message feat!: exclamation indicates breaking change was failing.
This change grabs the same parserOpts provided by the parserPreset included with the config-conventional package. Doing it this way is a little inelegant, so if a cleaner way to include the parserOpts is possible, we should investigate.
Please complete these steps before requesting code review:
[x] This PR provides a description, testing steps, and adequate context for reviewers
[x] Unit tests added/updated to provide coverage for functional code changes in this PR
12
Previously we were using the
config-conventionalrule set (rules only) to lint within our action, excluding additional settings likeparserPreset. Simply extending the config how you would in a localcommitlint.config.jsdoes not seem possible as theparserPresetand possibly some other config requires resolution before it is usable, which does not work inside a Github action out of the box.For this reason, the
parserPresetused inconfig-conventionalsettings was excluded, but this caused certain commit messages to fail even if they met the conventional commit spec, ex : commit messagefeat!: exclamation indicates breaking changewas failing.This change grabs the same
parserOptsprovided by theparserPresetincluded with theconfig-conventionalpackage. Doing it this way is a little inelegant, so if a cleaner way to include theparserOptsis possible, we should investigate.Please complete these steps before requesting code review: