[@auto-it/all-contributors] doesn't commit using conventional commits

[snebjorn]

Is your feature request related to a problem? Please describe.

The commit message from @auto-it/all-contributors doesn't adhere to conventional commits. The commit message is hard-coded.

auto/plugins/all-contributors/src/index.ts

Line 371 in 1a84048

'"Update contributors [skip ci]"',

Describe the solution you'd like

I'd like it to use a conventional commit message. This could be configurable via a flag.

{
  plugins: [
    [
      'all-contributors',
      {
        commitUsingConventionalCommits: true,
      },
    ],
}

Describe alternatives you've considered

Alternatively it could be a configurable custom message.

{
  plugins: [
    [
      'all-contributors',
      {
        commitMessage: 'chore(release): update contributors [skip ci]',
      },
    ],
}

Additional context

none

[hipstersmoothie]

Sound like a good feature to me. Would you like to submit a PR?

[snebjorn]

Sorry, I don't think I'll have time ATM. Otherwise I wouldn't mind giving it a look.

[XDRAGON2002]

@snebjorn @hipstersmoothie was there any update on this? If not, I'd take this up.

[snebjorn]

@XDRAGON2002 no progress, go ahead 🚀

[XDRAGON2002]

Hi @snebjorn @hipstersmoothie!

I was working on this issue, and apparently after adding the new option, auto is not able to verify/detect this new field:

I can't seem to figure out where I'm going wrong? I've also checked out some other prior PRs doing something similar, and still can't seem to figure out what the cause for this could be.

These are the changes I've made:

const pluginOptions = t.partial({
  /** Usernames to exclude from the contributors */
  exclude: t.array(t.string),
  /** Globs to detect change types by */
  types: t.partial(
    fromEntries(contributionTypes.map((c) => [c, pattern])) as Record<
      Contribution,
      typeof pattern
    >
  ),
  /** Define custom commit message defaults to "Update contributors [skip ci]" */
  commitMessage: t.string,
});

const defaultOptions: IAllContributorsPluginOptions = {
  exclude: botList,
  types: {
    doc: ["**/*.mdx", "**/*.md", "**/docs/**/*", "**/documentation/**/*"],
    example: ["**/*.stories*", "**/*.story.*"],
    infra: ["**/.circle/**/*", "**/.github/**/*", "**/travis.yml"],
    test: ["**/*.test.*", "**/test/**", "**/__tests__/**"],
    code: ["**/src/**/*", "**/lib/**/*", "**/package.json", "**/tsconfig.json"],
  },
  commitMessage: "Update contributors [skip ci]",
};

this.options = {
      exclude: [...(defaultOptions.exclude || []), ...(options.exclude || [])],
      types: { ...defaultOptions.types, ...options.types },
      commitMessage: options.commitMessage || defaultOptions.commitMessage || "",
    };

Any pointers? Thanks!