Document use of commitlint as a github action (possible own CLI in the future)

[KnisterPeter]

Expected Behavior

Provide a github actions cli just like commitlint-travis.

Context

It should easy setup for running commitlint as part of a github actions setup.

[marionebl]

Yes, a Github action would be cool. Want to lend a hand with this?

[bennypowers]

I made this but have no idea if it works, since i'm not in the beta

https://github.com/bennypowers/commitlint-gh-actions

[KnisterPeter]

Nice, I can give it a try.

[bennypowers]

Added you to the repo. Do your worst 💃

[byCedric]

I'm accepted in the beta, so whatever happens, I can try it out too 😄 Also building some actions for Expo, but ran into some issues and trying to fix it with the GH team.

I think we also need to discuss where this will be hosted. We can do something like conventional-changelog/commitlint-action, I would be happy to submit it (officially) to the marketplace too! What do you guys think @marionebl @escapedcat?

[byCedric]

As a small side note, I would definitely recommend using the full LTS node version (node:10).

• Although it should only be used for commitlint, there were some implications with the official npm action. I did some benchmarking, it turned out that using the full version has no impact at all to the performance.
• There were also some strange issues with Jest/CRA and the latest Node 11 version, so the way I see it LTS versions are far more stable.

With these two minor, but good changes, the action covers more edge cases. I believe that was the main purpose of actions, make it simple and easy to use for everyone.

Or do you have a different opinion about this @bennypowers?

[escapedcat]

Agreed, I think it would be nice to have actions for CI environments.

[byCedric]

I think we should solve #613 and zero config before doing this right? That way, we can simply create an action with everything set to default. If projects have their own conventions, they simply need to add a npm install action before the commitlint action. Personally, I think this is the best approach for the actions. Or am I overthinking this?

[bennypowers]

@byCedric I have no strong opinion regarding node versions. probably newer is better. I can add you to the repo also

[byCedric]

Thanks! I'm trying to help out the guys at global-dirs, they make awesome reports on the issues (worth reading 😉). If this is resolved, I'll get started on the zero-config and this!

[bennypowers]

Ok, I published this

https://github.com/marketplace/actions/commitlint-cli

Haven't tried it out just yet 🙈