Skip to content

Conversation

@jimmo
Copy link
Member

@jimmo jimmo commented Oct 26, 2023

This adds verifygitlog.py from the main repo, adds it to GitHub workflows, and also pre-commit.

I spent a considerable amount of effort trying to make gitlint (https://jorisroovers.com/gitlint) work (for both the main repo and here) but it was not flexible enough to make it work with our rules. See https://github.com/jimmo/micropython/tree/gitlint-config

The three main limitations were:

  • I ended up having to write a non-trivial amount of Python code as custom rules.
  • It doesn't have a way to link to documentation or add suggestions like verifygitlog.py does.
  • I couldn't find a way to make WIP and !fix commits work in pre-commit but not in CI.

So in the end it's just easier to keep using verifygitlog.py (even if it means duplicating it here).

This work was funded through GitHub Sponsors.

This adds verifygitlog.py from the main repo, adds it to GitHub workflows,
and also pre-commit.

This work was funded through GitHub Sponsors.

Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
@dpgeorge dpgeorge merged commit ad0a259 into micropython:master Dec 20, 2023
@dpgeorge
Copy link
Member

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants