Ability to check commit semantic conformity

leseb commented 4 years ago

Before anyone asks, yes I'm aware of the existence of https://github.com/zeke/semantic-pull-requests, so perhaps I can start by explaining why it does not fully work for me:

it uses https://www.npmjs.com/package/parse-commit-message which is less feature-rich than https://github.com/conventional-changelog/commitlint
very few contributions over time, it almost seems the project is stale at this point
many obvious bugs making it un-usable like these 2: https://github.com/zeke/semantic-pull-requests/issues/82 and https://github.com/zeke/semantic-pull-requests/issues/88

Just to be clear it's not a complaint against semantic-pull-requests, these are just facts :-).

With that said, I wish Mergify could rely on https://github.com/conventional-changelog/commitlint to parse each commit of a given PR and output any anomaly as part of the PR check status. To go further, Mergify could attempt to read and pass any commitlint configuration it finds in .github (see for reference https://github.com/conventional-changelog/commitlint#config).

So it would be nice to a new action that does:

  - name: automatically lint commits
    conditions:
      - base=master
      - label!=work-in-progress
    actions:
      lint_commits: {}
        config: .github/.commitlintrc.yml # optional

Hopefully, that makes sense! Feel free to disregard if this is too out of scope :) Bisous.

jd commented 4 years ago

I'm not sure we want to implement linting inside the engine itself, but having the ability to craft your own lint with the configuration would be neat.

IIUC, you would need to:

Check that every commit in a PR matches a certain regex
Check the PR title matches a certain regex
Post the result to the PR

AFAICT:

Point 1. is not possible yet, and would require some adding to the condition language Point 2. is already possible. Point 3. could be an action provided by Mergify with your own status check.

Last point: what's preventing you to running commitlint via a GitHub Action?

leseb commented 4 years ago

I'm not sure we want to implement linting inside the engine itself, but having the ability to craft your own lint with the configuration would be neat.

IIUC, you would need to:

Check that every commit in a PR matches a certain regex

Check the PR title matches a certain regex

Post the result to the PR

AFAICT:

Point 1. is not possible yet, and would require some adding to the condition language Point 2. is already possible. Point 3. could be an action provided by Mergify with your own status check.

Last point: what's preventing you to running commitlint via a GitHub Action?

Actually, I've never thought about this, after some investigation it looks like https://github.com/wagoid/commitlint-github-action exactly does what I need.

Thanks!

Mergifyio / mergify

Ability to check commit semantic conformity #1123