tophat / commit-watch Goto Github PK

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

Currently all config options are specified using environment variables.

Describe the solution you'd like

Support a commit-watch.config.js file and/or cli args to specify all options.

Describe alternatives you've considered

A ".json" file could work too, but can't be dynamically updated for "CI". Not worth supporting 4 different config methods.

Additional context

Env variables are messy, hard to set, and leak all over the place.

We import and use commitlint-format here:

Note: This isn't a license change. This repo has always been under Apache as you can see by the full LICENSE file. This just fixes the license code in the package.json.

Describe the bug

On commit watch failure, the status check is updated to say "Multiple commit lint errors, run "make lint-commit-messages" locally". This make command assumes you have such a command in your repo. It's not offered by commit watch at all.

To reproduce

Open a PR against a repo that runs commit watch and trigger a failure (bad commit).

Expected behavior

Either bake in the lint command and update the message, or remove the message and perhaps link to some documentation.

At

We can either remove coveralls, or configure code coverage. Same with jest-juint

In some cases, CW will inexplicable pick up on commit messages from commits that are already merged in master. Since the commit message format isn't enforced beyond branch pushes, this breaks the formatting function as one would expect.

This problem is intermittent and couldn't be reliably reproduced, but it happens every once and again. This hints at a yet-unexplored gap in how CW builds the list of messages it'll lint.